TensorCAD documentation¶
Nothing to install
The editor runs in a browser at app.tensorcad.dev. The engine is WebAssembly, so the analysis happens in your tab — open a preset and the numbers on this site are the numbers you will see.
Organised by Diátaxis: four kinds of document for four different needs. Knowing which one you are in saves everybody time — a tutorial that stops to explain itself is a bad tutorial, and a reference that tries to teach is a bad reference.
| Practical steps | Theoretical knowledge | |
|---|---|---|
| Study | Tutorials — learning by doing | Explanation — understanding why |
| Work | How-to guides — solving a problem | Reference — looking something up |
Tutorials¶
Start here if you are new. These are lessons: follow them start to finish and you will have built something.
- Your first design — build a small transformer from an empty sheet, check it, and generate the PyTorch.
- Tune small, run big — shrink a published architecture until it trains on one card, sweep the learning rate there, carry it back up the μP ladder, and price the real run before you queue it.
How-to guides¶
Recipes for a specific job, assuming you already know your way around.
- Add a block to the catalog
- Add a preset
- Define a block inside a document — the KiCad-style project library, no TypeScript required
- Verify a design against PyTorch
- Drive TensorCAD from an agent
Reference¶
Descriptions of the machinery. Dry on purpose.
- Ports — what a pin declares and what each field does
- The document format — the IR, which is the source of truth for everything else
- Design rules — every check, what it fires on
- Analysis outputs — every number the engine reports
- The analysis maths — the formulas, with sources
- Command line
Explanation¶
Background and argument. Read when you want to know why something is the way it is, or why it is not something else.
- Why schematic capture — the case for treating a model like a circuit
- The shape algebra — why dimensions are exact polynomials rather than integers
- Interaction design — sixteen passes of editor work, each with what was wrong and what replaced it
- Landscape — the tools that already exist and what they do not do
These pages are published at docs.tensorcad.dev, and read the same in the repository. The editor itself runs in a browser at app.tensorcad.dev — the engine is WebAssembly, so nothing is computed on a server and no design leaves the tab.
pip install mkdocs-material && mkdocs serve brings this site up locally, with
search.
Contributor-facing material lives at the repository root, not here:
CONTRIBUTING.md for the workflow,
CLAUDE.md for the invariants and the agent entry point,
ROADMAP.md for what is planned. Those links leave the site,
because those files are for somebody with the repository open.