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 in a terminal.

Setup

From the noki-website/ directory:

python3 -m venv academy/.venv
academy/.venv/bin/python -m pip install -r academy/requirements-docs.txt
academy/.venv/bin/python -m pip install -r academy/requirements.txt
academy/.venv/bin/python -m mkdocs serve -f academy/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 noki-website/ with the full academy/... path:

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

Always use academy/.venv/bin/python, not the system python3. That is the only interpreter with the academy requirements installed.

If Something Breaks

  • imports fail — reinstall with academy/.venv/bin/python -m pip install -r academy/requirements.txt
  • MkDocs will not start — make sure requirements-docs.txt is installed and switch the port to 8001
  • a script cannot find its data — check the current directory is noki-website/, not academy/

Next

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