Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,30 @@ This repository contains materials and resources for workshops conducted in 2025
## How to Contribute

1. Fork the repository.
2. Create a new branch for your feature or bug fix:
2. Create a new branch for your tutorial or bug fix:
```bash
git checkout -b my-feature-branch
git checkout -b my-branch
```
3. Make your changes and commit them with clear messages:
```bash
git commit -m "Add feature X"
git commit -m "Add function ... to simplify tutorial ... content"
```
4. Push your branch to your forked repository:
```bash
git push origin my-feature-branch
git push origin my-tutorial-branch
```
5. Open a pull request to the main repository.

Please ensure your contributions adhere to the repository's coding standards and include appropriate documentation.

## Building the Book

To build the book in development, assuming that the working directory is the project's folder, please call:

```bash
jupyter-book build .
```

## Pre-commit Hooks

This repository uses pre-commit hooks to ensure code quality and consistency. To set up pre-commit hooks locally, follow these steps:
Expand Down
4 changes: 1 addition & 3 deletions tutorials/brain-disorder-diagnosis/config.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
import os
from yacs.config import CfgNode

DEFAULT_DIR = os.path.join(os.getcwd(), "data")

_C = CfgNode()

# Dataset configuration
_C.DATASET = CfgNode()
# Path to the dataset directory
_C.DATASET.PATH = DEFAULT_DIR
_C.DATASET.PATH = "data"
# Name of the brain atlas to use
# Available options:
# - "aal" (AAL)
Expand Down
4 changes: 2 additions & 2 deletions tutorials/brain-disorder-diagnosis/data.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@
}
)
],
"vectorize": [bool],
"verbose": [bool],
"vectorize": ["boolean"],
"verbose": ["boolean"],
},
prefer_skip_nested_validation=False,
)
Expand Down
Loading