IEinAI

Workshop materials for the Interpretability & Explainability in AI course at University of Amsterdam.

Making edits

To make edits in the workshop materials and publish them to the website, you need to:

1. Clone this repository locally:

   git clone [email protected]:clclab/IEinAI.git
   cd IEinAI
   

2. Install jupyter-book and ghp-import

   pip install -U jupyter-book
   pip install ghp-import
   

3. Make sure your local files are up-to-date with the ones in this repository:

   git pull
   

4. *Make the changes to the local files on your computer*
5. Rebuild the book:

   jupyter-book build --all book
   

6. Add, commit and push the changes to this repository:

   git add *
   git commit -m 'some edits'
   git push
   

7. Send the updated html to the gh-pages branch (this is what gets published to the website):

   ghp-import -n -p -f book/_build/html
   

8. Typically the changes should be live after a few minutes. If you don't see the changes, try opening the website in an incognito window; if the changes do show up there, it should be fine. If not, check the Actions tab of this repository for build fails.

Steps 1 and 2 only need to be done once; then repeat steps 3 through 7 anytime you want to make new edits.
Note that not any file added to any subdirectories of the book/ folder will be added to the website automatically: to make it show up, add a reference to the respective (.md or .ipynb) file in book/_toc.yml.