LawKnowledge

Commencer

Condition préalable

Infrastration

• NX - NX est un ensemble d'outils de développement extensibles pour Monorepos.
• Nodejs - Node.js® est un runtime JavaScript construit sur le moteur JavaScript V8 de Chrome.
• PNPM - Gestionnaire de package rapide et disque et disque.
• Python - Python est un langage de programmation qui vous permet de travailler rapidement et d'intégrer les systèmes plus efficacement.
• Poésie - La poésie vous aide à déclarer, gérer et installer les dépendances des projets Python, en vous garantissant que vous avez la bonne pile partout.
• Pulumi - Pulumi est une infrastructure, des secrets et des configurations de gestion intuitivement sur n'importe quel nuage.
• Docker (Kubernetes activé) - Docker est une plate-forme ouverte pour les applications de développement, d'expédition et d'exécution.
• HELM - HELM est le meilleur moyen de trouver, de partager et d'utiliser des logiciels construits pour Kubernetes.

Services

• AWS - Un compte Amazon Web Services est nécessaire pour déployer l'infrastructure.
• HuggingFace - Un compte HuggingFace est nécessaire pour télécharger et télécharger l'ensemble de données et le modèle.

? Ressources de câlins

Vous pouvez télécharger l'ensemble de données à partir du lien suivant:

• Données sur les connaissances en droit: l'ensemble de données de Pháp điển et Văn Bản Pháp Luật.
• Modèle de connaissances en droit: un modèle affiné de Phobert.

?installation

Tout d'abord, clonez le référentiel de votre machine locale:

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

Ensuite, accédez au répertoire racine du projet et installez les dépendances:

pnpm install --force

En cours d'exécution

Pour le site Web, vous pouvez exécuter la commande suivante:

npx nx serve website --prod

Pour l'API, vous pouvez exécuter la commande suivante:

 # 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

Pour transmettre le modèle, vous pouvez exécuter la commande suivante:

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

Pour configurer l'infrastructure, vous pouvez exécuter la commande suivante:

npx nx up pulumi

Important

Si vous souhaitez fonctionner avec NX, assurez-vous d'avoir installé la «poésie» dans le monde. La version Python doit être `> = 3.9.1 <= 3.12`.

? Essai

Pour le site Web, vous pouvez exécuter la commande suivante:

npx nx test website-e2e

Pour l'API, vous pouvez exécuter la commande suivante:

 # 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

Pour tester le modèle, vous pouvez exécuter la commande suivante:

npx nx test bert

? Autre

Pour exécuter l'outillage pour le traitement de l'ensemble de données, vous pouvez exécuter la commande suivante:

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

Pour l'exécution de la documentation, vous pouvez exécuter la commande suivante:

npx nx serve docs

Pour exécuter le diagramme en tant que code, vous pouvez exécuter la commande suivante:

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

Quelques scripts utiles:

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

Graphique de dépendance

Vous pouvez voir le graphique de dépendance du projet en exécutant la commande suivante:

npx nx dep-graph

Voici le graphique de dépendance du projet:

Contributif

Lignes directrices contributives

Nous sommes ravis que vous soyez intéressé à contribuer à ce projet! Avant de soumettre votre contribution, assurez-vous de prendre un moment et de lire les directives suivantes:

Lisez nos lignes directrices contributives pour en savoir plus sur notre processus de soumission, les règles de codage, etc.

? Vous voulez aider?

Vous voulez signaler un bogue, contribuer du code ou améliorer la documentation? Excellent! Lisez nos lignes directrices pour contribuer, puis consultez l'un de nos problèmes étiquetés comme une aide recherchée ou un bon problème .

? Code de conduite

Aidez-nous à garder les connaissances en droit ouvertes et inclusives. Veuillez lire et suivre notre code de conduite.

Soutien et organisation

Licence

Ce projet est concédé sous licence de la licence du MIT.