autodoc

นี่คืออะไร? • เริ่มต้น • ชุมชน • มีส่วนร่วม

นี่คืออะไร?

Autodoc เป็นชุดเครื่องมือ ทดลอง สำหรับการสร้างเอกสารฐานโค้ดที่สร้างอัตโนมัติสำหรับที่เก็บ git โดยใช้โมเดลภาษาขนาดใหญ่ เช่น GPT-4 หรือ Alpaca สามารถติดตั้ง Autodoc ใน repo ของคุณได้ภายในเวลาประมาณ 5 นาที โดยจะจัดทำดัชนีโค้ดเบสของคุณผ่านการสำรวจเนื้อหาที่เก็บทั้งหมดโดยเจาะลึกก่อน และเรียก LLM ให้เขียนเอกสารประกอบสำหรับแต่ละไฟล์และโฟลเดอร์ เอกสารเหล่านี้สามารถนำมารวมกันเพื่ออธิบายส่วนประกอบต่างๆ ของระบบของคุณ และวิธีการทำงานร่วมกัน

เอกสารที่สร้างขึ้นจะอยู่ในโค้ดเบสของคุณและเดินทางไปในที่ที่โค้ดของคุณเดินทางไป นักพัฒนาที่ดาวน์โหลดโค้ดของคุณสามารถใช้คำสั่ง doc เพื่อถามคำถามเกี่ยวกับโค้ดเบสของคุณและรับคำตอบที่เจาะจงสูงพร้อมลิงก์อ้างอิงกลับไปยังไฟล์โค้ด

ในอนาคตอันใกล้นี้ เอกสารต่างๆ จะได้รับการจัดทำดัชนีใหม่โดยเป็นส่วนหนึ่งของไปป์ไลน์ CI ของคุณ ดังนั้นจึงเป็นข้อมูลล่าสุดอยู่เสมอ หากคุณสนใจที่จะร่วมสนับสนุนงานนี้ โปรดดูปัญหานี้

สถานะ

Autodoc อยู่ในช่วงเริ่มต้นของการพัฒนา ใช้งานได้แต่ไม่พร้อมสำหรับการใช้งานจริง สิ่งต่างๆ อาจพังหรือไม่ทำงานตามที่คาดไว้ หากคุณสนใจที่จะทำงานกับเฟรมเวิร์กหลักของ Autodoc โปรดดูการมีส่วนร่วม เราอยากจะขอความช่วยเหลือจากคุณ!

คำถามที่พบบ่อย

คำถาม: ฉันไม่ได้รับคำตอบที่ดี ฉันจะปรับปรุงคุณภาพการตอบกลับได้อย่างไร

คำตอบ: Autodoc อยู่ในช่วงเริ่มต้นของการพัฒนา ด้วยเหตุนี้ คุณภาพการตอบกลับจึงอาจแตกต่างกันอย่างมาก โดยขึ้นอยู่กับประเภทของโครงการที่คุณจัดทำดัชนีและวิธีการใช้ถ้อยคำของคำถาม เคล็ดลับเล็กๆ น้อยๆ ในการเขียนข้อความค้นหาที่ดี:

1. เจาะจงกับคำถามของคุณ ถามสิ่งต่างๆ เช่น "องค์ประกอบต่างๆ ของการอนุญาตในระบบนี้มีอะไรบ้าง" แทนที่จะ "อธิบายการรับรองความถูกต้อง" สิ่งนี้จะช่วยให้ Autodoc เลือกบริบทที่เหมาะสมเพื่อให้ได้คำตอบที่ดีที่สุดสำหรับคำถามของคุณ
2. ใช้ GPT-4 GPT-4 เข้าใจโค้ดได้ดีกว่ามากเมื่อเทียบกับ GPT-3.5 และความเข้าใจนี้ยังนำไปใช้ในการเขียนเอกสารที่ดีอีกด้วย หากคุณไม่สามารถเข้าถึงได้ ลงทะเบียนที่นี่

ตัวอย่าง

ด้านล่างนี้คือตัวอย่างเล็กๆ น้อยๆ ของวิธีการใช้ Autodoc

1. Autodoc - พื้นที่เก็บข้อมูลนี้มีเอกสารสำหรับตัวมันเอง ซึ่งสร้างโดย Autodoc มันอยู่ในโฟลเดอร์ . .autodoc ทำตามคำแนะนำที่นี่เพื่อเรียนรู้วิธีสืบค้น
2. TolyGPT.com - TolyGPT เป็นแชทบอท Autodoc ที่ได้รับการฝึกอบรมเกี่ยวกับโค้ดเบสตรวจสอบความถูกต้องของ Solana และปรับใช้กับเว็บเพื่อให้เข้าถึงได้ง่าย ในอนาคตอันใกล้นี้ Autodoc จะสนับสนุนเวอร์ชันเว็บเพิ่มเติมจากเครื่องมือ CLI ที่มีอยู่

