anekameni commited on
Commit
4a9aa3a
Β·
1 Parent(s): e7ac6dd

Update README.md to enhance project overview, key features, and integration recommendations

Browse files
Files changed (1) hide show
  1. README.md +52 -1
README.md CHANGED
@@ -11,4 +11,55 @@ license: apache-2.0
11
  short_description: Medivocate is an AI-driven platform leveraging Retrieval-Aug
12
  ---
13
 
14
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
  short_description: Medivocate is an AI-driven platform leveraging Retrieval-Aug
12
  ---
13
 
14
+ # Medivocate
15
+
16
+ An AI-driven platform empowering users with trustworthy, personalized history guidance to combat misinformation and promote equitable history.
17
+
18
+ ## Follows us [here](https://github.com/KameniAlexNea/medivocate)
19
+
20
+ * [**Alex Kameni**](https://www.linkedin.com/in/elie-alex-kameni-ngangue/)
21
+ * [**Esdras Fandio**](https://www.linkedin.com/in/esdras-fandio/)
22
+ * [**Patric Zeufack**](https://www.linkedin.com/in/zeufack-patric-hermann-7a9256143/)
23
+
24
+ ## Project Overview
25
+
26
+ **Medivocate** is structured for modular development and ease of scalability, as seen in its directory layout:
27
+
28
+ ```
29
+ πŸ“¦ ./
30
+ β”œβ”€β”€ πŸ“ docs/
31
+ β”œβ”€β”€ πŸ“ src/
32
+ β”‚ β”œβ”€β”€ πŸ“ ocr/
33
+ β”‚ β”œβ”€β”€ πŸ“ preprocessing/
34
+ β”‚ β”œβ”€β”€ πŸ“ chunking/
35
+ β”‚ β”œβ”€β”€ πŸ“ vector_store/
36
+ β”‚ β”œβ”€β”€ πŸ“ rag_pipeline/
37
+ β”‚ β”œβ”€β”€ πŸ“ llm_integration/
38
+ β”‚ └── πŸ“ prompt_engineering/
39
+ β”œβ”€β”€ πŸ“ tests/
40
+ β”‚ β”œβ”€β”€ πŸ“ unit/
41
+ β”‚ └── πŸ“ integration/
42
+ β”œβ”€β”€ πŸ“ examples/
43
+ β”œβ”€β”€ πŸ“ notebooks/
44
+ β”œβ”€β”€ πŸ“ config/
45
+ β”œβ”€β”€ πŸ“„ README.md
46
+ β”œβ”€β”€ πŸ“„ CONTRIBUTING.md
47
+ β”œβ”€β”€ πŸ“„ requirements.txt
48
+ β”œβ”€β”€ πŸ“„ .gitignore
49
+ └── πŸ“„ LICENSE
50
+ ```
51
+
52
+ ### Key Features
53
+
54
+ 1. **Trustworthy Information Access** : Using RAG (Retrieval-Augmented Generation) pipelines to deliver fact-based responses.
55
+ 2. **Advanced Document Handling** : Leveraging OCR, preprocessing, and chunking for scalable document ingestion.
56
+ 3. **Integrated Tools** : Supports integration with vector databases (e.g., Chroma), LLMs, and advanced prompt engineering techniques.
57
+
58
+ ### Recommendations for Integration
59
+
60
+ * **Groq** : Utilize Groq APIs for free-tier LLM support, perfect for prototyping RAG applications.
61
+ * **LangChain + LangSmith** : Build and monitor intelligent agents with LangChain and enhance debugging and evaluation using LangSmith.
62
+ * **Hugging Face Datasets** : For one-liner dataset loading and preprocessing, supporting efficient ML training pipelines.
63
+ * **Search Index** : Include Chroma for robust semantic search capabilities in RAG.
64
+
65
+ This modular design and extensive integration make Medivocate a powerful tool for historical education and research.