You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -489,10 +487,16 @@ <h2>How to Contribute<a class="headerlink" href="#how-to-contribute" title="Link
489
487
<p>Please ensure your contributions adhere to the repository’s coding standards and include appropriate documentation.</p>
490
488
<sectionid="building-the-and-preview-the-book">
491
489
<h3>Building the and preview the book<aclass="headerlink" href="#building-the-and-preview-the-book" title="Link to this heading">#</a></h3>
492
-
<p>To build the book in development, assuming that the working directory is the project’s folder, please call:</p>
490
+
<p>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:</p>
<p>This will generate the HTML files in the <codeclass="docutils literal notranslate"><spanclass="pre">_build/html</span></code> directory. The home page of the book will be available at <codeclass="docutils literal notranslate"><spanclass="pre">_build/html/index.html</span></code>, from which you can navigate through the book.</p>
Copy file name to clipboardExpand all lines: _sources/README.md
+15-8Lines changed: 15 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ This repository contains materials and resources for building the [Jupyter book]
10
10
-[`tutorials/`](https://github.com/pykale/mmai-tutorials/tree/main/tutorials): Contains tutorial notebooks and related materials.
11
11
-[`requirements.txt`](https://github.com/pykale/mmai-tutorials/blob/main/requirements.txt): Lists dependencies required for the project.
12
12
13
-
The structure of each tutorial is as follows:
13
+
Each tutorial is organized in a standardized structure as follows:
14
14
15
15
```text
16
16
├───tutorial.ipynb
@@ -19,15 +19,13 @@ The structure of each tutorial is as follows:
19
19
│ ├───base.yml
20
20
│ ├───**.yml
21
21
├───model.py
22
-
├───models
23
-
│ ├───**.pt
24
-
├───data
25
-
│ ├───**.csv
26
-
│ ├───**.**
27
22
├───images
28
23
│ ├───**.png
29
24
│ ├───**.jpg
30
-
├───**.py
25
+
├───helpers
26
+
│ ├───**.py
27
+
├───extend-reading
28
+
│ ├───**.md
31
29
```
32
30
33
31
## How to Contribute
@@ -57,12 +55,21 @@ Please ensure your contributions adhere to the repository's coding standards and
57
55
58
56
### Building the and preview the book
59
57
60
-
To build the book in development, assuming that the working directory is the project's folder, please call:
58
+
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:
59
+
60
+
```bash
61
+
pip install jupyter-book==1.0.4.post1
62
+
pip install sphinx-exercise==1.0.1
63
+
```
64
+
65
+
To build the book in development, please ensure you are in the root directory of the repository. You can then run the following command:
61
66
62
67
```bash
63
68
jupyter-book build .
64
69
```
65
70
71
+
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.
72
+
66
73
## Pre-commit Hooks
67
74
68
75
This repository uses pre-commit hooks to ensure code quality and consistency. To set up pre-commit hooks locally, follow these steps:
Copy file name to clipboardExpand all lines: _sources/overview.md
+16-13Lines changed: 16 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,6 @@
2
2
3
3
This [Jupyter Book](https://jupyterbook.org) presents tutorials on multimodal AI applications using the [`PyKale`](https://github.com/pykale/pykale) library.
4
4
5
-
[//]: #(:::{note})
6
-
7
-
[//]: #(These resources are currently being developed.)
8
-
9
-
[//]: #(:::)
10
-
11
5
The book includes:
12
6
- Workshop overview: Learn what the workshop is about and see the schedule.
13
7
- Tutorials: Follow hands-on notebooks using multimodal data.
@@ -59,12 +53,21 @@ Please ensure your contributions adhere to the repository's coding standards and
59
53
60
54
### Building the Book Locally
61
55
62
-
To build the book in development, assuming that the working directory is the project's folder, please call:
56
+
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:
57
+
58
+
```bash
59
+
pip install jupyter-book==1.0.4.post1
60
+
pip install sphinx-exercise==1.0.1
61
+
```
62
+
63
+
To build the book in development, please ensure you are in the root directory of the repository. You can then run the following command:
63
64
64
65
```bash
65
66
jupyter-book build .
66
67
```
67
68
69
+
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.
70
+
68
71
### Pre-commit Hooks
69
72
70
73
This repository uses pre-commit hooks to ensure code quality and consistency. To set up pre-commit hooks locally, follow these steps:
@@ -89,18 +92,18 @@ This repository uses pre-commit hooks to ensure code quality and consistency. To
89
92
90
93
## Contributors
91
94
92
-
This workshop is made possible by contributions from:
95
+
This workshop is made possible by contributions from (in alphabetical order of surnames):
Copy file name to clipboardExpand all lines: overview.html
+14-8Lines changed: 14 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -502,10 +502,16 @@ <h3>How to Contribute via GitHub<a class="headerlink" href="#how-to-contribute-v
502
502
</section>
503
503
<sectionid="building-the-book-locally">
504
504
<h3>Building the Book Locally<aclass="headerlink" href="#building-the-book-locally" title="Link to this heading">#</a></h3>
505
-
<p>To build the book in development, assuming that the working directory is the project’s folder, please call:</p>
505
+
<p>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:</p>
<p>This will generate the HTML files in the <codeclass="docutils literal notranslate"><spanclass="pre">_build/html</span></code> directory. The home page of the book will be available at <codeclass="docutils literal notranslate"><spanclass="pre">_build/html/index.html</span></code>, from which you can navigate through the book.</p>
509
515
</section>
510
516
<sectionid="pre-commit-hooks">
511
517
<h3>Pre-commit Hooks<aclass="headerlink" href="#pre-commit-hooks" title="Link to this heading">#</a></h3>
@@ -531,27 +537,27 @@ <h3>Pre-commit Hooks<a class="headerlink" href="#pre-commit-hooks" title="Link t
531
537
</section>
532
538
<sectionid="contributors">
533
539
<h2>Contributors<aclass="headerlink" href="#contributors" title="Link to this heading">#</a></h2>
534
-
<p>This workshop is made possible by contributions from:</p>
540
+
<p>This workshop is made possible by contributions from (in alphabetical order of surnames):</p>
0 commit comments