Skip to content

Add project example #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iamzoltan merged 1 commit into from
Oct 21, 2026
Merged

Add project example #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions myst.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ project:
- file: tutorials/W2D1_Examples/W2D1_Tutorial3.md
- file: tutorials/W2D1_Examples/further_reading.md
- file: projects/README.md
children:
- file: projects/example_macrocircuits/README.md

site:
template: book-theme
Expand Down
10 changes: 10 additions & 0 deletions projects/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,16 @@ title: Project Booklet

This section contains the project materials for the course.

## Worked examples

A real Neuromatch project, converted to MyST:

- [Macrocircuits](example_macrocircuits/README.md) (NeuroAI): a single full project
notebook, with background, video and slides, a project-template image, setup for
Colab/Kaggle/local, sections with exercises, and feedback widgets.

It uses `runtime: colab` because its dependencies (`dm_control`, MuJoCo) can't run in the browser.

## How to structure your project booklet

Add your project guidance documents to the `projects/` directory and register
Expand Down
Loading
Loading