LawKnowledge

Начиная

Предварительные условия

Инфрастура

• NX - NX - это набор расширяемых инструментов DEV для MonorePos.
• Nodejs - Node.js® - это время выполнения JavaScript, построенное на двигателе JavaScript Chrome V8.
• PNPM - быстрое, дисковое пространство -эффективное диспетчер пакетов.
• Python - Python - это язык программирования, который позволяет вам работать быстро и более эффективно интегрировать системы.
• Поэзия - Поэзия помогает вам объявлять, управлять и устанавливать зависимости от проектов Python, гарантируя, что у вас есть правильный стек везде.
• Pulumi - Pulumi - это управление инфраструктурой, секретами и конфигурациями интуитивно в любом облаке.
• Docker (Kubernetes включен) - Docker - это открытая платформа для разработки, доставки и запуска приложений.
• Helm - Helm - лучший способ найти, поделиться и использовать программное обеспечение, созданное для Kubernetes.

Услуги

• AWS - для развертывания инфраструктуры необходима учетная запись Amazon Web Services.
• HuggingFace - для загрузки и загрузки набора данных и модели требуется учетная запись HuggingFace.

? Ресурсы для объятий

Вы можете скачать набор данных по следующей ссылке:

• Данные о знаниях права: набор данных от Phap điển и Văn Bản Pháp luật.
• Модель знания права: тонкая модель от Phobert.

?настраивать

Во -первых, клонировать хранилище в местной машине:

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

Затем перейдите в корневой каталог проекта и установите зависимости:

pnpm install --force

Бег

Для веб -сайта вы можете запустить следующую команду:

npx nx serve website --prod

Для API вы можете запустить следующую команду:

 # 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

Чтобы обрести модель, вы можете запустить следующую команду:

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

Чтобы настроить инфраструктуру, вы можете запустить следующую команду:

npx nx up pulumi

Важный

Если вы хотите запустить с NX, убедитесь, что вы установили `Poetry» во всем мире. Версия Python должна быть `> = 3.9.1 <= 3.12`.

? Тестирование

Для веб -сайта вы можете запустить следующую команду:

npx nx test website-e2e

Для API вы можете запустить следующую команду:

 # 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

Чтобы проверить модель, вы можете запустить следующую команду:

npx nx test bert

? Другой

Чтобы запустить инструмент для обработки набора данных, вы можете запустить следующую команду:

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

Для запуска документации вы можете запустить следующую команду:

npx nx serve docs

Для запуска диаграммы в качестве кода, вы можете запустить следующую команду:

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

Некоторые полезные сценарии:

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

График зависимости

Вы можете увидеть график зависимости проекта, выполнив следующую команду:

npx nx dep-graph

Вот график зависимости проекта:

Внося

Внесение руководящих принципов

Мы рады, что вы заинтересованы в участии в этом проекте! Перед тем, как отправить свой вклад, пожалуйста, убедитесь, что прочитайте следующие рекомендации:

Прочитайте наши рекомендации, чтобы узнать о нашем процессе отправки, правилах кодирования и многого другого.

? Хотите помочь?

Хотите сообщить об ошибке, внести какой -то код или улучшить документацию? Отличный! Прочитайте наши рекомендации по внесению вклад, а затем проверьте одну из наших проблем, помеченных как помощь , или хорошую первую проблему .

? Нормы поведения

Помогите нам сохранить знания в области права открытыми и инклюзивными. Пожалуйста, прочитайте и следуйте нашему кодексу поведения.

Поддержка и организация

Лицензия

Этот проект лицензирован в соответствии с условиями лицензии MIT.