LawKnowledge

Começando

Pré -requisitos

Infrastutura

• NX - NX é um conjunto de ferramentas de desenvolvimento extensível para monorepos.
• Nodejs - Node.js® é um tempo de execução JavaScript criado no mecanismo JavaScript V8 do Chrome.
• PNPM - Gerenciador de pacotes eficiente e eficiente em disco.
• Python - Python é uma linguagem de programação que permite trabalhar rapidamente e integrar sistemas com mais eficiência.
• Poesia - A poesia ajuda você a declarar, gerenciar e instalar dependências de projetos Python, garantindo que você tenha a pilha certa em todos os lugares.
• Pulumi - Pulumi é uma infraestrutura de gerenciamento, segredos e configurações intuitivamente em qualquer nuvem.
• Docker (Kubernetes ativado) - O Docker é uma plataforma aberta para o desenvolvimento, envio e execução de aplicativos.
• Helm - Helm é a melhor maneira de encontrar, compartilhar e usar o software criado para Kubernetes.

Serviços

• AWS - Uma conta da Amazon Web Services é necessária para implantar a infraestrutura.
• Huggingface - Uma conta Huggingface é necessária para baixar e fazer upload do conjunto de dados e modelo.

? Recursos de Huggingface

Você pode baixar o conjunto de dados do seguinte link:

• Dados de conhecimento da lei: o conjunto de dados de Pháp điển e Văn Bản Pháp Luật.
• Modelo de conhecimento da lei: um modelo de ajuste fino da Phobert.

?configurar

Primeiro, clone o repositório para sua máquina local:

git clone https://github.com/foxminchan/LawKnowledge

Em seguida, navegue até o diretório raiz do projeto e instale as dependências:

pnpm install --force

Correndo

Para o site, você pode executar o seguinte comando:

npx nx serve website --prod

Para a API, você pode executar o seguinte comando:

 # For the API Gateway
npx nx serve api-gateway --prod

# For the Auth Service
npx nx serve auth-svc --prod

# For the Law Service
npx nx serve law-svc --prod

# For the Search Service, navigate to the search-svc directory
npx nx build search-svc && cd apps/api/search-svc/search-svc && python main.py

# For the Chat Service, navigate to the chat-svc directory
npx nx build chat-svc && cd apps/api/chat-svc/chat-svc && python main.py

Para transmitir o modelo, você pode executar o seguinte comando:

npx nx build bert && cd apps/nlp/bert/bert && python main.py

Para configurar a infraestrutura, você pode executar o seguinte comando:

npx nx up pulumi

Importante

Se você deseja executar com o NX, certifique -se de instalar o `poesia 'globalmente. A versão python deve ser `> = 3.9.1 <= 3.12`.

? Teste

Para o site, você pode executar o seguinte comando:

npx nx test website-e2e

Para a API, você pode executar o seguinte comando:

 # For the Auth Service
npx nx test auth-svc-e2e

# For the Law Service
npx nx test law-svc-e2e

# For the Search Service
npx nx test search-svc-e2e

# For the Chat Service
npx nx test chat-svc

Para testar o modelo, você pode executar o seguinte comando:

npx nx test bert

? Outro

Para executar a ferramenta para processar o conjunto de dados, você pode executar o seguinte comando:

npx nx build processor && cd apps/nlp/processor/processor && python main.py

Para a documentação em execução, você pode executar o seguinte comando:

npx nx serve docs

Para executar o diagrama como código, você pode executar o seguinte comando:

npx nx build dac && cd assets/dac/dac && python main.py

Alguns scripts úteis:

 # Navigate to the scripts directory
cd tools/scripts && ls

# + scripts
# +-- build.sh --> Build the project
# +-- clean.sh --> Clean the docker image
# +-- init.sh --> Initialize the project
# +-- prepare.sh --> Prepare the project
# +-- start.sh --> Start the project
# +-- start-o11y.sh --> Start the observability stack
# +-- stop-o11y.sh --> Stop the observability stack

# Run the script
./ < script-name >

Gráfico de dependência

Você pode ver o gráfico de dependência do projeto executando o seguinte comando:

npx nx dep-graph

Aqui está o gráfico de dependência do projeto:

Contribuindo

Diretrizes contribuintes

Estamos empolgados por você estar interessado em contribuir para este projeto! Antes de enviar sua contribuição, não deixe de levar um momento e ler as seguintes diretrizes:

Leia nossas diretrizes contribuintes para aprender sobre nosso processo de envio, regras de codificação e muito mais.

? Quer ajudar?

Deseja relatar um bug, contribuir com algum código ou melhorar a documentação? Excelente! Leia nossas diretrizes para contribuir e, em seguida, confira um de nossos problemas rotulados como ajuda de ajuda ou boa primeira edição .

? Código de Conduta

Ajude -nos a manter o conhecimento da lei aberto e inclusivo. Leia e siga nosso código de conduta.

Apoio e organização

Licença

Este projeto está licenciado nos termos da licença do MIT.