Multimodal AI tutorials repository

This repository contains materials and resources for building the Jupyter book of the tutorials on multimodal AI applications using PyKale, a Python library of the PyTorch ecosystem.

Structure of source code

• workshop/: Contains information for the EMBC 2025 Workshop.
• tutorials/: Contains tutorial notebooks and related materials.
• requirements.txt: Lists dependencies required for the project.

Each tutorial is organized in a standardized structure as follows:

    ├───tutorial.ipynb
    ├───config.py
    ├───configs
    │   ├───base.yml
    │   ├───**.yml
    ├───model.py
    ├───images
    │   ├───**.png
    │   ├───**.jpg
    ├───helpers
    │   ├───**.py
    ├───extend-reading
    │   ├───**.md

How to Contribute

1. Fork the repository.

2. Create a new branch for your tutorial or bug fix:

   git checkout -b my-branch

3. Make your changes and commit them with clear messages:

   git commit -m "Add function ... to simplify tutorial ... content"

4. Push your branch to your forked repository:

   git push origin my-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 and preview the book

To build the book locally, you will need to have Jupyter Book and Sphinx Exercise packages installed. If you haven't installed them yet, you can do so using pip:

pip install jupyter-book==1.0.4.post1
pip install sphinx-exercise==1.0.1

To build the book in development, please ensure you are in the root directory of the repository. You can then run the following command:

jupyter-book build .

This will generate the HTML files in the _build/html directory. The home page of the book will be available at _build/html/index.html, from which you can navigate through the book.

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:

1. Install the pre-commit package if you haven't already:

   pip install pre-commit

2. Install the hooks defined in the .pre-commit-config.yaml file:

   pre-commit install

3. Run the hooks manually on all files (optional):

   pre-commit run --all-files

Pre-commit hooks will now run automatically on every commit to check and format your code.