cogforge-engine 0.2.0__tar.gz → 1.0.0__tar.gz

cogforge_engine-1.0.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.

cogforge_engine-1.0.0/PKG-INFO

@@ -0,0 +1,333 @@
+Metadata-Version: 2.4
+Name: cogforge-engine
+Version: 1.0.0
+Summary: A custom autograd engine and Transformer block built from scratch.
+Project-URL: Homepage, https://github.com/avikmjd2/cogforge
+Author-email: Avik Majumder <avikmjd2@gmail.com>
+License-File: LICENSE
+Requires-Python: >=3.8
+Requires-Dist: numexpr>=2.8.0
+Requires-Dist: numpy>=1.20.0
+Provides-Extra: cuda
+Requires-Dist: cupy>=12.0.0; extra == 'cuda'
+Description-Content-Type: text/markdown
+
+# cogforge
+
+> A from-scratch deep learning library built on nothing but NumPy — a reverse-mode autograd engine extended all the way to a working GPT.
+
+`cogforge` is a small, readable, educational deep learning framework. At its core is a `Tensor` that records every operation into a computation graph and backpropagates through it (micrograd-style), but unlike a toy autograd it scales up to real architectures: MLPs, RNNs, batch/layer normalization, multi-head attention, and a decoder-only transformer (`GPTV1`) you can actually train and sample from.
+
+There is no C++, no CUDA, no PyTorch — just NumPy and explicit, hand-derived gradients. The goal is to *understand* every gradient that flows, not to be fast.
+
+---
+
+## Table of contents
+
+- [Installation](#installation)
+- [Quick start](#quick-start)
+- [Core concept: the `Tensor`](#core-concept-the-tensor)
+- [API reference](#api-reference)
+  - [Tensor — autograd engine](#tensor--autograd-engine)
+  - [Losses](#losses)
+  - [Layers](#layers)
+  - [Containers](#containers)
+  - [Recurrent](#recurrent)
+  - [Sequence-to-sequence](#sequence-to-sequence)
+  - [Optimizers](#optimizers)
+  - [Models](#models)
+- [Worked example: train a char-level GPT](#worked-example-train-a-char-level-gpt)
+- [Gotchas](#gotchas)
+- [Roadmap](#roadmap)
+- [License](#license)
+
+---
+
+## Installation
+
+```bash
+pip install cogforge-engine
+```
+
+Requires Python 3.8+ and NumPy. That's the only dependency.
+
+The package is organized into two modules:
+
+| Module | Contains |
+| --- | --- |
+| `cogforge.app` | The autograd engine (`Tensor`) and every building block — layers, optimizers, losses, normalization, attention. |
+| `cogforge.models` | Ready-to-use models. Currently `GPTV1`. |
+
+```python
+from cogforge.app import Tensor, Linear, Adam, MultiHeadAttention   # building blocks
+from cogforge.models import GPTV1                                    # models
+```
+
+---
+
+## Quick start
+
+```python
+import numpy as np
+from cogforge.app import Tensor
+
+# Build a graph
+a = Tensor(np.array([2.0, 3.0]))
+b = Tensor(np.array([4.0, 5.0]))
+c = (a * b).sigmoid().softmax()
+
+# Backpropagate (note the spelling: backwards, with an 's')
+c.backwards()
+
+print(a.grad)   # gradient of the output w.r.t. a
+```
+
+Every `Tensor` carries a `.data` (the NumPy array), a `.grad` (same shape, accumulates gradients), and a hidden `_backwards` closure that knows how to push gradient to its parents. Calling `.backwards()` on any node runs a topological sort and walks the graph in reverse.
+
+---
+
+## Core concept: the `Tensor`
+
+```python
+Tensor(array, children=(), requires_grad=True, typed="compressed")
+```
+
+| Argument | Meaning |
+| --- | --- |
+| `array` | Any array-like; stored as a NumPy array in `.data`. |
+| `children` | Parent tensors in the graph (set internally by ops; you rarely pass this). |
+| `requires_grad` | Reserved flag (currently informational). |
+| `typed` | `"compressed"` → `float32` (default), anything else → `float64`. |
+
+Gradients **accumulate** into `.grad`. Always zero them between optimization steps (the optimizers do this for you via `zero_grad()`).
+
+---
+
+## API reference
+
+### Tensor — autograd engine
+
+**Differentiable operations** (each builds graph and defines its own backward):
+
+| Operation | Notes |
+| --- | --- |
+| `a + b`, `a - b`, `a * b` | Elementwise, with broadcasting support. |
+| `a @ b` | Batched matmul; gradients are correctly un-broadcast. |
+| `a[key]` | Indexing/slicing. |
+| `.relu()` | |
+| `.sigmoid()` | |
+| `.tanh()` | |
+| `.softmax(axis=-1)` | Numerically stable (max-subtraction). |
+| `.view(shape)` | Reshape (handles non-contiguous data). |
+| `.flatten()` | Flattens everything after the batch dim → `(B, -1)`. |
+| `.flatten_consective(num)` | Groups `num` consecutive timesteps. Expects a 3-D `(B, T, C)` tensor; `T` must be divisible by `num`. |
+| `.transpose(axes)` | Permute axes (pass the full permutation tuple). |
+| `.masked_fill(mask, value)` | Sets entries where `mask` is `True` to `value` (used for causal attention). |
+
+**Backward pass**
+
+| Method | Notes |
+| --- | --- |
+| `.backwards()` | **Primary.** Iterative topological sort — safe for deep/long graphs. |
+| `.backwards_recursive()` | Legacy recursive version; can hit Python's recursion limit on long sequences. Prefer `.backwards()`. |
+
+**Static helper**
+
+- `Tensor.unbroadcast(grad, shape)` — reduces a broadcasted gradient back to the original parameter shape. Used internally.
+
+---
+
+### Losses
+
+All losses are **classmethods** on `Tensor` and return a scalar loss tensor you call `.backwards()` on. Mind the distinction between losses that take **probabilities** and losses that take **raw logits** — this is the most common mistake.
+
+| Loss | Input expectation | Use when |
+| --- | --- | --- |
+| `Tensor.cross_entropy_loss(predictions, targets)` | `predictions` are **probabilities** (call `.softmax()` first), `targets` one-hot. | You already have a softmax in your graph. |
+| `Tensor.softmax_cross_entropy(scores, targets)` | `scores` are **raw logits**, `targets` one-hot. Softmax is fused inside (stable). Works for 2-D `(B,V)` and 3-D `(B,T,V)`. | Standard classification / LM. **Recommended.** |
+| `Tensor.sparse_softmax_cross_entropy(scores, target_ids)` | `scores` raw logits `(B,T,V)`, `target_ids` integers `(B,T)`. | Language modeling — skips building one-hot targets. |
+| `Tensor.cross_entropy_loss_masked(predictions, targets, mask)` | Probabilities + per-row `mask` (1 = real, 0 = pad). | Padded batches. |
+| `Tensor.softmax_cross_entropy_masked(scores, targets, mask)` | Logits + per-row mask. | Padded batches, fused softmax. |
+
+> ℹ️ `softmax_cross_entropy` and `sparse_softmax_cross_entropy` apply softmax internally. Do **not** pass already-softmaxed values into them. `cross_entropy_loss` is the opposite — it expects probabilities.
+
+---
+
+### Layers
+
+#### `Linear(nin, nout)`
+Affine transform `x @ W + b`. He-initialized weights. `.parameters()` → `[W, b]`.
+
+#### `Embedding(vocab_size, embedding_dim)`
+Lookup table. Call with an integer index array; backward scatters gradients correctly (uses `np.add.at`, so repeated indices accumulate). `.parameters()` → `[weights]`.
+
+#### `LayerNorm(dim, eps=1e-5)`
+Normalizes over the last dimension. Learnable `gamma`/`beta`. `.parameters()` → `[gamma, beta]`.
+
+#### `BatchNorm1D(dim, eps=1e-5, momentum=0.1)`
+Normalizes over the batch (and time, for 3-D input). Tracks `running_mean`/`running_var` for inference. Toggle `.training = True/False`. Learnable `gamma`/`beta`.
+
+#### `Attention(dk)`
+Scaled dot-product attention. Call `attention(Q, K, V, mask=None)`. `dk` is the key dimension (sets the `1/√dk` scale).
+
+#### `MultiHeadAttention(dinp, dmodel, dout, n)`
+`n` heads, `dmodel` split into `n` chunks of size `dmodel // n` (must divide evenly). Projects input `dinp → dmodel`, attends, projects `dmodel → dout`. Call `mha(query, key, value, mask=None)`. `.parameters()` returns all four projection layers' params.
+
+#### `FeedForward(dmodel, dff=None)`
+Position-wise MLP: `Linear → ReLU → Linear`. `dff` defaults to `4 * dmodel`. `.parameters()` included.
+
+#### `Transformer(dmodel, n, dff=None)`
+A **pre-norm** decoder block: `x + Attn(LN(x))` then `x + FF(LN(x))`. `n` = number of attention heads. Call `block(x, mask=None)`. `.parameters()` included.
+
+#### `PositionalEncoding(max_len, dmodel)`
+Fixed sinusoidal positions, added to the input. Call `pe(x)`. No parameters.
+
+---
+
+### Containers
+
+#### `Sequential(layers)`
+Runs layers in order. `.train()` / `.test()` flip the `training` flag on any layer that has one (e.g. `BatchNorm1D`).
+
+> ⚠️ `Sequential.parameters()` only collects layers exposing `W`, `b`, `gamma`, or `beta` attributes (i.e. `Linear`, `LayerNorm`, `BatchNorm1D`). Composite layers like `MultiHeadAttention`, `FeedForward`, and `Transformer` hold sub-modules, so their parameters are **not** picked up here — gather those via each module's own `.parameters()`.
+
+#### `MLP(layer_sizes)`
+Convenience feed-forward net: `Linear → ReLU` between layers, plain `Linear` output. Built from a list of sizes, e.g. `MLP([784, 128, 64, 10])`.
+
+- `.save(filename="best_model.npz")` / `.load(filename="best_model.npz")` — persist/restore weights.
+- *Note:* `MLP` does not expose a `parameters()` method; collect them via `[p for layer in mlp.layers for p in layer.parameters()]` if you want to optimize it.
+
+---
+
+### Recurrent
+
+#### `RNNCell(input_dim, hidden_dim)`
+One tanh recurrence step: `h_next = tanh(i2h(x) + h2h(h_prev))`. `.parameters()` included.
+
+#### `RNN(input_dim, hidden_dim)`
+Unrolls a cell over a **list** of timestep tensors (each `(B, input_dim)`) and returns the list of hidden states (each `(B, hidden_dim)`). Optional `prev_hidden`.
+
+#### `StackedRNN(input_dim, hidden_dim, num_layers)`
+Multiple `RNN` layers stacked. Returns `(top_layer_states, per_layer_final_states)` — the second value is convenient for seq2seq.
+
+---
+
+### Sequence-to-sequence
+
+#### `Bridge(enc_hidden, dec_hidden, enc_layers, dec_layers, mode="project")`
+Maps encoder final hidden states to decoder initial hidden states, handling mismatched layer counts and hidden sizes.
+
+| `mode` | Behavior |
+| --- | --- |
+| `"project"` | One learned `Linear(enc_hidden → dec_hidden)` per decoder layer. General, recommended. |
+| `"tie"` | No parameters; requires `enc_hidden == dec_hidden`. Selects/repeats raw states. |
+
+---
+
+### Optimizers
+
+Both take an iterable of parameter tensors and share the same interface: `step()`, `zero_grad()`, `clip_grads(max_norm=5.0)`.
+
+#### `SGD(parameters, learning_rate=0.01)`
+Plain stochastic gradient descent.
+
+#### `Adam(parameters, lr=1e-3, beta1=0.9, beta2=0.999, eps=1e-8)`
+Adam with bias correction. Recommended for transformers.
+
+```python
+opt = Adam(model.parameters(), lr=3e-4)
+opt.zero_grad()
+loss.backwards()
+opt.clip_grads(1.0)   # optional gradient clipping
+opt.step()
+```
+
+---
+
+### Models
+
+#### `GPTV1(vocab, d_model, n_heads, n_layers, max_len, d_ff=None)`
+A decoder-only transformer (token embedding + sinusoidal positions + stacked pre-norm `Transformer` blocks + final `LayerNorm` + output head). Causal masking is applied internally.
+
+| Method | Description |
+| --- | --- |
+| `model(idx)` | `idx`: integer array `(B, T)`. Returns logits `(B, T, vocab)`. |
+| `model.parameters()` | All trainable tensors. |
+| `model.generate(idx, n_new, temperature=1.0, top_k=None)` | Autoregressive sampling. Crops to `max_len`, supports temperature and top-k. Returns `(B, T + n_new)`. |
+
+---
+
+## Worked example: train a char-level GPT
+
+```python
+import numpy as np
+from cogforge.app import Tensor, Adam
+from cogforge.models import GPTV1
+
+# --- data -------------------------------------------------------------
+text  = open("input.txt").read()
+chars = sorted(set(text))
+stoi  = {c: i for i, c in enumerate(chars)}
+itos  = {i: c for i, c in enumerate(chars)}
+data  = np.array([stoi[c] for c in text])
+vocab = len(chars)
+
+# --- model ------------------------------------------------------------
+block = 64
+model = GPTV1(vocab=vocab, d_model=128, n_heads=4,
+              n_layers=4, max_len=block)
+opt   = Adam(model.parameters(), lr=3e-4)
+
+def get_batch(bs=32):
+    ix = np.random.randint(0, len(data) - block - 1, size=bs)
+    x  = np.stack([data[i:i + block]     for i in ix])
+    y  = np.stack([data[i + 1:i + block + 1] for i in ix])
+    return x, y
+
+# --- train ------------------------------------------------------------
+for step in range(2000):
+    x, y   = get_batch()
+    logits = model(x)                                  # (B, T, vocab)
+    loss   = Tensor.sparse_softmax_cross_entropy(logits, y)
+
+    opt.zero_grad()
+    loss.backwards()
+    opt.clip_grads(1.0)
+    opt.step()
+
+    if step % 100 == 0:
+        print(f"step {step:4d} | loss {loss.data:.4f}")
+
+# --- sample -----------------------------------------------------------
+ctx = np.array([[stoi["\n"]]])
+out = model.generate(ctx, n_new=300, temperature=0.8, top_k=20)
+print("".join(itos[i] for i in out[0]))
+```
+
+---
+
+## Gotchas
+
+- **It's `backwards()`, not `backward()`.** The backward pass method has a trailing `s`.
+- **Logits vs. probabilities.** `softmax_cross_entropy` / `sparse_softmax_cross_entropy` fuse the softmax internally — feed them **raw logits**. `cross_entropy_loss` expects **probabilities**. Mixing these up silently trains the wrong thing.
+- **Gradients accumulate.** Call `optimizer.zero_grad()` every step (or `p.grad[...] = 0`), or gradients pile up across iterations.
+- **`Sequential.parameters()` is shallow** — see the note under [Containers](#containers). For attention/feed-forward/transformer stacks, gather parameters through each module's own `.parameters()` (as `GPTV1.parameters()` does).
+- **RNNs operate on lists**, not a single `(B, T, C)` tensor — pass a list of per-timestep tensors.
+
+---
+
+## Roadmap
+
+Planned / under consideration:
+
+- RoPE (rotary position embeddings) with length interpolation
+- SwiGLU feed-forward and RMSNorm
+- Weight tying between embedding and output head
+- KV cache for faster generation
+- Linear-attention block (as a study in the recall-vs-cost tradeoff)
+
+---
+
+## License
+
+MIT License. See [LICENSE](LICENSE) for details.