Iruziky commited on
Commit
8c591ef
·
verified ·
1 Parent(s): 6f47f7e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +59 -3
README.md CHANGED
@@ -1,3 +1,59 @@
1
- ---
2
- license: mit
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language:
3
+ - en
4
+ license: mit
5
+ tags:
6
+ - rag
7
+ - mcp
8
+ - ai-agents
9
+ - lancedb
10
+ - documentation
11
+ - crewai
12
+ - langchain
13
+ - llamaindex
14
+ pretty_name: D4AI
15
+ ---
16
+
17
+ # Docs-ForAI Data 🚀
18
+
19
+ ![Docs-ForAI Banner](https://huggingface.co/datasets/Iruziky/docs-forai-data/resolve/main/Docs-ForAI_banner.png)
20
+
21
+ This dataset contains the pre-computed **LanceDB vector indices** for the [Docs-ForAI](https://github.com/iruziky/Docs-ForAI) project.
22
+
23
+ It provides high-quality RAG (Retrieval-Augmented Generation) context, allowing AI Agents to access verified information from the most popular AI framework documentations without hallucinations.
24
+
25
+ ## 📂 Included Documentations
26
+ This index currently covers:
27
+ 1. **LangGraph**
28
+ 2. **CrewAI**
29
+ 3. **PydanticAI**
30
+ 4. **AutoGen**
31
+ 5. **LlamaIndex**
32
+ 6. **OpenAI Swarm**
33
+ 7. **Phidata**
34
+ 8. **Haystack**
35
+ 9. **PraisonAI**
36
+ 10. **LiteLLM**
37
+
38
+ ## 🛠 Project Integration
39
+ This data is specifically formatted for use with the **Docs-ForAI MCP Server**.
40
+
41
+ To use these indices, clone the main repository and run the setup command:
42
+ ```bash
43
+ # Clone the project
44
+ git clone [https://github.com/iruziky/Docs-ForAI.git](https://github.com/iruziky/Docs-ForAI.git)
45
+ cd Docs-ForAI
46
+
47
+ # Download this dataset automatically
48
+ uv run setup
49
+ ```
50
+
51
+ ### 🧠 Technical Specs
52
+ - **Vector Store:** LanceDB
53
+ - **Embedding Model:** `sentence-transformers/all-MiniLM-L6-v2` (Running locally on CPU)
54
+ - **Content:** This dataset contains only the computed indices (`lancedb_data/`). Raw text files (`docs_input/`) are not included to keep the download efficient.
55
+
56
+ ---
57
+
58
+ ### ⚖️ Legal Disclaimer
59
+ Docs-ForAI is a research and productivity tool. We do not own the documentation content. All rights belong to the respective owners. Our goal is to enhance the developer experience by providing better context to AI models. If you are a copyright holder and want your documentation removed, please open an issue in the [Main GitHub Repository](https://github.com/iruziky/Docs-ForAI).