Getting Started

Getting Started

TrenTorch runs from a local pip install: there's no hosted installer, no cloud notebook target. You clone it, set up a virtual environment, and work through modules against a CLI-managed local Jupyter server (or a plain terminal, your choice).

Prerequisites

• Python 3.10–3.13
• Git

Install

# macOS / Linux
git clone https://github.com/TrenTorch/TrenTorch.git
cd TrenTorch

python3 -m venv .venv
source .venv/bin/activate

pip install -r requirements.txt
pip install -e .

# Windows (PowerShell)
git clone https://github.com/TrenTorch/TrenTorch.git
cd TrenTorch

python -m venv .venv
.venv\Scripts\Activate.ps1

pip install -r requirements.txt
pip install -e .

If PowerShell blocks the activation script with an execution-policy error, run Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass once first.

Verify it worked:

tren --version

First-time setup

tren setup

This creates the virtual environment (if you skipped the manual steps above), installs the fixed toolchain (NumPy, Jupyter, Jupytext, nbdev, Rich, PyYAML, psutil), registers a trentorch Jupyter kernel, prompts you to create a local profile, and asks whether to add tren to your PATH: say yes, and every terminal after that just needs tren, from any directory, without activating the venv first.

Check everything's healthy:

tren system health

Start module 01

tren module start 01

This opens data/modules/01_tensor/tensor.ipynb, a stub notebook with the problem and hints, not the answer, in Jupyter (Lab or classic Notebook, your call). Fill in the TODOs, then:

tren module complete 01

complete is the only command that actually tests, exports your code into the real trentorch package, and tracks progress. tren module test 01 runs the same tests without exporting, if you just want a check.

You can't jump ahead: module complete enforces that the previous module is done first, every time, not just when you started this one.

Check where you are

tren module status      # progress across all 20 modules
tren milestone status    # which historical milestones you've unlocked

Next

• Curriculum & Milestones: the full 20-module path and what each part builds
• CLI Reference: every tren command
• Contributing: if you want to work on TrenTorch itself, not just the curriculum