LawKnowledge

ابدء

المتطلبات الأساسية

تحتية

• NX - NX هي مجموعة من أدوات DEV القابلة للتمديد لـ Monorepos.
• Nodejs - Node.js® هو وقت تشغيل JavaScript مبني على محرك V8 JavaScript من Chrome.
• PNPM - مدير الحزمة السريع للفضاء.
• Python - Python هي لغة برمجة تتيح لك العمل بسرعة ودمج الأنظمة بشكل أكثر فعالية.
• الشعر - يساعدك الشعر على إعلان وإدارة وتثبيت تبعيات مشاريع Python ، مما يضمن أن يكون لديك المكدس المناسب في كل مكان.
• Pulumi - Pulumi هو إدارة البنية التحتية والأسرار والتكوينات بشكل حدسي على أي سحابة.
• DOCKER (KUBERNETES TENSUMBER) - DOCKER هو منصة مفتوحة لتطوير التطبيقات والشحن وتشغيلها.
• Helm - Helm هي أفضل طريقة للعثور على البرامج ومشاركتها واستخدامها لـ Kubernetes.

خدمات

• AWS - مطلوب حساب Amazon Web Services لنشر البنية التحتية.
• Huggingface - مطلوب حساب LuggingFace لتنزيل وتحميل مجموعة البيانات والنموذج.

؟ الموارد المعانقة

يمكنك تنزيل مجموعة البيانات من الرابط التالي:

• بيانات المعرفة القانونية: مجموعة البيانات من pháp đ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 ، فتأكد من تثبيت "الشعر" على مستوى العالم. يجب أن يكون إصدار 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

هنا هو الرسم البياني التبعي للمشروع:

المساهمة

الإرشادات المساهمة

نحن متحمسون لأنك مهتم بالمساهمة في هذا المشروع! قبل تقديم مساهمتك ، يرجى التأكد من قضاء بعض الوقت وقراءة الإرشادات التالية:

اقرأ من خلال إرشاداتنا المساهمة للتعرف على عملية التقديم الخاصة بنا ، وقواعد الترميز ، والمزيد.

؟ تريد المساعدة؟

هل تريد الإبلاغ عن خطأ ، أو المساهمة ببعض التعليمات البرمجية ، أو تحسين الوثائق؟ ممتاز! اقرأ على إرشاداتنا للمساهمة ثم تحقق من إحدى مشكلاتنا المسمى بالمساعدة المطلوبة أو العدد الأول الجيد .

؟ مدونة لقواعد السلوك

ساعدنا في الحفاظ على معرفة القانون مفتوحة وشاملة. يرجى قراءة واتباع مدونة قواعد السلوك الخاصة بنا.

الدعم والتنظيم

رخصة

هذا المشروع مرخص بموجب شروط ترخيص معهد ماساتشوستس للتكنولوجيا.