revAIsor

Este é um aplicativo que será o seu revisor de artigos.

Pré-requisitos

Python 3.10 ou superior instalado
poetry (gerenciador de pacotes Python)

Como executar o aplicativo

Clone o repositório para sua máquina local:

git clone https://github.com/seu_usuario/nome_do_repositorio.git
cd nome_do_repositorio

Certifique-se de que o Poetry esteja instalado. Caso não esteja, siga o tutorial de como instalar o poetry
Instale as dependências do projeto com o Poetry:

poetry install

Inicialize o ambiente virtual do Poetry (se ainda não estiver ativado) com o seguinte comando:

poetry shell

Crie um arquivo .env na raiz do projeto seguindo o modelo do arquivo .env.example e preencha com as informações necessárias.

OPENAI_API_KEY="sua_chave_de_api"
LLAMA2_API_URL="sua_url_da_api"

Agora que o ambiente virtual está ativo, você pode executar o aplicativo Streamlit normalmente usando o comando streamlit run:

streamlit run app.py

O aplicativo será iniciado e abrirá automaticamente uma página no navegador.

Estrutura do projeto

app.py: Este é o arquivo principal do aplicativo que contém o código do projeto;
requirements.txt: Este arquivo contém as dependências do projeto;
interfaces/gpt/interface.py: Este arquivo contém a classe que faz a interface com a API da OpenAI;
interfaces/llama2/interface.py: Este arquivo contém a classe que faz a interface com a API da Meta;
interfaces/base.py: Este arquivo contém a classe abstrata herdada pela interface dos dois modelos;
utils/__init__.py: Este arquivo alguns métodos utilizados por todas as classes;
README.md: Este arquivo com instruções sobre como executar o aplicativo.

Contribuição

Sinta-se à vontade para contribuir com melhorias, correções de bugs ou adição de novos recursos. Basta abrir uma issue ou enviar um pull request.

Licença

Este projeto está licenciado sob a MIT License.

Agradecimentos

Este aplicativo foi desenvolvido com base na biblioteca Streamlit. Agradecimentos à equipe do Streamlit por criar uma ferramenta tão útil e fácil de usar.