mirror of
https://github.com/marvinscham/masterthesis-playground.git
synced 2026-03-22 08:22:43 +01:00
Cleanup old stuff
This commit is contained in:
29
README.md
29
README.md
@@ -1,14 +1,35 @@
|
||||
# Masterthesis, praktischer Anteil
|
||||
|
||||
## Setup
|
||||
|
||||
Im Rootverzeichnis des Repositories enthält ein Skript zum Aufsetzen der Entwicklungsumgebung.
|
||||
|
||||
Hinweis: Die Entwicklung fand auf einem Linux-System statt, keine Garantie für Funktion auf Windows-Systemen.
|
||||
|
||||
Prozessschritte des Skripts:
|
||||
|
||||
- "Dehydrierung" (Jupyter Notebook zu Python file) wird als pre-commit Git-Hook aufgesetzt
|
||||
- BERTopic wird aufgesetzt
|
||||
- Virtuelle Umgebung wird aufgesetzt
|
||||
- Alle Abhängigkeiten werden installiert und heruntergeladen
|
||||
- RAFT wird aufgesetzt
|
||||
- Virtuelle Umgebung wird aufgesetzt
|
||||
- Alle Abhängigkeiten werden installiert und heruntergeladen
|
||||
- Alle dehydrierten Jupyter Notebooks (nb\_\*.py) werden rehydriert
|
||||
|
||||
Aufruf:
|
||||
|
||||
```bash
|
||||
./setup.sh
|
||||
```
|
||||
|
||||
## Jupyter Notebooks "rehydrieren"
|
||||
|
||||
Damit keine unnötigen Jupyter Outputs etc. im Versionsmanagement landen, gibt es das Skript `convert_jupytext.sh`, welches nur den notwendigen Quelltext in ein `.py` File schreibt. Mit demselben Skript kann dieser Schritt wieder umgekehrt werden, also ein Jupyter Notebook aus dem Python-File geschrieben werden.
|
||||
|
||||
Das Skript sollte also immer vor dem Committen von Änderungen mit `py` als erstes Argument ausgeführt werden.
|
||||
|
||||
Verwendung:
|
||||
|
||||
```bash
|
||||
./convert_jupytext.sh py # Jupyter Notebook -> Python
|
||||
./convert_jupytext.sh nb # Python -> Jupyter Notebook
|
||||
./convert_jupytext.sh py # Jupyter Notebook -> Python
|
||||
./convert_jupytext.sh nb # Python -> Jupyter Notebook
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user