Skip to content

Commit 306fa52

Browse files
author
sun
committed
docs: update index.md with refined descriptions
1 parent 918d8c3 commit 306fa52

1 file changed

Lines changed: 22 additions & 19 deletions

File tree

docs/index.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,48 @@
11
# 🔬 Compileo: The Ultimate AI-Powered Document Processing & Dataset Engineering Suite
22

3-
**Compileo** is an enterprise-grade, modular platform designed to transform raw, unstructured data into high-quality, structured intelligence. Whether you're processing 1,000-page medical PDFs, scraping JavaScript-heavy websites, or engineering datasets for LLM fine-tuning and personal study, Compileo provides a unified, AI-driven lifecycle for the modern data era.
3+
**Compileo** is a modular platform designed to process, analyze, structure, and generate data. Whether you're processing 1,000 page PDFs, scraping JavaScript heavy websites, or engineering datasets for LLM fine-tuning and personal study, Compileo provides a unified, AI-driven lifecycle for the modern data era.
44

55
---
66

77
## 🌟 What can Compileo do?
88

9-
Compileo isn't just a parser—it's a comprehensive **data engineering ecosystem**. It automates the complex journey from "Messy Source" to Validated, Categorized Intelligence."
9+
Compileo isn't just a parser—it's a comprehensive **data engineering ecosystem**. It automates the complex journey from "Messy Source" to Validated Structured Data.
1010

1111
### 📖 Multi-Source Knowledge Consolidation
12-
Imagine you have several thick textbooks and want to create a specialized dataset focused only on **disease treatments**. Compileo can:
12+
Imagine you have several thick textbooks and want to create a specialized dataset focused on **disease treatments** and **symptoms**. Compileo can:
1313
1. **Ingest** all books simultaneously (PDF, DOCX, etc.).
14-
2. **Discover** a unified "Treatment" taxonomy across all sources automatically.
15-
3. **Extract** every mention of treatments, dosages, and contraindications with high precision.
14+
2. **Discover** unified **"Treatment"** and **"Symptom"** taxonomies across all sources automatically.
15+
3. **Extract** every mention of treatments, dosages, clinical manifestations, and so on for its associated taxonomy for each disease.
1616
4. **Consolidate** this into one unified, high-quality Q&A dataset for training or study.
1717

1818
### 🕹️ Three Ways to Work
1919
Compileo is designed for every workflow:
20-
* **Web GUI**: A user-friendly Streamlit interface with a 7-step guided wizard.
21-
* **REST API**: Seamlessly integrate dataset generation into your own applications.
22-
* **CLI**: Automate heavy-duty processing with powerful command-line parameters.
20+
* **Web GUI**: A user friendly Streamlit interface including a 7 step guided wizard and .
21+
* **REST API**: Seamlessly integrate data processing, chunking, NER, extraction, and dataset generation into your own applications.
22+
* **CLI**: Automate heavy duty processing with powerful command line parameters.
2323

2424
---
2525

2626
## 🚀 Features
2727

2828
### 📄 Intelligent Document Processing & AI-Assisted Chunking
29-
* **Massive PDF Autonomy**: Automatically splits 1,000+ page documents into manageable segments with **semantic overlaps**, ensuring LLM token limits are never hit while preserving context.
30-
* **Two-Pass VLM Parsing**: Employs a "Skim and Extract" methodology using Vision-Language Models (Grok, Gemini, Ollama) to first understand document layout and then extract high-fidelity Markdown.
31-
* **AI-Assisted Strategy Recommendation**: Don't guess how to split your data. Describe your goal (e.g., *"I want to extract detailed surgical procedures"*), and Compileo's AI will analyze your documents to recommend the optimal **Semantic**, **Token**, or **Schema-based** chunking strategy.
29+
* **Massive PDF Autonomy**: Automatically splits 1,000+ page documents into manageable segments with intelligent context-aware chunking ensuring LLM token limits are never hit while preserving context.
30+
* **Two-Pass VLM Parsing**: Employs a "Skim and Extract" methodology using Vision Language Models (Grok, Gemini, ChatGPT, Huggingface, Ollama) to first understand document layout and then extract high-fidelity Markdown.
31+
* **AI-Assisted Chunking**: Want to chunk your book by chapter but each chapter has a different title? You can instruct AI how to chunk it (Each Chapter starts with... I need you to split the document at this point) or ask AI to advise you about the best strategy for chunking (This is the pattern that start each chapter. Which splitting strategy should I use?). Compileo's AI will analyze your documents, pattern examples, and your splitting goal to recommend the optimal **Semantic**, **Character**, **Token**, **Delimiter** or **Schema-based** chunking strategy.
3232

