Skip to content

Commit d42c44c

Browse files
committed
Add workflow to publish slides; Update README.md
1 parent 58d5322 commit d42c44c

File tree

2 files changed

+49
-2
lines changed

2 files changed

+49
-2
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: publish_website
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
push_to_branch:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout
13+
uses: actions/checkout@v2
14+
with:
15+
fetch-depth: 0
16+
17+
- name: Setup Python
18+
uses: actions/setup-python@v2
19+
with:
20+
python-version: '3.x'
21+
22+
- name: Install Jupyter
23+
run: pip install notebook
24+
25+
- name: Export the notebook and Add files
26+
run: |
27+
mkdir temp
28+
cp -r img/ temp/img/
29+
jupyter nbconvert 1-neural_networks.ipynb --to slides
30+
mv 1-neural_networks.slides.html temp/1-neural-networks.html
31+
jupyter nbconvert 2-mnist_training.ipynb --to slides
32+
mv 2-mnist_training.slides.html temp/2-mnist-training.html
33+
mv README.md temp/README.md
34+
ls -R temp
35+
36+
- name: Deploy
37+
uses: s0/git-publish-subdir-action@develop
38+
env:
39+
REPO: self
40+
BRANCH: website
41+
FOLDER: temp
42+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
# Tutorial on basic neural network concepts
2+
23
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
34

45
- [Download the repository](#download-the-repository)
56
- [Getting started](#getting-started)
67
- [Running the tutorial](#running-the-tutorial)
78

89
## Material for this tutorial
10+
911
- The theoretical lecture can be found here
1012
- The tutorial in slide form is here
11-
13+
- [Part 1: Neural network basics](https://machine-learning-tutorial.github.io/neural-networks/1-neural-networks.html#/)
14+
- [Part 2: Training on MNIST dataset](https://machine-learning-tutorial.github.io/neural-networks/2-mnist-training.html#/)
1215

1316
## Download the repository
1417

@@ -116,8 +119,10 @@ The first part of the tutorial is in `1-neural_networks.ipynb`.
116119
The second part of the tutorial is in `2-mnist_training.ipynb`
117120

118121
## Citing the tutorial
119-
This tutorial is registered [Zenodo](https://zenodo.org/), which means that there is a DOI for each code release.
122+
123+
This tutorial is registered [Zenodo](https://zenodo.org/), which means that there is a DOI for each code release.
120124
Please use this DOI when citing this code:
121125

122126
## Disclaimer
127+
123128
The content of this repository was developed by the [AI4Accelerators team](https://www.ibpt.kit.edu/AI4Accelerators.php) at the [Institute of Beam Physics and Technology (IBPT)](https://www.ibpt.kit.edu/), [Karlsruhe Institute of Technology](https://www.kit.edu/english/).

0 commit comments

Comments
 (0)