Skip to content

Commit e0434fa

Browse files
committed
📝 Switch to uv.lock
* Switch to uv for install instructions * Add shap package * Update notebooks * Fix customer-churn notebook * Fix Python syntax
1 parent 90ce476 commit e0434fa

16 files changed

Lines changed: 17315 additions & 11349 deletions

README.rst

Lines changed: 24 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ Schnelleinstieg
44
Status
55
------
66

7-
.. image:: https://img.shields.io/github/contributors/AInvone/Intro-in-KI-Schulung.svg
7+
.. image:: https://img.shields.io/github/contributors/cusyio/ai-tutorial.svg
88
:alt: Contributors
9-
:target: https://github.com/AInvone/Intro-in-KI-Schulung/graphs/contributors
10-
.. image:: https://img.shields.io/github/license/AInvone/Intro-in-KI-Schulung.svg
9+
:target: https://github.com/cusyio/ai-tutorial/graphs/contributors
10+
.. image:: https://img.shields.io/github/license/cusyio/ai-tutorial.svg
1111
:alt: License
12-
:target: https://github.com/AInvone/Intro-in-KI-Schulung/blob/main/LICENSE
12+
:target: https://github.com/cusyio/ai-tutorial/blob/main/LICENSE
1313

1414
Installation
1515
------------
@@ -18,42 +18,29 @@ Installation
1818

1919
.. code-block:: console
2020
21-
$ git clone https://github.com/AInvone/Intro-in-KI-Schulung.git
22-
$ cd Intro-in-KI-Schulung
21+
$ git clone https://github.com/cusyio/ai-tutorial.git
22+
$ cd ai-tutorial
2323
2424
#. Installieren von Python-Paketen:
2525

26-
… auf Linux/macOS:
27-
2826
.. code-block:: console
2927
30-
$ python3 -m venv .venv
31-
$ . .venv/bin/activate
32-
$ python -m pip install --upgrade pip
33-
$ python -m pip install --group dev
34-
35-
… auf Windows:
36-
37-
.. code-block:: ps1con
28+
$ uv sync --frozen
3829
39-
C:> py -m venv .venv
40-
C:> .\.venv\Scripts\activate.bat
41-
C:> python -m pip install --upgrade pip
42-
C:> python -m pip install --group dev
43-
44-
Für den reinen Dokumentations-Build reicht die Gruppe ``docs``:
30+
Zum Erstellen der Dokumentations wird zusätzlich die Abhängigkeitsgruppe
31+
``docs`` benötigt:
4532

4633
.. code-block:: console
4734
48-
$ python -m pip install --group docs
35+
$ uv sync --frozen --group docs
4936
5037
#. Erstellen der HTML-Dokumentation:
5138

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

5441
.. code-block:: console
5542
56-
$ sphinx-build -b html docs docs/_build/html
43+
$ uv run sphinx-build -b html docs docs/_build/html
5744
5845
Das Ergebnis liegt in ``docs/_build/html/``; die Startseite ist
5946
``docs/_build/html/index.html``.
@@ -90,16 +77,24 @@ Installation
9077
Folgt uns
9178
---------
9279

93-
* `GitHub <https://github.com/AInvone/Intro-in-KI-Schulung>`_
80+
* `GitHub <https://github.com/cusyio/ai-tutorial>`_
9481

9582
Pull-Requests
9683
-------------
9784

9885
Wenn ihr Vorschläge für Verbesserungen und Ergänzungen habt, empfehlen wir euch,
99-
einen `Fork <https://github.com/AInvone/Intro-in-KI-Schulung/fork>`_ unseres
100-
`GitHub Repository <https://github.com/AInvone/Intro-in-KI-Schulung/>`_ zu
101-
erstellen und eure Änderungen dort zu machen. Bevor ihr Commits macht,
102-
überprüft, ob die pre-commit-Checks erfolgreich durchlaufen:
86+
einen `Fork <https://github.com/cusyio/ai-tutorial/fork>`_ unseres `GitHub
87+
Repository <https://github.com/cusyio/ai-tutorial/>`_ zu erstellen und eure
88+
Änderungen dort zu machen.
89+
90+
Die Entwicklungsumgebung könnt ihr erstellen mit
91+
92+
.. code-block:: console
93+
94+
$ uv sync --frozen --group dev
95+
96+
Bevor ihr Commits macht, überprüft, ob die
97+
pre-commit-Checks erfolgreich durchlaufen:
10398

10499
.. code-block:: console
105100

0 commit comments

Comments
 (0)