LawKnowledge

Empezando

Requisitos previos

Infraestuctura

• NX - NX es un conjunto de herramientas de desarrollo extensibles para Monorepos.
• NodeJS - Node.js® es un tiempo de ejecución de JavaScript construido en el motor JavaScript V8 de Chrome.
• PNPM - Administrador de paquetes eficientes de espacio rápido y eficiente en disco.
• Python - Python es un lenguaje de programación que le permite trabajar rápidamente e integrar los sistemas de manera más efectiva.
• Poesía : la poesía te ayuda a declarar, administrar e instalar dependencias de los proyectos de Python, asegurando que tengas la pila adecuada en todas partes.
• Pulumi - Pulumi es una infraestructura administradora, secretos y configuraciones intuitivamente en cualquier nube.
• Docker (Kubernetes habilitado) : Docker es una plataforma abierta para desarrollar, enviar y ejecutar aplicaciones.
• Helm : Helm es la mejor manera de encontrar, compartir y usar software creado para Kubernetes.

Servicios

• AWS : se requiere una cuenta de Amazon Web Services para implementar la infraestructura.
• Huggingface : se requiere una cuenta de Huggingface para descargar y cargar el conjunto de datos y el modelo.

? Recursos de la cara de abrazos

Puede descargar el conjunto de datos desde el siguiente enlace:

• Datos de conocimiento de la ley: el conjunto de datos de Pháp điển y Văn Bản Pháp Luật.
• Modelo de conocimiento de la ley: un modelo ajustado de Phobert.

?configuración

Primero, clone el repositorio de su máquina local:

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

A continuación, navegue al directorio raíz del proyecto e instale las dependencias:

pnpm install --force

Correr

Para el sitio web, puede ejecutar el siguiente comando:

npx nx serve website --prod

Para la API, puede ejecutar el siguiente 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 pasar el modelo, puede ejecutar el siguiente comando:

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

Para configurar la infraestructura, puede ejecutar el siguiente comando:

npx nx up pulumi

Importante

Si desea ejecutar con NX, asegúrese de haber instalado 'poesía' a nivel mundial. La versión de Python debe ser `> = 3.9.1 <= 3.12`.

? Pruebas

Para el sitio web, puede ejecutar el siguiente comando:

npx nx test website-e2e

Para la API, puede ejecutar el siguiente 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 probar el modelo, puede ejecutar el siguiente comando:

npx nx test bert

? Otro

Para ejecutar las herramientas para procesar el conjunto de datos, puede ejecutar el siguiente comando:

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

Para ejecutar documentación, puede ejecutar el siguiente comando:

npx nx serve docs

Para ejecutar el diagrama como código, puede ejecutar el siguiente comando:

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

Algunos scripts útiles:

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

Puede ver el gráfico de dependencia del proyecto ejecutando el siguiente comando:

npx nx dep-graph

Aquí está el gráfico de dependencia del proyecto:

Que contribuye

Pautas contribuyentes

¡Estamos entusiasmados de que esté interesado en contribuir a este proyecto! Antes de enviar su contribución, asegúrese de tomar un momento y leer las siguientes pautas:

Lea nuestras pautas contribuyentes para aprender sobre nuestro proceso de presentación, reglas de codificación y más.

? ¿Quieres ayudar?

¿Quiere informar un error, contribuir con algún código o mejorar la documentación? ¡Excelente! Lea sobre nuestras pautas para contribuir y luego consulte uno de nuestros problemas etiquetados como Ayuda Se busca o un buen primer problema .

? Código de conducta

Ayúdanos a mantener el conocimiento de la ley abierto e inclusivo. Lea y siga nuestro código de conducta.

Apoyo y organización

Licencia

Este proyecto tiene licencia bajo los términos de la licencia MIT.