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许可证的条款获得许可的。