LawKnowledge

入門

先決條件

不屈服

• NX -NX是一組用於MonorePos的可擴展開發工具。
• Nodejs -node.js®是建立在Chrome的V8 JavaScript引擎上的JavaScript運行時。
• PNPM-快速，磁盤空間效率的軟件包管理器。
• Python -Python是一種編程語言，可讓您快速工作並更有效地集成系統。
• 詩歌- 詩歌可幫助您聲明，管理和安裝Python項目的依賴性，以確保您到處都有正確的堆棧。
• Pulumi -Pulumi是在任何云上直觀的管理基礎架構，秘密和配置。
• Docker（啟用Kubernetes） - Docker是開發，運輸和運行應用程序的開放平台。
• Helm -Helm是查找，共享和使用為Kubernetes構建的軟件的最佳方法。

服務

• AWS-部署基礎架構需要一個Amazon Web服務帳戶。
• HuggingFace -HuggingFace帳戶需要下載和上傳數據集和模型。

？擁抱面資源

您可以從以下鏈接下載數據集：

• 法律知識數據：來自pháp的數據集和vănbảnphápluậ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一起運行，請確保您在全球範圍內安裝了``詩''。 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許可證的條款獲得許可的。