Files
masterthesis-playground/README.md

41 lines
1.3 KiB
Markdown

# 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.
Verwendung:
```bash
./convert_jupytext.sh py # Jupyter Notebook -> Python
./convert_jupytext.sh nb # Python -> Jupyter Notebook
```
## Weitere Infos
- [README BERTopic](./bertopic/README.md)
- [README RAFT](./raft/README.md)