เริ่มต้นเลย

ความต้องการ

Autodoc ต้องใช้ Node v18.0.0 หรือสูงกว่า แนะนำให้ใช้เวอร์ชัน 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 >

หากต้องการเริ่ม CLI แบบสอบถาม 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 ในรากของโปรเจ็กต์ของคุณเพื่อจัดเก็บค่า ไฟล์นี้ควรเช็คอินเพื่อคอมไพล์

หมายเหตุ: อย่าข้ามการป้อนค่าเหล่านี้ ไม่เช่นนั้นการสร้างดัชนีอาจไม่ทำงาน

การกำหนดค่าพร้อมท์: คุณจะพบคำแนะนำพร้อมท์ที่ระบุใน prompts.ts โดยมีตัวอย่างบางส่วนที่ปรับแต่งได้ใน autodoc.config.json ข้อความแจ้งปัจจุบันมุ่งเน้นไปที่นักพัฒนาและถือว่า repo ของคุณเน้นโค้ด เราจะมีเทมเพลตอ้างอิงเพิ่มเติมในอนาคต

รันคำสั่ง index :

doc index

คุณควรเห็นหน้าจอดังนี้:

หน้าจอนี้จะประมาณค่าใช้จ่ายในการจัดทำดัชนีพื้นที่เก็บข้อมูลของคุณ คุณยังสามารถเข้าถึงหน้าจอนี้ผ่านคำสั่ง doc estimate หากคุณเคยสร้างดัชนีไว้แล้วครั้งหนึ่ง doc index จะทำดัชนีเฉพาะไฟล์ที่มีการเปลี่ยนแปลงในครั้งที่สองเท่านั้น

สำหรับทุกไฟล์ในโปรเจ็กต์ของคุณ Autodoc จะคำนวณจำนวนโทเค็นในไฟล์ตามเนื้อหาไฟล์ ยิ่งโค้ดมีบรรทัดมากเท่าใด จำนวนโทเค็นก็จะยิ่งมากขึ้นเท่านั้น การใช้ตัวเลขนี้จะกำหนดว่าจะใช้โมเดลใดต่อไฟล์ โดยเลือกโมเดลที่ถูกที่สุดซึ่งความยาวบริบทรองรับจำนวนโทเค็นในไฟล์เสมอ หากคุณสนใจที่จะช่วยกำหนดค่าการเลือกโมเดลใน Autodoc โปรดดูปัญหานี้

หมายเหตุ: กลยุทธ์การเลือกโมเดลที่ไร้เดียงสานี้หมายความว่าไฟล์ที่มีโทเค็น ~4,000 โทเค็นจะได้รับการจัดทำเอกสารโดยใช้ GPT-3.5 ซึ่งจะส่งผลให้เอกสารประกอบมีความแม่นยำน้อยลง เราขอแนะนำให้ใช้ GPT-4 8K เป็นอย่างน้อย การทำดัชนีด้วย GPT-4 ส่งผลให้ได้ผลลัพธ์ที่ดีขึ้นอย่างมาก คุณสามารถสมัครเพื่อเข้าถึงได้ที่นี่

สำหรับโครงการขนาดใหญ่ ค่าใช้จ่ายอาจสูงถึงหลายร้อยเหรียญสหรัฐ ดูราคา OpenAI ที่นี่

ในอนาคตอันใกล้นี้ เราจะรองรับโมเดลที่โฮสต์เอง เช่น ลามะ และอัลปาก้า อ่านฉบับนี้หากคุณสนใจที่จะมีส่วนร่วมในงานนี้

เมื่อพื้นที่เก็บข้อมูลของคุณได้รับการจัดทำดัชนีแล้ว คุณจะเห็นหน้าจอดังนี้:

ตอนนี้คุณสามารถสืบค้นแอปพลิเคชันของคุณโดยใช้ขั้นตอนที่ระบุไว้ในการสืบค้น

ชุมชน

มีพวกเรากลุ่มเล็กๆ ที่ทำงานเต็มเวลากับ Autodoc เข้าร่วมกับเราบน Discord หรือติดตามเราบน Twitter เพื่อรับข้อมูลอัปเดต เราจะโพสต์เป็นประจำและปรับปรุงแอปพลิเคชัน Autodoc อย่างต่อเนื่อง ต้องการที่จะมีส่วนร่วม? อ่านด้านล่าง

มีส่วนร่วม

ในฐานะโครงการโอเพ่นซอร์สในสาขาที่มีการพัฒนาอย่างรวดเร็ว เรายินดีอย่างยิ่งที่จะมีส่วนร่วม ไม่ว่าจะเป็นในรูปแบบของคุณสมบัติใหม่ อินฟาเรดที่ได้รับการปรับปรุง หรือเอกสารประกอบที่ดีขึ้น

สำหรับข้อมูลโดยละเอียดเกี่ยวกับวิธีการมีส่วนร่วม โปรดดูที่นี่