Skip to content

Commit da18942

Browse files
committed
docs: remove philosophy headers and finalize documentation
1 parent 11d7991 commit da18942

71 files changed

Lines changed: 31 additions & 272 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
77
**[Read the Official Documentation](https://concode0.github.io/Versor/)**
88

9-
![Manifold Unbending Demo](/demo_manifold_comp.gif)
9+
![Manifold Unbending Demo](assets/demo_manifold_comp.gif)
1010

1111
## At a Glance
1212

@@ -113,7 +113,7 @@ uv run main.py task=sr algebra.p=4 training.lr=0.001
113113

114114
### Interactive Demo (Streamlit)
115115

116-
![DEMO](demo_manifold_comp.gif)
116+
![DEMO](assets/demo_manifold_comp.gif)
117117

118118
```bash
119119
streamlit run examples/demo.py
@@ -152,6 +152,9 @@ Multi-task energy + force prediction with conservative constraint ($F = -\nabla
152152

153153
All runs: rMD17 · 1000 train / 1000 val / 98 000 test · RTX Pro 4500.
154154

155+
![ERROR_DISTRIBUTION](assets/md17_prediction_benzene.png)
156+
157+
155158
**Error distribution:** Across all three molecules, the prediction error distributions peak sharply at 0 and follow a Gaussian-like shape. This indicates the model is not making systematic biases — it finds the geometrically correct answer and the residual error is purely stochastic noise, consistent with a model that has learned the true underlying potential energy surface geometry.
156159

157160
```bash
@@ -287,6 +290,16 @@ For a deep dive into the framework, please visit our official documentation site
287290
* **Innovations**: 10 code-illustrated features that make Versor unique.
288291
* **API Reference**: Full documentation of `core`, `layers`, and `functional` modules.
289292

293+
## Contributing
294+
295+
Versor is currently in a **Stabilization Phase** as the lead maintainer focuses on academic milestones. While we are not actively seeking major feature contributions at this moment, we highly value community feedback.
296+
297+
- **Found a Bug?** Please open an [Issue](https://github.com/Concode0/Versor/issues) with a detailed reproduction case.
298+
- **Have an Idea?** Open an Issue to discuss it before submitting a Pull Request.
299+
- **Code of Conduct:** All participants are expected to adhere to our [Code of Conduct](./CODE_OF_CONDUCT.md).
300+
301+
We believe in the power of the community to "unbend" the future of AI together.
302+
290303
## License & Intellectual Property
291304

292305
This project is licensed under the **Apache License 2.0**.

core/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Versor: Universal Geometric Algebra Neural Network (C) 2026 Eunkyum Kim
2-
# Licensed under the Apache License, Version 2.0 | "Unbending" Paradigm
2+
# Licensed under the Apache License, Version 2.0
33

44
"""Core mathematical kernel for Geometric Algebra.
55

core/algebra.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
# Licensed under the Apache License, Version 2.0 (the "License");
55
# you may not use this file except in compliance with the License.
66
#
7-
# This project is fully open-source, including for commercial use.
8-
# We believe Geometric Algebra is the future of AI, and we want
9-
# the industry to build upon this "unbending" paradigm.
107

118
"""Differentiable Clifford Algebra core.
129

core/cga.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
# Licensed under the Apache License, Version 2.0 (the "License");
55
# you may not use this file except in compliance with the License.
66
#
7-
# This project is fully open-source, including for commercial use.
8-
# We believe Geometric Algebra is the future of AI, and we want
9-
# the industry to build upon this "unbending" paradigm.
107

118
"""Conformal Geometric Algebra (CGA) utilities.
129

core/decomposition.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
# Licensed under the Apache License, Version 2.0 (the "License");
55
# you may not use this file except in compliance with the License.
66
#
7-
# This project is fully open-source, including for commercial use.
8-
# We believe Geometric Algebra is the future of AI, and we want
9-
# the industry to build upon this "unbending" paradigm.
107

118
"""Bivector decomposition via GA power iteration.
129

core/device.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Versor: Universal Geometric Algebra Neural Network (C) 2026 Eunkyum Kim
2-
# Licensed under the Apache License, Version 2.0 | "Unbending" Paradigm
2+
# Licensed under the Apache License, Version 2.0
33

44
"""Device configuration and backend tuning for Versor.
55
@@ -71,9 +71,7 @@ def __post_init__(self) -> None:
7171
if self.amp and not is_cuda:
7272
self.amp = False
7373

74-
# ------------------------------------------------------------------
7574
# Public helpers
76-
# ------------------------------------------------------------------
7775

7876
def apply_backend_settings(self) -> None:
7977
"""Apply ``cudnn.benchmark`` (and future backend knobs)."""

core/metric.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
# Licensed under the Apache License, Version 2.0 (the "License");
55
# you may not use this file except in compliance with the License.
66
#
7-
# This project is fully open-source, including for commercial use.
8-
# We believe Geometric Algebra is the future of AI, and we want
9-
# the industry to build upon this "unbending" paradigm.
107

118
"""Metric definitions for Clifford algebras.
129

core/multivector.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
# Licensed under the Apache License, Version 2.0 (the "License");
55
# you may not use this file except in compliance with the License.
66
#
7-
# This project is fully open-source, including for commercial use.
8-
# We believe Geometric Algebra is the future of AI, and we want
9-
# the industry to build upon this "unbending" paradigm.
107

118
"""Object-oriented multivector wrapper with operator overloading."""
129

core/search.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
# Licensed under the Apache License, Version 2.0 (the "License");
55
# you may not use this file except in compliance with the License.
66
#
7-
# This project is fully open-source, including for commercial use.
8-
# We believe Geometric Algebra is the future of AI, and we want
9-
# the industry to build upon this "unbending" paradigm.
107

118
"""Automated metric search for optimal geometric signatures.
129

0 commit comments

Comments
 (0)