diff --git a/README.rst b/README.rst index 4b7838d..03ea5de 100644 --- a/README.rst +++ b/README.rst @@ -4,15 +4,15 @@ Schnelleinstieg Status ------ -.. image:: https://img.shields.io/github/contributors/cusyio/neural-network-tutorial.svg +.. image:: https://img.shields.io/github/contributors/cusyio/ai-tutorial.svg :alt: Contributors - :target: https://github.com/cusyio/neural-network-tutorial/graphs/contributors -.. image:: https://img.shields.io/github/license/cusyio/neural-network-tutorial.svg + :target: https://github.com/cusyio/ai-tutorial/graphs/contributors +.. image:: https://img.shields.io/github/license/cusyio/ai-tutorial.svg :alt: License - :target: https://github.com/cusyio/neural-network-tutorial/blob/main/LICENSE -.. image:: https://readthedocs.org/projects/neural-network-tutorial/badge/?version=latest + :target: https://github.com/cusyio/ai-tutorial/blob/main/LICENSE +.. image:: https://readthedocs.org/projects/ai-tutorial/badge/?version=latest :alt: Docs - :target: https://neural-network-tutorial.readthedocs.io/de/latest/ + :target: https://ai-tutorial.readthedocs.io/de/latest/ Installation ------------ @@ -21,7 +21,7 @@ Installation .. code-block:: console - $ git clone git@github.com:AInvone/Intro-in-KI-Schulung.git + $ git clone git@github.com:cusyio/ai-tutorial.git #. Installieren von Python-Paketen: @@ -100,18 +100,18 @@ Installation Folgt uns --------- -* `GitHub `_ +* `GitHub `_ Pull-Requests ------------- Wenn ihr Vorschläge für Verbesserungen und Ergänzungen habt, empfehlen wir euch, -einen `Fork `_ unseres -`GitHub Repository `_ zu +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: .. code-block:: console - $ cd neural-network-tutorial + $ cd ai-tutorial $ pre-commit install diff --git a/docs/conf.py b/docs/conf.py index cca9fb2..82ccdfb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,7 +29,7 @@ # The master toctree document. master_doc = "index" -project = "KI Schulung" +project = "AI-Tutorial" author = "Min Ye, Veit Schiele" copyright = f"2025, {author}" @@ -130,9 +130,9 @@ latex_documents = [ ( master_doc, - "NeuralNetworkTutorial.tex", - "Neural Network Tutorial", - "Min Ye", + "AITutorial.tex", + "AI-Tutorial", + "Min Ye \\and Veit Schiele", "manual", ), ] diff --git a/docs/index.rst b/docs/index.rst index 78c444b..957d129 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,13 +1,13 @@ -======================= -Einführung in KI -======================= +=========== +AI-Tutorial +=========== -Die Schulung "Einführung in KI" ermöglicht euch einen praxisnahen Einstieg in KI mit Python. +Das :abbr:`AI (Artificial intelligence, engl.: Künstliche Intelligenz)`-Tutorial +möchte euch einen praxisnahen Einstieg in `Künstliche Intelligenz +`_ mit Python +ermöglichen. -Die Schulung ist aufgebaut in 4 Blöcken und hat folgende Hauptbestandteile: - -Alle Tutorials dienen als Seminarunterlagen für unsere aufeinander abgestimmten -Trainings: +Das Tutorial ist aufgebaut in vier Blöcken und hat folgende Hauptbestandteile: +---------------+-----------------------------------------------------------------------------+ | Dauer | Titel | @@ -21,6 +21,18 @@ Trainings: | Tag 4 | `Generative KI - Einführung` | +---------------+-----------------------------------------------------------------------------+ +Es ist Teil einer Reihe von Tutorials zur Datenanalyse und -visualisierung: + +* `Python Basics `_ +* `Jupyter-Tutorial `_ +* `Python für Data Science `_ +* `PyViz-Tutorial `_ +* `cusy Design-System: Datenvisualisierung + `_ + +Alle Tutorials dienen als Seminarunterlagen für unsere aufeinander abgestimmten +Trainings: + .. _`Einführung in Python`: https://cusy.io/de/unsere-schulungsangebote/einfuehrung-in-python .. _`Fortgeschrittenes Python`: @@ -54,13 +66,6 @@ Trainings: .. _`Neues aus Python für Data-Science`: https://cusy.io/de/unsere-schulungsangebote/neues-aus-python-fuer-data-science -Zusatzmaterialien: -* `Python Basics `_ -* `Jupyter-Tutorial `_ -* `Python für Data Science `_ -* `PyViz-Tutorial `_ -* `cusy Design-System: Datenvisualisierung `_ - .. toctree:: :hidden: :titlesonly: diff --git a/pyproject.toml b/pyproject.toml index 90a8719..6adb2af 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,5 +1,5 @@ [project] -name = "neural-network-tutorial" +name = "ai-tutorial" version = "24.1.0" authors = [ { name="Min Ye", email="minye.epfl@gmail.com" }, @@ -45,14 +45,14 @@ docs = [ ] dev = [ - "neural-network-tutorial[docs]", + "ai-tutorial[docs]", "pre-commit", "codespell", ] [project.urls] -"Homepage" = "https://github.com/cusyio/neural-network-tutorial/" -"Bug Tracker" = "https://github.com/cusyio/neural-network-tutorial/issues" +"Homepage" = "https://github.com/cusyio/ai-tutorial/" +"Bug Tracker" = "https://github.com/cusyio/ai-tutorial/issues" [tool.codespell] skip = "*.rst, *.svg"