LawKnowledge

はじめる

前提条件

異束

• NX -NXは、Monorepos用の拡張可能な開発ツールのセットです。
• nodejs -node.js®は、ChromeのV8 JavaScriptエンジンに基づいて構築されたJavaScriptランタイムです。
• PNPM-高速、ディスクスペース効率の良いパッケージマネージャー。
• Python -Pythonは、迅速に作業し、システムをより効果的に統合できるプログラミング言語です。
• 詩- 詩は、Pythonプロジェクトの依存関係を宣言、管理、インストールし、どこにでも適切なスタックを確保するのに役立ちます。
• Pulumi -Pulumiは、どのクラウドでもインフラストラクチャ、秘密、構成を直感的に管理しています。
• Docker（Kubernetes Enabled） -Dockerは、アプリケーションの開発、出荷、および実行のためのオープンプラットフォームです。
• ヘルム- ヘルムは、Kubernetes用に構築されたソフトウェアを見つけ、共有し、使用する最良の方法です。

サービス

• AWS-インフラストラクチャを展開するには、Amazon Web Servicesアカウントが必要です。
• Huggingface -DatasetとModelをダウンロードしてアップロードするには、Huggingfaceアカウントが必要です。

？ハギングフェイスリソース

次のリンクからデータセットをダウンロードできます。

• 法律の知識データ：PhápHinandvænbảnphápluậtからのデータセット。
• 法律知識モデル：Phobertの微調整モデル。

？設定

まず、リポジトリをローカルマシンにクローンします。

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

次に、プロジェクトのルートディレクトリに移動し、依存関係をインストールします。

pnpm install --force

ランニング

Webサイトでは、次のコマンドを実行できます。

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`でなければなりません。

？テスト

Webサイトでは、次のコマンドを実行できます。

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ライセンスの条件に基づいてライセンスされています。