Schnelleinstieg

Status

Installation

1. Auschecken:

   $ git clone https://github.com/AInvone/Intro-in-KI-Schulung.git
   $ cd Intro-in-KI-Schulung

2. Installieren von Python-Paketen:

   … auf Linux/macOS:

   $ python3 -m venv .venv
   $ . .venv/bin/activate
   $ python -m pip install --upgrade pip
   $ python -m pip install --group dev

   … auf Windows:

   C:> py -m venv .venv
   C:> .\.venv\Scripts\activate.bat
   C:> python -m pip install --upgrade pip
   C:> python -m pip install --group dev
   

   Für den reinen Dokumentations-Build reicht die Gruppe docs:

   $ python -m pip install --group docs

3. Erstellen der HTML-Dokumentation:

   Zum Erstellen der HTML-Dokumentation (inkl. Ausführung der Jupyter-Notebooks):

   $ sphinx-build -b html docs docs/_build/html

   Das Ergebnis liegt in docs/_build/html/; die Startseite ist docs/_build/html/index.html.

   Note

   Für PDF- oder EPUB-Export wird ggf. pandoc benötigt (z. B. unter Debian/Ubuntu: sudo apt install pandoc).

4. Erstellen eines PDF:

   Für PDF wird eine LaTeX-Installation benötigt:

   … auf Debian/Ubuntu:

   $ sudo apt install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended latexmk

   … auf macOS (MacTeX):

   $ brew install --cask mactex

   Anschließend:

   $ cd docs/
   $ make latexpdf

   Das PDF liegt in docs/_build/latex/AITutorial.pdf.

Folgt uns

• GitHub

Pull-Requests

Wenn ihr Vorschläge für Verbesserungen und Ergänzungen habt, empfehlen wir euch, einen Fork unseres GitHub Repository zu erstellen und eure Änderungen dort zu machen. Bevor ihr Commits macht, überprüft, ob die pre-commit-Checks erfolgreich durchlaufen:

$ pre-commit install