Skip to content

Commit 6376e3d

Browse files
committed
chore
1 parent 6db53f0 commit 6376e3d

8 files changed

Lines changed: 9 additions & 9 deletions

File tree

ARCHITECTURE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ in `docs/design/limb-design.md`, `docs/design/bigint-design.md`, and `docs/desig
6767
## Visual guides
6868

6969
- `docs/diagrams/core-architecture.mermaid.md` — layered helpers from `limb``bigint` → the umbrella helpers and GEMM stack.
70-
- [`docs/diagrams/docs-sitemap.mermaid.md`](diagrams/docs-sitemap.mermaid.md) — site map summarizing the docs portal and related resources.
70+
- [`docs/diagrams/docs-sitemap.mermaid.md`](docs/diagrams/docs-sitemap.mermaid.md) — site map summarizing the docs portal and related resources.
7171

7272
This guide is intentionally light and developer-facing—if you need a runnable overview, `docs/index.md`
7373
acts as the higher-level docs portal introduced in the README.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ See [docs/api-overview.md](docs/api-overview.md) for the full surface described
210210

211211
### Specs & design
212212

213-
- [docs/t81lib-spec-v1.0.0.md](docs/t81lib-spec-v1.0.0.md) — Normative contract.
213+
- [docs/t81lib-spec-v0.1.0.md](docs/t81lib-spec-v0.1.0.md) — Normative contract.
214214
- [docs/design/](docs/design/) — Deep dives on `limb`, `bigint`, and `montgomery`.
215215
- [docs/api-overview.md](docs/api-overview.md) — Umbrella helper catalog.
216216
- [ARCHITECTURE.md](ARCHITECTURE.md) & [docs/index.md](docs/index.md) — Architecture stories and portal.

docs/hardware.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ Highlights include:
1010

1111
See `examples/ternary_hardware_sim_demo.ipynb` for a guided walkthrough that builds a ternary adder, runs a small inference, records virtual power/latency metrics, and highlights how balanced ternary drops switching energy for drones or tiny neuromorphic chips.
1212

13-
The [hardware kernel sketch](docs/diagrams/hardware-kernels.mermaid.md) summarizes the tryte packing → multiply → accumulate flow used by the AVX/NEON GEMM paths.
13+
The [hardware kernel sketch](diagrams/hardware-kernels.mermaid.md) summarizes the tryte packing → multiply → accumulate flow used by the AVX/NEON GEMM paths.

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ From here: `t8.nn.Linear` for drop-in layers, `t8.convert`/`t8.gguf` for scripte
3838
- **Landing & Quick Start**[`README.md`](../README.md) contains the hero content, badges, and a comprehensive quick
3939
start section for builds, subprojects, pip/pipx consumers, CLI helpers, and the new “Start here” router.
4040
- **Architecture guide**[`ARCHITECTURE.md`](../ARCHITECTURE.md) walks through the component layers and data flow.
41-
- **Normative spec**[`docs/t81lib-spec-v1.0.0.md`](t81lib-spec-v1.0.0.md) defines the API guarantees for `limb`, `bigint`, and helpers.
41+
- **Normative spec**[`docs/t81lib-spec-v0.1.0.md`](t81lib-spec-v0.1.0.md) defines the API guarantees for `limb`, `bigint`, and helpers.
4242
- **Design notes**[`docs/design/limb-design.md`](design/limb-design.md), [`docs/design/bigint-design.md`](design/bigint-design.md), [`docs/design/montgomery-design.md`](design/montgomery-design.md) explain internal
4343
choices, algorithms, and invariants.
4444
- **Examples**[`examples/`](../examples/) hosts runnable demos that mirror the README snippets.

docs/torch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ This module keeps biases in FP32/BF16 while quantizing weights lazily, so you ca
1919
- `scripts/convert_to_ternary.py` walks a checkpoint tree, swaps every `torch.nn.Linear` for `t81.nn.Linear`, reports size reductions, and can force CPU device maps for reliable saves.
2020
- `t81-convert`, `t81-gguf`, and `examples/cli-examples.md` provide one-click scripts that mirror the Python flows while also exporting GGUF bundles for llama.cpp and Hugging Face runtimes.
2121

22-
See [examples/README.md](examples/README.md) and [docs/use-cases.md](docs/use-cases.md) for runnable demos, scaling-law studies, and QAT comparisons.
22+
See [examples/README.md](../examples/README.md) and [use-cases.md](use-cases.md) for runnable demos, scaling-law studies, and QAT comparisons.

docs/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,5 +64,5 @@ This guide complements [README.md](../README.md) and the other reference pages b
6464
6565
## Where to go next
6666
67-
- Review the [docs/index.md](docs/index.md) portal for deep dives on Python, Torch, CLI, and hardware flows.
67+
- Review the [index.md](index.md) portal for deep dives on Python, Torch, CLI, and hardware flows.
6868
- If you hit a reproducible failure, open an issue referencing the log from `build/test-output` and the exact `cmake` command you used.

docs/use-cases.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
### Extreme compression for on-device inference
66

77
Ternary PTQ/QAT on Phi-3-mini-4k-instruct: measure size (FP16 -> ternary), latency, and perplexity in a single workflow.
8-
Start here: [`examples/ternary_phi3_ptq_qat_demo.ipynb`](examples/ternary_phi3_ptq_qat_demo.ipynb).
8+
Start here: [`examples/ternary_phi3_ptq_qat_demo.ipynb`](../examples/ternary_phi3_ptq_qat_demo.ipynb).
99

1010
1. Convert existing large language models to ternary weights while keeping `torch.nn.Module` semantics (`examples/demo_llama_conversion.py`).
1111
2. Study ternary scaling laws for RMSNorm, RoPE, and ternary softmax to compare precision versus throughput (`examples/scaling_laws_ternary.py`).
@@ -25,4 +25,4 @@ These scripts and notebooks mirror the CLI workflows while keeping you inside Py
2525

2626
## Additional references
2727

28-
Mentioned demos also appear in `docs/index.md` and `docs/references/cli-usage.md` so you can toggle between CLI helpers and Python stories without guessing. The [quantization workflow diagram](docs/diagrams/quantization-workflow.mermaid.md) ties the PyTorch conversion path to the CLI export/inference steps above.
28+
Mentioned demos also appear in `docs/index.md` and `docs/references/cli-usage.md` so you can toggle between CLI helpers and Python stories without guessing. The [quantization workflow diagram](diagrams/quantization-workflow.mermaid.md) ties the PyTorch conversion path to the CLI export/inference steps above.

examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ This file is the canonical list of runnable scripts and notebooks maintained und
1818
- `examples/ternary_hardware_sim_demo.ipynb` — Build a ternary adder, trace virtual power/latency, and compare energy vs binary hardware using `t81.hardware.TernaryEmulator`.
1919
- `examples/cli-examples.md` — Copy/paste-ready snippets for `t81-convert`, `t81-gguf`, and `t81-qat` workflows.
2020

21-
Refer to [docs/use-cases.md](docs/use-cases.md) for details on how these examples tie into broader quantization, scaling-law, and hardware experiments, and consult the [quantization workflow diagram](../docs/diagrams/quantization-workflow.mermaid.md) for the PyTorch → CLI → inference path.
21+
Refer to [docs/use-cases.md](../docs/use-cases.md) for details on how these examples tie into broader quantization, scaling-law, and hardware experiments, and consult the [quantization workflow diagram](../docs/diagrams/quantization-workflow.mermaid.md) for the PyTorch → CLI → inference path.

0 commit comments

Comments
 (0)