autodoc

ما هذا؟ • البدء • المجتمع • المساهمة

ما هذا؟

Autodoc عبارة عن مجموعة أدوات تجريبية لإنشاء وثائق قاعدة التعليمات البرمجية تلقائيًا لمستودعات git باستخدام نماذج اللغات الكبيرة، مثل GPT-4 أو Alpaca. يمكن تثبيت Autodoc في الريبو الخاص بك في حوالي 5 دقائق. يقوم بفهرسة قاعدة التعليمات البرمجية الخاصة بك من خلال اجتياز العمق الأول لجميع محتويات المستودع واستدعاء LLM لكتابة الوثائق لكل ملف ومجلد. يمكن دمج هذه المستندات لوصف المكونات المختلفة لنظامك وكيفية عملها معًا.

تتواجد الوثائق التي تم إنشاؤها في قاعدة التعليمات البرمجية الخاصة بك، وتنتقل إلى حيث تنتقل التعليمات البرمجية الخاصة بك. يمكن للمطورين الذين يقومون بتنزيل التعليمات البرمجية الخاصة بك استخدام الأمر doc لطرح أسئلة حول قاعدة التعليمات البرمجية الخاصة بك والحصول على إجابات محددة للغاية مع روابط مرجعية تعود إلى ملفات التعليمات البرمجية.

في المستقبل القريب، ستتم إعادة فهرسة الوثائق كجزء من مسار CI الخاص بك، بحيث تكون محدثة دائمًا. إذا كنت مهتمًا بالعمل والمساهمة في هذا العمل، راجع هذه المشكلة.

حالة

Autodoc في المراحل الأولى من التطوير. إنها عملية، ولكنها ليست جاهزة للاستخدام في الإنتاج. قد تنكسر الأشياء، أو لا تعمل كما هو متوقع. إذا كنت مهتمًا بالعمل على إطار عمل Autodoc الأساسي، فيرجى الاطلاع على المساهمة. نحن نحب أن نحصل على مساعدتكم!

الأسئلة الشائعة

سؤال: لا أحصل على ردود جيدة. كيف يمكنني تحسين جودة الاستجابة؟

الإجابة: Autodoc في المراحل الأولى من التطوير. على هذا النحو، يمكن أن تختلف جودة الاستجابة بشكل كبير بناءً على نوع المشروع الذي قمت بفهرسته وكيفية صياغة الأسئلة. بعض النصائح لكتابة استعلام جيد:

1. كن محددًا في أسئلتك. اطرح أسئلة مثل "ما هي المكونات المختلفة للتفويض في هذا النظام؟" بدلاً من "شرح المصادقة". سيساعد هذا Autodoc على تحديد السياق المناسب للحصول على أفضل إجابة لسؤالك.
2. استخدم جي بي تي-4. يعد GPT-4 أفضل بكثير في فهم التعليمات البرمجية مقارنةً بـ GPT-3.5، وينتقل هذا الفهم إلى كتابة وثائق جيدة أيضًا. إذا لم يكن لديك حق الوصول، قم بالتسجيل هنا.

أمثلة

فيما يلي بعض الأمثلة حول كيفية استخدام Autodoc.

1. Autodoc - يحتوي هذا المستودع على وثائق خاصة به تم إنشاؤها بواسطة Autodoc. إنه موجود في المجلد .autodoc . اتبع الإرشادات هنا لمعرفة كيفية الاستعلام عنها.
2. TolyGPT.com - TolyGPT عبارة عن برنامج دردشة Autodoc تم تدريبه على قاعدة بيانات Solana Validator وتم نشره على الويب لسهولة الوصول إليه. في المستقبل القريب، سيدعم Autodoc إصدار الويب بالإضافة إلى أداة CLI الموجودة.

ابدأ

متطلبات

يتطلب Autodoc الإصدار 18.0.0 من Node أو إصدار أحدث. يوصى باستخدام الإصدار 19.0.0 أو أحدث. تأكد من أنك تقوم بتشغيل الإصدار الصحيح:

$ node -v

مثال الإخراج:

v19.8.1

قم بتثبيت أداة Autodoc CLI كوحدة NPM عالمية:

$ npm install -g @context-labs/autodoc

يقوم هذا الأمر بتثبيت أداة Autodoc CLI التي ستسمح لك بإنشاء فهارس Autodoc والاستعلام عنها.

قم بتشغيل doc لرؤية الأوامر المتاحة.

الاستعلام

يمكنك الاستعلام عن مستودع تم تثبيت Autodoc عبر واجهة سطر الأوامر (CLI). سنستخدم مستودع Autodoc نفسه كمثال لتوضيح كيفية عمل الاستعلام في Autodoc، ولكن قد يكون هذا مستودعك الخاص الذي يحتوي على فهرس.

استنساخ Autodoc وتغيير الدليل للبدء:

$ git clone https://github.com/context-labs/autodoc.git
$ cd autodoc

في الوقت الحالي، يدعم Autodoc OpenAI فقط. تأكد من تصدير مفتاح OpenAI API الخاص بك في جلستك الحالية:

$ export OPENAI_API_KEY= < YOUR_KEY_HERE >