3333
### 🧠 Semantic Data Engineering
34-
* **AI-Assisted Taxonomy**: Don't waste weeks defining categories. Compileo's **Smart Sampling** selects representative content to suggest and build hierarchical knowledge trees automatically.
34+
* **AI-Assisted Taxonomy**: Don't waste weeks defining categories. Compileo can build hierarchical knowledge trees automatically based on your goals. You can also manually define some categories and let Compileo extend them.
3535
* **Multi-Stage Extraction**: Performs **Hierarchical Classification**, moving from coarse-grained categories to fine-grained entities based on your custom or generated taxonomy.
36-
* **Context-Aware NER**: Uses parent context during extraction to disambiguate entities and discover deep relationships between concepts.
36+
* **Context-Aware NER or Full Text**: Uses parent context during extraction to disambiguate entities and discover deep relationships between concepts, then extract name entities or full text.
3737

3838
### 🧪 Advanced Quality Control & Evaluation
39-
* **AI Confidence Scoring**: Every extracted entity and relationship is assigned an **AI confidence level** (0.0 - 1.0), allowing you to filter for only the most reliable data.
39+
* **Two-step AI Confidence Scoring**: Every extracted entity and relationship is assigned an **AI confidence level** (0.0 - 1.0), allowing you to filter for only the most reliable data.
4040
* **Deep Quality Metrics**: Automated scoring for **Lexical Diversity**, **Demographic Bias**, **Answer Coherence**, and **Target Audience Alignment** via the `datasetqual` module.
4141
* **Fine-Tuned Model Testing**: Use the `benchmarking` module to evaluate how your **fine-tuned models** perform on your custom datasets using industry-standard metrics (Accuracy, F1, BLEU, ROUGE) and suites like GLUE or MMLU.
4242

4343
### 🔌 Developer Extensibility
44-
* **Robust Plugin System**: Effortlessly extend Compileo by adding custom **Ingestion Handlers**, **Dataset Formatters**, or **API Routers** via a simple `.zip` package architecture.
45-
* **Custom Exports**: Out-of-the-box support for **Anki** export, allowing you to turn any technical document into a high-quality study deck.
44+
* **Robust Plugin System**: Effortlessly extend Compileo by adding custom plugins via a simple `.zip` package architecture.
45+
* **Custom Exports**: Out-of-the-box support for **Scrapy** URL Scraping and **Anki** flashcard export, allowing you to turn any technical document into a high quality study deck.
4646

4747
---
4848

@@ -53,9 +53,9 @@ The fastest way to deploy the full stack (API, GUI, and Redis).
5353

5454
1. **Clone & Prepare**:
5555
```bash
56-
git clone https://github.com/your-org/compileo.git
56+
git clone https://github.com/SunPCSolutions/Compileo.git
5757
cd compileo
58-
cp .env.example .env # Add your API keys for Gemini, Grok, etc.
58+
cp .env.example .env # Configure COMPILEO_API_KEYS (optional - can also be set via GUI after deployment)
5959
```
6060
2. **Launch**:
6161
```bash
@@ -119,5 +119,8 @@ Ideal for local development, CLI automation, or custom integrations.
119119
* [Plugin Development Guide](docs/developers/plugin_development_guide.md): Learn how to build your own extensions.
120120
* [CLI Reference](docs/userGuide/documentscli.md): Automate workflows via the command line.
121121

122+
---
123+
122124
## 📄 License
123-
[Insert License Information]
125+
Apache-2.0 license
126+
---

0 commit comments

Comments
 (0)