LawKnowledge Download - LawKnowledge Source code download

LawKnowledge

Other source code

v0.2.0-rc

Download

Getting Started

Prerequisites

Infrastucture

Nx - Nx is a set of extensible dev tools for monorepos.
Nodejs - Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.
pnpm - Fast, disk space efficient package manager.
Python - Python is a programming language that lets you work quickly and integrate systems more effectively.
Poetry - Poetry helps you declare, manage and install dependencies of Python projects, ensuring you have the right stack everywhere.
Pulumi - Pulumi is a manage infrastructure, secrets, and configurations intuitively on any cloud.
Docker (Kubernetes Enabled) - Docker is an open platform for developing, shipping, and running applications.
Helm - Helm is the best way to find, share, and use software built for Kubernetes.

Services

AWS - An Amazon Web Services account is required to deploy the infrastructure.
HuggingFace - A HuggingFace account is required to download and upload the dataset and model.

? HuggingFace Resources

You can download the dataset from the following link:

Law Knowledge Data: The dataset from Pháp điển and Văn bản pháp luật.
Law Knowledge Model: A fine-tuned model from PhoBERT.

?‍ Setup

First, clone the repository to your local machine:

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

Next, navigate to the root directory of the project and install the dependencies:

pnpm install --force

Running

For the website, you can run the following command:

npx nx serve website --prod

For the API, you can run the following command:

# 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

To traning the model, you can run the following command:

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

To set up the infrastructure, you can run the following command:

npx nx up pulumi

Important

If you want to run with Nx, make sure you have installed `poetry` globally. Python version must be `>=3.9.1 <=3.12`.

? Testing

For the website, you can run the following command:

npx nx test website-e2e

For the API, you can run the following command:

# 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

To test the model, you can run the following command:

npx nx test bert

? Other

To run the tooling for processing the dataset, you can run the following command:

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

For running documentation, you can run the following command:

npx nx serve docs

For running the Diagram as Code, you can run the following command:

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

Some useful scripts:

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

Dependency Graph

You can see the dependency graph of the project by running the following command:

npx nx dep-graph

Here is the dependency graph of the project:

Contributing

Contributing Guidelines

We are excited that you are interested in contributing to this project! Before submitting your contribution, please make sure to take a moment and read through the following guidelines:

Read through our contributing guidelines to learn about our submission process, coding rules, and more.

? Want to Help?

Want to report a bug, contribute some code, or improve the documentation? Excellent! Read up on our guidelines for contributing and then check out one of our issues labeled as help wanted or good first issue.