Overview

Overview#

This Jupyter Book presents tutorials on multimodal AI applications using the PyKale library.

The book includes:

  • Workshop overview: Learn what the workshop is about and see the schedule.

  • Tutorials: Follow hands-on notebooks using multimodal data.

  • Applications: Learn how AI can help with brain disorders, cancer, drug interactions, and more.

What You’ll Need#

  • A laptop with Wi-Fi capability

  • A Google account (https://accounts.google.com/signin) to access and run the tutorials using Google Colab

  • A GitHub account (signup) to make contributions and use GitHub Discussions.

How to Begin#

  • Start with the Introduction under Workshop on the left sidebar.

  • Find the tutorial chapters you want to follow under Tutorials.

  • Follow the tutorials step by step from top to bottom.

Tips for Attendees#

  • If you have any question, please post a new discussion topic in the GitHub Discussions.

  • Use the Search (on the left) to quickly find specific topics.

  • If you want to contribute, please read the following section.

Contributing#

How to Contribute via GitHub#

  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-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 Locally#

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

Contributors#

This workshop is made possible by contributions from (in alphabetical order of surnames):

Contents