tardits 0.2.0__tar.gz

tardits-0.2.0/.gitignore

@@ -0,0 +1,19 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+.test_venv
+
+# saved
+examples/saved/*
+!examples/saved/.gitkeep
+
+# mlflow
+mlflow.db
+mlruns/

tardits-0.2.0/.python-version

@@ -0,0 +1 @@
+3.13

tardits-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tardits-0.2.0/PKG-INFO

@@ -0,0 +1,267 @@
+Metadata-Version: 2.4
+Name: tardits
+Version: 0.2.0
+Summary: Text And Rotating Dimensions In Token Space
+License-File: LICENSE
+Requires-Python: >=3.13
+Requires-Dist: numpy>=2.5.1
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: torch>=2.13.0
+Provides-Extra: mlflow
+Requires-Dist: matplotlib>=3.11.1; extra == 'mlflow'
+Requires-Dist: mlflow>=3.14.0; extra == 'mlflow'
+Requires-Dist: psutil>=7.2.2; extra == 'mlflow'
+Description-Content-Type: text/markdown
+
+# Text And Rotating Dimensions In Token Space
+ *or: how to make LMs bigger on the inside*
+
+Welcome to **TARDITS**, a library exploring (tiny) Complex-Valued LM architectures. It's my take on the awesome [Let's build GPT](https://youtu.be/kCc8FmEb1nY?si=I0z2-jByJj_6_QIH) tutorial. After finishing my GPT-net and updating it (RoPE, swiGLU, RMSNorm...), I got the idea to write a complex transformer. Mainly because I asked myself if they *really* need an activation function... turns out **they don't 🤯**
+
+After a few iterations, the $\mathbb{C}$-net got surprisingly stable. Of course, I had to try quaternions ($\mathbb{H}$) next. They were built using the Cayley-Dickson construction — so I pass 2 complex values through the transformer and let PyTorch do all the backprop work. Then the concept escalated a little, and the Octonion ($\mathbb{O}$) and Sedenion ($\mathbb{S}$) nets also somehow happened. Both work, but they take a really long time to train. Especially on CPU :D
+
+There may be better uses for CVNNs than predicting text... but why not Shakespeare?
+
+<br>
+
+
+## 🙃 Architecture
+<details>
+<summary><b>Click to expand 🔻</b></summary>
+
+<br>
+
+<p align="center">
+<img width="15%" src="https://github.com/user-attachments/assets/496ab290-72af-4087-b4fe-ff138fe22a37">
+</p>
+Figure: Complete dataflow inside the Transformer block, showing the transition from $\mathbb{R}$ to $\mathbb{Z}$ space, GyRoPE-infused attention, SAIL feed-forward, and residual routing.
+
+### ⛵ SAIL (Self-Activating Interference Layer)
+The main idea. In standard $\mathbb{R}$-nets, non-linear activation functions (like GELU or SwiGLU) in the feed-forward layer are strictly necessary. However, multiplying two complex numbers is inherently non-linear in itself. **SAIL** is essentially SwiGLU without the "Swi": It splits the input via a Linear Layer into two parts and multiplies them together. That alone is sufficient to get a fully trainable complex transformer. Combined with residual connections `z = z + SAIL(z)`, my guess is it could also be chaotic somehow (think Mandelbrot set).
+
+### 🪢 RoPE - Full Circle
+While ~~implementing~~ experimenting with RoPE in my $\mathbb{R}$-net, I found that a trainable RoPE initialized randomly from $-2\pi$ to $2\pi$ yielded results comparable to classical positive positional encodings. This proved to work nicely with the complex transformers. However the weights are few and they change *really* slowly during training.
+
+* $\mathbb{C}$-RoPE rotates in the $2\mathcal{D}$ complex plane.
+* $\mathbb{H}$-RoPE rotates around a unit 3-sphere ($S^3$).
+* $\mathbb{O}$ and $\mathbb{S}$ rotate around their respective hyperspherical counterparts.
+
+### 👀 Attention
+How do you route attention in complex spaces? I experimented with various variants, but turns out: **simplicity wins**. Attention scores are computed via the Hermitian dot product ($Q K^\dagger$). By extracting only the **real component** before applying the causal mask and standard Softmax:
+
+```python
+# In C-Space:
+wei = (q @ k.adjoint()) * (2 * self.head_size) ** -0.5
+wei = wei.real
+wei = F.softmax(wei.masked_fill(self.tril[:T, :T] == 0, float("-inf")), dim=-1)
+# Weighted value aggregation remains hypercomplex:
+out = wei.to(v.dtype) @ v
+```
+
+The real part perfectly captures the phase alignment and magnitude between queries and keys after multiplication, acting as a natural scalar affinity score. The resulting real weights are then used to scale the full complex/hypercomplex value vectors ($V$). No other variant yielded a better validation loss so far.
+
+### 🏋️ Weight Initialization
+Attention and SAIL weights are initialized around the unit circle/sphere and scaled by:
+
+$$\sqrt{\frac{S}{d_{in} + d_{out}}}$$
+
+(where $S$ is $\mathbb{C}=1.0$, $\mathbb{H}=0.5$, $\mathbb{O}=0.25$, $\mathbb{S}=0.125$)
+
+### 🛌 Embedding & LM-Head
+To map tokens into hypercomplex spaces, I used separate embedding tables - one for each real component (e.g., 4 tables for $\mathbb{H}$, 16 for $\mathbb{S}$) and initialized them with a scaled normal distribution (Var = 1.0):
+
+```python
+# Quaternion Embedding (4D)
+z1 = torch.complex(emb_r1(x), emb_i1(x))
+z2 = torch.complex(emb_r2(x), emb_i2(x))
+---
+ nn.init.normal_(emb.weight, std=(1 / math.sqrt(4)))
+```
+
+To project back to vocabulary logits, the `LMHead` simply flattens all complex components back to $\mathbb{R}$:
+
+```python
+features = torch.cat([z1.real, z1.imag, z2.real, z2.imag], dim=-1)
+return self.lin(features)
+```
+
+### 🛡️ RMSNorm - Norming Amplitudes, Preserving Phases
+ 🧨 remove for exploding transformer noises (NaN) 💥
+ 
+Standard normalization layers can easily distort geometric phase information in complex spaces.
+
+The custom **RMSNorm** calculates the Root Mean Square solely based on vector magnitudes ($\Vert{}q\Vert{}^2 = \vert{}z_1\vert{}^2 + \vert{}z_2\vert{}^2$):
+
+```python
+# Calculate quaternion amplitude squared
+ampsq = (z1 * z1.conj()).real + (z2 * z2.conj()).real
+rms = torch.rsqrt((ampsq / 2.0).mean(dim=-1, keepdim=True) + self.eps)
+
+return (z1 * rms) * self.weight, (z2 * rms) * self.weight
+```
+
+This scales feature amplitudes cleanly across layers while leaving phase angles completely intact.
+
+<br>
+<br>
+
+
+</details>
+
+## 🔥 Hot Curves (Benchmarks & Results)
+<details>
+<summary><b>Click to expand 🔻</b></summary>
+
+<br>
+
+### 🌊 SAIL Interference Patterns ($\mathbb{C}$)
+
+#### 🎬 2D SAIL Interference Evolution
+[![4 Layer SAIL](https://img.youtube.com/vi/nFiWQWMtX-Q/0.jpg)](https://www.youtube.com/watch?v=nFiWQWMtX-Q)
+[![8 Layer SAIL](https://img.youtube.com/vi/OIvpBzp8Y8c/0.jpg)](https://youtube.com/shorts/OIvpBzp8Y8c?si=LPVmYf6Skw9IRELd)
+
+#### 🎬 3D SAIL Phase-Amplitude Topography
+[![3D 4 Layer SAIL](https://img.youtube.com/vi/r6ykSiY3ipY/0.jpg)](https://youtu.be/r6ykSiY3ipY?si=VosKe4IpfWTy1jbz)
+[![3D 8 Layer SAIL](https://img.youtube.com/vi/7kjrDF7-UUg/0.jpg)](https://youtube.com/shorts/7kjrDF7-UUg?si=jcLONq29jUDC2mVX)
+
+*Figure: Evolution of selective phase interference across all 8 Transformer layers over training steps. Deep layers (6 & 7) demonstrate extreme destructive phase cancellation alongside razor-sharp resonance peaks (> 10,000 amplitude). That's why the Post-Norm design makes a lot of sense here*
+
+<br>
+
+### 📉 Comparison Runs
+
+shared parameters:
+
+| batch_size | block_size | dropout | learning rate | vocab_size |
+| :--------- | :--------: | :-----: | :-----------: | ---------- |
+| 32         |    128     |   0.2   |    0.0005     | 65         |
+
+#### $\mathbb{C}$ vs $\mathbb{R}$ / both ~180k params
+<img width="1745" height="828" alt="Image" src="https://github.com/user-attachments/assets/0d506bfc-471a-4ffa-bf06-c882151ad470" />
+
+| Model          |    Space     | $n_{embd}$ | Layers | Heads | Params | Train Loss | Val Loss  |
+| :------------- | :----------: | :--------: | :----: | :---: | :----: | :--------: | :-------: |
+| **ComplexGPT** | $\mathbb{C}$ |     54     |   4    |   6   | ~179k  | **1.472**  | **1.704** |
+| **RealGPT**    | $\mathbb{R}$ |     60     |   4    |   6   | ~181k  |   1.526    |   1.759   |
+
+#### $\mathbb{R}$ vs the complex rest
+
+Number of parameters scaled. Note: the higher dimensional runs take *forever*. A "Sedenion" needs 256 multiplications instead of one.
+
+<img width="1760" height="842" alt="Image" src="https://github.com/user-attachments/assets/78f152ca-ceab-435a-9b36-629031519223" />
+*Figure: Training and validation loss trajectories across spaces ($\mathbb{R}, \mathbb{C}, \mathbb{H}, \mathbb{O}, \mathbb{S}$). Note how Complex-383k (green) consistently outperforms the larger Real-baseline (blue).*
+
+| Model             |    Space     | $n_{embd}$ | Layers | Heads | Params | Train Loss | Val Loss  |
+| :---------------- | :----------: | :--------: | :----: | :---: | :----: | :--------: | :-------: |
+| **RealGPT**       | $\mathbb{R}$ |     96     |   5    |   6   | ~567k  |   1.367    |   1.645   |
+| **ComplexGPT**    | $\mathbb{C}$ |     72     |   5    |   6   | ~384k  | **1.359**  |   1.633   |
+| **QuaternionGPT** | $\mathbb{H}$ |     54     |   4    |   4   | ~356k  |   1.367    | **1.633** |
+| **OctonionGPT**   | $\mathbb{O}$ |     32     |   4    |   4   | ~264k  |   1.398    |   1.668   |
+| **SedenionGPT**   | $\mathbb{S}$ |     18     |   4    |   6   | ~184k  |   1.460    |   1.702   |
+
+<br>
+
+<details>
+<summary><b>v0.2.0 Bonus - Centumduodevigintunions 🔻</b></summary>
+<img width="1247" height="809" alt="image" src="https://github.com/user-attachments/assets/81aa403d-4203-48ef-8b90-ff45367b2f1c" />
+It's ridiculous, pointless and I can't even spell it... but it runs (very slowly). The most interesting usecases may be found on level 1-3 ;)
+</details>
+
+<br><br>
+
+
+</details>
+
+
+## 🚀 Quickstart & Usage
+
+
+### Install
+
+```bash
+pip install tardits
+# or
+uv add tardits
+```
+
+Optional - for [MLFlow](https://github.com/mlflow/mlflow) experiment tracking:
+
+```bash
+pip install tardits[mlflow]
+```
+
+### Quickstart
+
+#### Example configuration (save as .yaml):
+```yaml
+device: "auto" # Choices: "auto", "cuda", "cpu", "mps"
+seed: 1337
+
+model:
+  level: 1 # Complex
+  block_size: 64
+  n_head: 6
+  n_embd: 42
+  n_layer: 4
+  dropout: 0.2
+
+trainer:
+  batch_size: 32
+  max_iters: 5000
+  eval_interval: 500
+  learning_rate: 0.0005
+  eval_iters: 200
+  save_interval: 0
+  checkpoint: "saved_model.pt"
+
+mlflow:
+  experiment: "" # add name to enable
+  log_interval: 10
+  deep_log_interval: 0
+  system_metrics: false
+
+data:
+  input_path: "my_training_data.txt"
+  vocab_save_path: "saved/charset.txt"
+```
+You can also take a config one from [examples/configs] and the shakespeare.txt form [examples/data]
+
+
+#### Start Training
+```bash
+ttrain -c config.yaml
+```
+
+#### Generate Text
+```bash
+tgen -c config.yaml -p "To be or not to be" -l 200
+
+tgen -h
+options:
+  -h, --help            show this help message and exit
+  --config, -c CONFIG   Path to YAML configuration file
+  --checkpoint CHECKPOINT
+                        Optional override for model checkpoint path
+  --vocab VOCAB         Optional override for vocab path
+  --prompt, -p PROMPT   Text prompt to start generation
+  --length, -l LENGTH   Number of tokens to generate
+  --temp, -t TEMP       Model sampling temperature
+  --top_k, -k TOP_K     Top-k sampling threshold
+  --follow, -f          Endless stream of tokens
+  --delay DELAY         Delay between tokens in follow mode (seconds)
+```
+
+
+### v0.2.0 (Current Release)
+- [x] **Dynamic Dimension Scaling:** Universal recursive Cayley-Dickson engine ($2^k$ dimensions, up to 128D Centumduodevigintunion)
+- [x] **Package Refactoring:** Clean library structure for distribution
+- [x] **CLI Tools:** Easy executions via `ttrain` and `tgen`
+- [x] **PyPI Release:** Official package published on PyPI
+
+
+## 🧭 Outlook / Ideas
+* Try out the architecture on higher dimensional input (audio? weather? 3D?...)
+* Also more traditional scaling. How stable are the $\mathbb{C}$ and $\mathbb{H}$ nets really?
+* Would Quantization work out?
+* Add a tokenizer (the models were already tested on tokenized text during development - but it shrinks the already tiny dataset)
+* Maaaybe get a GPU (+ all the stuff around it 💰🔥 :D or rent online compute...)