لبدء سطر الأوامر لاستعلام Autodoc، قم بتشغيل:

$ doc q

إذا كانت هذه هي المرة الأولى التي تقوم فيها بتشغيل doc q ، فسوف تحصل على شاشة تطالبك بتحديد نماذج GPT التي يمكنك الوصول إليها. حدد ما هو مناسب لمستوى الوصول الخاص بك. إذا لم تكن متأكدًا، حدد الخيار الأول:

أنت الآن جاهز للاستعلام عن الوثائق الخاصة بمستودع Autodoc:

هذه هي تجربة الاستعلام الأساسية. إنه أساسي للغاية الآن، مع وجود مجال كبير للتحسين. إذا كنت مهتمًا بتحسين تجربة استعلام Autodoc CLI، فاطلع على هذه المشكلة.

الفهرسة

اتبع الخطوات أدناه لإنشاء وثائق لمستودعك الخاص باستخدام Autodoc.

قم بتغيير الدليل إلى جذر مشروعك:

 cd $PROJECT_ROOT

تأكد من أن مفتاح OpenAI API الخاص بك متاح في الجلسة الحالية:

$ export OPENAI_API_KEY= < YOUR_KEY_HERE >

قم بتشغيل الأمر init :

 doc init

سيُطلب منك إدخال اسم مشروعك، وعنوان URL لـ GitHub، وتحديد نماذج GPT التي يمكنك الوصول إليها. إذا لم تكن متأكدًا من الطرازات التي يمكنك الوصول إليها، فحدد الخيار الأول. يمكنك أيضًا تحديد مطالبات ملف/دليل GPT الخاصة بك والتي سيتم استخدامها لتلخيص/تحليل كود repo. سيقوم هذا الأمر بإنشاء ملف autodoc.config.json في جذر مشروعك لتخزين القيم. يجب أن يتم إيداع هذا الملف في git.

ملاحظة: لا تتخطى إدخال هذه القيم وإلا فقد لا تعمل الفهرسة.

التكوين الفوري: ستجد توجيهات سريعة محددة في prompts.ts ، مع إمكانية تخصيص بعض المقتطفات في الملف autodoc.config.json . تركز المطالبات الحالية على المطورين وتفترض أن الريبو الخاص بك يركز على التعليمات البرمجية. سيكون لدينا المزيد من القوالب المرجعية في المستقبل.

قم بتشغيل أمر index :

doc index

يجب أن تشاهد شاشة مثل هذه:

تقوم هذه الشاشة بتقدير تكلفة فهرسة المستودع الخاص بك. يمكنك أيضًا الوصول إلى هذه الشاشة عبر أمر doc estimate . إذا قمت بالفعل بفهرستها مرة واحدة، فسيقوم doc index بإعادة فهرسة الملفات التي تم تغييرها في المرة الثانية فقط.

بالنسبة لكل ملف في مشروعك، يقوم Autodoc بحساب عدد الرموز المميزة في الملف بناءً على محتوى الملف. كلما زاد عدد أسطر التعليمات البرمجية، زاد عدد الرموز المميزة. باستخدام هذا الرقم، فإنه يحدد النموذج الذي سيستخدمه على أساس كل ملف، ويختار دائمًا النموذج الأرخص الذي يدعم طول سياقه عدد الرموز المميزة في الملف. إذا كنت مهتمًا بالمساعدة في جعل تحديد النموذج قابلاً للتكوين في Autodoc، فراجع هذه المشكلة.

ملاحظة: تعني استراتيجية اختيار النموذج الساذجة هذه أنه سيتم توثيق الملفات التي تقل قيمتها عن 4000 رمز مميز باستخدام GPT-3.5، مما سيؤدي إلى توثيق أقل دقة. نوصي باستخدام GPT-4 8K كحد أدنى. تؤدي الفهرسة باستخدام GPT-4 إلى إنتاج أفضل بكثير. يمكنك التقدم بطلب للوصول هنا.

بالنسبة للمشاريع الكبيرة، يمكن أن تصل التكلفة إلى عدة مئات من الدولارات. عرض أسعار OpenAI هنا.

وفي المستقبل القريب، سندعم النماذج ذاتية الاستضافة، مثل Llama وAlpaca. اقرأ هذه المشكلة إذا كنت مهتمًا بالمساهمة في هذا العمل.

عند الانتهاء من فهرسة المستودع الخاص بك، يجب أن تشاهد شاشة مثل هذه:

يمكنك الآن الاستعلام عن تطبيقك باستخدام الخطوات الموضحة في الاستعلام.

مجتمع

هناك مجموعة صغيرة منا تعمل بدوام كامل على Autodoc. انضم إلينا على Discord، أو تابعنا على Twitter للحصول على التحديثات. سنقوم بالنشر بانتظام ونستمر في تحسين تطبيق Autodoc. هل تريد المساهمة؟ اقرأ أدناه.

المساهمة

باعتبارنا مشروعًا مفتوح المصدر في مجال سريع التطور، فإننا منفتحون للغاية على المساهمات، سواء كان ذلك في شكل ميزة جديدة أو تحسين البنية التحتية أو توثيق أفضل.

للحصول على معلومات مفصلة حول كيفية المساهمة، انظر هنا.