thesis2024

Tese de mestre 2024 em agosto semrau

Este projeto funciona com o LLMS. Mais informações serão atualizadas à medida que o progresso for feito.
O prazo para a tese é 22 de junho de 2024.

Configurar

Para configurar o projeto, execute os seguintes comandos:

 # 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 . 

Chave da API OpenAI

Para usar a API OpenAI, você precisa definir a variável de ambiente OpenAI_API_KEY, assim:

 export OPENAI_API_KEY= < your key here > 

Dados

Para criar o conjunto de dados relevante, você precisa:

1. Faça o download dos dados brutos e coloque -os na pasta Data/Raw. Um link para os dados brutos será fornecido posteriormente.
2. Execute o seguinte comando na pasta raiz (tese2024):

python src/thesis2024/datamodules/make_dataset.py

Isso converterá todos os dados brutos em uma loja de vetores usando o Chroma.

Executando o código

O primeiro protótipo de chatbot pode ser executado usando o seguinte comando da pasta root (tese2024):

streamlit run src/thesis2024/models/chatbot_v1.py

Estrutura do projeto

A estrutura do diretório do projeto se parece com o seguinte:

├── 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