Skip to content

Commit 1fec1a0

Browse files
authored
Merge pull request #91 from enoch3712/90-small-change-to-documentation
pointer to examples removed
2 parents 242a5f3 + e3c1cd1 commit 1fec1a0

File tree

9 files changed

+10
-30
lines changed

9 files changed

+10
-30
lines changed

docs/core-concepts/classification/mom.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,5 +93,3 @@ result = process.classify(
9393
- Set appropriate confidence thresholds based on your use case
9494
- Consider using different model providers for better diversity
9595
- Monitor and log classification results for each model
96-
97-
For more examples and advanced usage, check out the [examples directory](examples/) in the repository.

docs/core-concepts/classification/vision.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,5 +98,3 @@ result = process.classify(
9898
image=True
9999
)
100100
```
101-
102-
For more examples and advanced usage, check out the [examples directory](examples/) in the repository.

docs/core-concepts/contracts/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,3 @@ class InvoiceContract(Contract):
3030
```python
3131
--8<-- "extract_thinker/models/contract.py"
3232
```
33-
34-
For more examples and advanced usage, check out the [examples directory](examples/) in the repository.

docs/core-concepts/document-loaders/aws-textract.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,4 @@ The loader returns a dictionary with the following structure:
6868
- Process pages individually for large documents
6969
- Monitor API quotas and costs
7070

71-
For more examples and implementation details, check out the [examples directory](examples/) in the repository.
71+
For more examples and implementation details, check out the [AWS Stack](../../examples/aws-textract) in the repository.

docs/core-concepts/document-loaders/azure-form.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@ Document Intelligence supports `PDF`, `JPEG/JPG`, `PNG`, `BMP`, `TIFF`, `HEIF`,
6161
- Handle tables and paragraphs separately for better accuracy
6262
- Process documents page by page for large files
6363

64-
For more examples and advanced usage, check out the [examples directory](examples/) in the repository.
64+
For more examples and implementation details, check out the [Azure Stack](../../examples/azure-form.md) in the repository.

docs/core-concepts/document-loaders/google-document-ai.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,4 +79,4 @@ with open("document.pdf", "rb") as f:
7979

8080
Document AI supports PDF, TIFF, GIF, JPEG, PNG with a maximum file size of 20MB or 2000 pages.
8181

82-
For more examples and implementation details, check out the [examples directory](examples/) in the repository.
82+
For more examples and implementation details, check out the [Google Stack](../../examples/google-document-ai) in the repository.

docs/core-concepts/document-loaders/tesseract.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@ Document Intelligence supports `PDF`, `JPEG/JPG`, `PNG`, `BMP`, `TIFF`
6161
- Consider image preprocessing for better accuracy
6262
- Set appropriate page segmentation mode based on document layout
6363

64-
For more examples and advanced usage, check out the [examples directory](examples/) in the repository.
64+
For more examples and advanced usage, check out the [Local Stack](../../examples/local-processing) in the repository.

docs/examples/local-processing.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -96,16 +96,4 @@ result = extractor.extract("document.pdf", Contract)
9696
)
9797
except Exception as e:
9898
print(f"Processing error: {e}")
99-
```
100-
101-
## Performance Comparison
102-
103-
| Aspect | Cloud | Local |
104-
|--------|-------|-------|
105-
| Speed | Faster | Depends on hardware |
106-
| Cost | Pay per use | Free |
107-
| Privacy | Data leaves network | Complete privacy |
108-
| Setup | Simple | More complex |
109-
| Maintenance | None | Required |
110-
111-
For more examples and implementation details, check out the [examples directory](https://github.com/enoch3712/ExtractThinker/tree/main/examples) in the repository.
99+
```

docs/getting-started/index.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -67,24 +67,22 @@ print(f"Total: ${result.total_amount}")
6767
<li>
6868
<p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M14 2H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h12c1.1 0 2-.9 2-2V8l-6-6zM6 20V4h7v5h5v11H6z"></path></svg></span> <strong>Extraction with Pydantic</strong></p>
6969
<p>Extract structured data from any document type using Pydantic models for validation, custom features, and prompt engineering capabilities.</p>
70-
<p><a href="../examples/extraction"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><path d="M8.22 2.97a.75.75 0 0 1 1.06 0l4.25 4.25a.75.75 0 0 1 0 1.06l-4.25 4.25a.75.75 0 0 1-1.042-.018.75.75 0 0 1-.018-1.042l2.97-2.97H3.75a.75.75 0 0 1 0-1.5h7.44L8.22 4.03a.75.75 0 0 1 0-1.06"></path></svg></span> Learn More</a></p>
70+
<!-- <p><a href="../examples/extraction"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><path d="M8.22 2.97a.75.75 0 0 1 1.06 0l4.25 4.25a.75.75 0 0 1 0 1.06l-4.25 4.25a.75.75 0 0 1-1.042-.018.75.75 0 0 1-.018-1.042l2.97-2.97H3.75a.75.75 0 0 1 0-1.5h7.44L8.22 4.03a.75.75 0 0 1 0-1.06"></path></svg></span> Learn More</a></p> -->
7171
</li>
7272
<li>
7373
<p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2L4.5 20.29l.71.71L12 18l6.79 3 .71-.71z"></path></svg></span> <strong>Classification & Split</strong></p>
7474
<p>Intelligent document classification and splitting with support for consensus strategies, eager/lazy splitting, and confidence thresholds.</p>
75-
<p><a href="../examples/classification"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><path d="M8.22 2.97a.75.75 0 0 1 1.06 0l4.25 4.25a.75.75 0 0 1 0 1.06l-4.25 4.25a.75.75 0 0 1-1.042-.018.75.75 0 0 1-.018-1.042l2.97-2.97H3.75a.75.75 0 0 1 0-1.5h7.44L8.22 4.03a.75.75 0 0 1 0-1.06"></path></svg></span> Learn More</a></p>
75+
<!-- <p><a href="../examples/classification"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><path d="M8.22 2.97a.75.75 0 0 1 1.06 0l4.25 4.25a.75.75 0 0 1 0 1.06l-4.25 4.25a.75.75 0 0 1-1.042-.018.75.75 0 0 1-.018-1.042l2.97-2.97H3.75a.75.75 0 0 1 0-1.5h7.44L8.22 4.03a.75.75 0 0 1 0-1.06"></path></svg></span> Learn More</a></p> -->
7676
</li>
7777
<li>
7878
<p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 1 3 5v6c0 5.55 3.84 10.74 9 12 5.16-1.26 9-6.45 9-12V5l-9-4zm0 10.99h7c-.53 4.12-3.28 7.79-7 8.94V12H5V6.3l7-3.11v8.8z"></path></svg></span> <strong>PII Detection</strong></p>
7979
<p>Automatically detect and handle sensitive personal information in documents with privacy-first approach and advanced validation.</p>
80-
<p><a href="../examples/pii"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><path d="M8.22 2.97a.75.75 0 0 1 1.06 0l4.25 4.25a.75.75 0 0 1 0 1.06l-4.25 4.25a.75.75 0 0 1-1.042-.018.75.75 0 0 1-.018-1.042l2.97-2.97H3.75a.75.75 0 0 1 0-1.5h7.44L8.22 4.03a.75.75 0 0 1 0-1.06"></path></svg></span> Learn More</a></p>
80+
<!-- <p><a href="../examples/pii"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><path d="M8.22 2.97a.75.75 0 0 1 1.06 0l4.25 4.25a.75.75 0 0 1 0 1.06l-4.25 4.25a.75.75 0 0 1-1.042-.018.75.75 0 0 1-.018-1.042l2.97-2.97H3.75a.75.75 0 0 1 0-1.5h7.44L8.22 4.03a.75.75 0 0 1 0-1.06"></path></svg></span> Learn More</a></p> -->
8181
</li>
8282
<li>
8383
<p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21.7 18.6-6.9-6.9q-.275-.275-.637-.425-.363-.15-.763-.15-.425 0-.787.15-.363.15-.638.425L8.1 15.5q-.275.275-.425.638-.15.362-.15.762 0 .425.15.788.15.362.425.637l6.9 6.9q.275.275.638.425.362.15.787.15.425 0 .788-.15.362-.15.637-.425l4.9-4.9q.275-.275.425-.637.15-.363.15-.788 0-.425-.15-.787-.15-.363-.425-.638Z"></path></svg></span> <strong>LLM and OCR Agnostic</strong></p>
8484
<p>Freedom to choose and switch between different LLM providers and OCR engines based on your needs and cost requirements.</p>
85-
<p><a href="../examples/integrations"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><path d="M8.22 2.97a.75.75 0 0 1 1.06 0l4.25 4.25a.75.75 0 0 1 0 1.06l-4.25 4.25a.75.75 0 0 1-1.042-.018.75.75 0 0 1-.018-1.042l2.97-2.97H3.75a.75.75 0 0 1 0-1.5h7.44L8.22 4.03a.75.75 0 0 1 0-1.06"></path></svg></span> Learn More</a></p>
85+
<!-- <p><a href="../examples/integrations"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><path d="M8.22 2.97a.75.75 0 0 1 1.06 0l4.25 4.25a.75.75 0 0 1 0 1.06l-4.25 4.25a.75.75 0 0 1-1.042-.018.75.75 0 0 1-.018-1.042l2.97-2.97H3.75a.75.75 0 0 1 0-1.5h7.44L8.22 4.03a.75.75 0 0 1 0-1.06"></path></svg></span> Learn More</a></p> -->
8686
</li>
8787
</ul>
88-
</div>
89-
90-
Check out our [advanced usage guide](./advanced-usage.md) for more complex scenarios like document classification, batch processing, and custom LLM integration.
88+
</div>

0 commit comments

Comments
 (0)