Skip to content

Getting Started

This page is only for running the academy preview locally. If Python is not yet installed, or you have never trained a model, start at First Steps and come back once python3 --version works on macOS/Linux or py --version works on Windows.

Setup

Run these commands from the academy repository root, the directory that contains mkdocs.yml.

On macOS or Linux:

python3 -m venv .venv
.venv/bin/python -m pip install -r requirements-docs.txt
.venv/bin/python -m pip install -r requirements.txt
.venv/bin/python -m mkdocs serve -f mkdocs.yml --dev-addr 127.0.0.1:8001

On Windows PowerShell:

py -m venv .venv
.venv\Scripts\python.exe -m pip install -r requirements-docs.txt
.venv\Scripts\python.exe -m pip install -r requirements.txt
.venv\Scripts\python.exe -m mkdocs serve -f mkdocs.yml --dev-addr 127.0.0.1:8001

Open http://127.0.0.1:8001/. Use 8000 if it is free; 8001 is the safer fallback.

Path Conventions

Run every academy script from the repository root with a repo-relative path. On macOS or Linux:

.venv/bin/python examples/course-support-inspection/quick_inspection.py

On Windows, the same run is:

.venv\Scripts\python.exe examples\course-support-inspection\quick_inspection.py

After setup, always use the interpreter inside .venv, not the system interpreter. That is the interpreter with the academy requirements installed.

If Something Breaks

  • imports fail — reinstall with .venv/bin/python -m pip install -r requirements.txt on macOS/Linux or .venv\Scripts\python.exe -m pip install -r requirements.txt on Windows
  • MkDocs will not start — make sure requirements-docs.txt is installed and switch the port to 8001
  • a script cannot find its data — check that the current directory is the academy repository root, where mkdocs.yml lives

Next

Open Study Plan for the ordered ladder, or Examples for short runs.