Manual and cheat sheet
Two printable documents for researchers, kept in step with the Python SDK.
| Document | What it covers | Download |
|---|---|---|
| User manual | The whole researcher workflow with screenshots: accounts and projects, building and running experiments on the website, reviewing and saving runs, running experiments from Google Colab, and training your own rat model. | rodent_user_manual.pdf |
| Cheat sheet | Every Python command on one table per topic, with short recipes: signing in, experiments, runs and results, live changes, saving to Review, model training and sharing models. | rodent_cheat_sheet.pdf |
The downloadable PDFs were prepared for SDK 0.4.2 and are retained as printable workflow references. The current SDK is 0.4.4: install it with pip install rodent-sdk (add [train] for model training) and use the online pages for the 0.4.3 ONNX and 0.4.4 changes. Older notebooks that pin an earlier version keep working because published versions are never changed.
Notebooks
The notebooks the manual refers to open in Google Colab from the website's Use in Python dialog:
- Getting started: run an experiment, look at the results and save the run to Review. See Python and Google Colab.
- Train your rat: train a PyTorch model to control the rat, look at any episode, and save and reuse the model. Its model lives in
rat_model.py, downloaded next to the notebook. See Training your own rat model.