thesis2024

Masterarbeit 2024 bis August Semrau

Dieses Projekt funktioniert mit LLMs. Weitere Informationen werden aktualisiert, wenn Fortschritte erzielt werden.
Die Abschlussfrist für die These ist der 22. Juni 2024.

Aufstellen

Führen Sie die folgenden Befehle aus, um das Projekt einzurichten:

 # Clone the repository
git clone https://github.com/augustsemrau/thesis2024.git

# Create virtual environment
make create_environment

# Activate virtual environment
conda activate src

# Install dependencies
make requirements

# Install dev dependencies
make requirements_dev

# pip install the project
pip install -e . 

OpenAI -API -Schlüssel

Um die OpenAI -API zu verwenden, müssen Sie die Umgebungsvariable openai_api_key wie so festlegen:

 export OPENAI_API_KEY= < your key here > 

Daten

Um den relevanten Datensatz zu erstellen, müssen Sie:

1. Laden Sie die Rohdaten herunter und platzieren Sie sie in den Ordner Data/RAW. Ein Link für die Rohdaten wird später bereitgestellt.
2. Führen Sie den folgenden Befehl aus dem Root -Ordner (Thesis2024) aus:

python src/thesis2024/datamodules/make_dataset.py

Dadurch werden alle Rohdaten mit Chroma in einen Vektorspeicher umwandelt.

Ausführen des Codes

Der erste Chatbot -Prototyp kann mit dem folgenden Befehl aus dem Root -Ordner (Thesis2024) ausgeführt werden:

streamlit run src/thesis2024/models/chatbot_v1.py

Projektstruktur

Die Verzeichnisstruktur des Projekts sieht so aus:

├── Makefile             <- Makefile with convenience commands like `make data` or `make train`
├── README.md            <- The top-level README for developers using this project.
├── data
│   ├── processed        <- The final, canonical data sets for modeling.
│   └── raw              <- The original, immutable data dump.
│
├── docs                 <- Documentation folder
│   │
│   ├── index.md         <- Homepage for your documentation
│   │
│   ├── mkdocs.yml       <- Configuration file for mkdocs
│   │
│   └── source/          <- Source directory for documentation files
│
├── models               <- Trained and serialized models, model predictions, or model summaries
│
├── notebooks            <- Jupyter notebooks.
│
├── pyproject.toml       <- Project configuration file
│
├── reports              <- Generated analysis as HTML, PDF, LaTeX, etc.
│   └── figures          <- Generated graphics and figures to be used in reporting
│
├── requirements.txt     <- The requirements file for reproducing the analysis environment
|
├── requirements_dev.txt <- The requirements file for reproducing the analysis environment
│
├── tests                <- Test files
│
├── src/thesis2024  <- Source code for use in this project.
│   │
│   ├── __init__.py      <- Makes folder a Python module
│   │
│   ├── datamodules      <- Scripts to download or generate data
│   │   ├── __init__.py
│   │   └── make_dataset.py
│   │
│   ├── models           <- model implementations, training script and prediction script
│   │   ├── __init__.py
│   │   ├── model.py
│   │
│   ├── visualization    <- Scripts to create exploratory and results oriented visualizations
│   │   ├── __init__.py
│   │   └── visualize.py
│   ├── train_model.py   <- script for training the model
│   └── predict_model.py <- script for predicting from a model
│
└── LICENSE              <- Open-source license if one is chosen