Research Project Template

Work-in-Progress

Please note: This is a work-in-progress and will get better over time! We want your feedback!🙏

This is a research project template. It is meant to be a starting point for ML researchers at Mila.

For more context, see this introduction to the project..

• Set up in 5 minutes

  ---

  Get started quickly with an interactive installation script and get up and running in minutes

  Getting started

• Well-tested, robust codebase

  ---

  Focus on your research! Let tests take care of detecting bugs and broken configs!

  Check out the included tests

• Support for both PyTorch and Jax

  ---

  You can use both PyTorch and Jax for your algorithms! (Lightning handles the rest.)

  Check out the Jax example

• Ready-to-use examples

  ---

  Includes examples for Supervised learning(1) and NLP 🤗, with unsupervised learning and RL coming soon.

  1. The source code for the example is available here

  Check out the examples here

Starting a new project

Setting up your environment

Locally (Linux / Mac)Locally (Windows)

1. Install uv:

   curl -LsSf https://astral.sh/uv/install.sh | sh
   

2. Create your new project

   Use this command to create a new project from this template: (Replace research_project with the path to the new project root folder.)

   uvx copier copy --trust gh:mila-iqia/ResearchTemplate research_project
   

   This will ask you a few questions and help setup your project.

1. Install WSL following this guide
2. Follow the installation instructions for Linux

Navigate to this new project, open up your favorite IDE, and voila! You're all setup! 🎊

Use this command to see all available options:

. .venv/bin/activate  # activate the virtual environment
python project/main.py --help

Usage

To see all available options:

python project/main.py --help

For a detailed list of examples, see the examples page.