Skip to content

z0u/ai-research

Repository files navigation

AI research template

This is a template repository for doing AI research. Features:

Getting started

If you want to run an experiment, make a copy of this repository. Since your project isn't a fork, you don't need to worry about keeping the code in sync, and you can add and remove Python packages as you wish.

uv sync
uv run modal setup  # Authenticate with Modal for remote compute

Then open the demo notebook and try it out. Choose .venv/bin/python3 as the kernel.

Virtual environment

The Python environment is configured when the dev container is created. If you open a Python file before the setup is complete, you may need to restart the Python language server.

Restarting the language server in VS Code
  1. Open a .py or .ipynb file
  2. Open the command pallette with P or CtrlShiftP
  3. Run Python: Restart Language Server.

Use uv to add and remove packages, and to run scripts:

uv add pydantic
uv run python my-experiment.py

Contributing

If you want to contribute to this template, then fork it as usual.

Before making a pull request, run:

uv run ruff check