https://github.com/pykale/mmai-tutorials
Open Multimodal AI Tutorials
https://github.com/pykale/mmai-tutorials
Last synced: 12 months ago
JSON representation
Open Multimodal AI Tutorials
- Host: GitHub
- URL: https://github.com/pykale/mmai-tutorials
- Owner: pykale
- Created: 2025-05-11T21:57:48.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-01T17:41:04.000Z (12 months ago)
- Last Synced: 2025-07-01T17:48:30.893Z (12 months ago)
- Language: Jupyter Notebook
- Homepage: https://pykale.github.io/mmai-tutorials
- Size: 20.4 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Multimodal AI tutorials repository
## Structure
- `tutorials/`: Contains tutorial notebooks and related materials.
- `requirements.txt`: Lists dependencies required for the project.
The structure of each tutorial is as follows:
```text
├───tutorial.ipynb
├───config.py
├───configs
│ ├───base.yml
│ ├───**.yml
├───model.py
├───models
│ ├───**.pt
├───data
│ ├───**.csv
│ ├───**.**
├───images
│ ├───**.png
│ ├───**.jpg
├───**.py
```
## How to Contribute
1. Fork the repository.
2. Create a new branch for your tutorial or bug fix:
```bash
git checkout -b my-branch
```
3. Make your changes and commit them with clear messages:
```bash
git commit -m "Add function ... to simplify tutorial ... content"
```
4. Push your branch to your forked repository:
```bash
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:
1. Install the `pre-commit` package if you haven't already:
```bash
pip install pre-commit
```
2. Install the hooks defined in the `.pre-commit-config.yaml` file:
```bash
pre-commit install
```
3. Run the hooks manually on all files (optional):
```bash
pre-commit run --all-files
```
Pre-commit hooks will now run automatically on every commit to check and format your code.