Skip to content

Commit 9c2c492

Browse files
rmitschRaphael Mitsch
andauthored
docs: Add blog post draft (#252)
* docs: Update readme, agents.md. * docs: Add first draft of blog post. * docs: Second draft of blog post. * docs: Include PyData link in blog post. * chore: Stylize as `sieves` in header elements. * chore: Stylize as Sieves in header elements. * docs: Embed crisis tweet example in docs. * chore: Extend official Python support to >=3.13,<3.14. * chore: Move blog post to docs/. * test: Relax test thresholds. * feat: Allow overwriting track_usage flag for dspy.configure. * docs: Remove top language badge, add Python version badge. * docs: Add images to blog post. * docs: Fix Mermaid diagram. * docs: Fix Mermaid diagram. * docs: Fix Mermaid diagram. * docs: Fix Mermaid diagram. * docs: Rephrase mix-and-match description. * docs: Rephrase mix-and-match description. * docs: Update blog draft. * docs: Update blog draft. * docs: Update blog draft. * docs: Update blog draft. * docs: Update blog draft. * docs: Update blog draft. * docs: Update blog draft. * docs: Update blog draft. * docs: Update blog draft. * fix: Use --clear for venv creation. --------- Co-authored-by: Raphael Mitsch <raphael@climatiq.com>
1 parent cfaf887 commit 9c2c492

14 files changed

Lines changed: 1934 additions & 79 deletions

File tree

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ jobs:
4444
4545
- name: Install Python dependencies
4646
run: |
47-
uv venv .venv --python 3.12
47+
uv venv .venv --python 3.12 --clear
4848
uv build
4949
source .venv/bin/activate
5050
uv pip install ./dist/sieves-*.whl

AGENTS.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# AGENTS.md
22

3-
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
3+
This file provides guidance to LLM agents when working with code in this repository.
44

55
---
66

@@ -49,7 +49,7 @@ AGENTS.md # This file (Claude Code guidelines)
4949

5050
## Installation & Setup
5151

52-
**Python requirement:** 3.12 (exact version required)
52+
**Python requirement:** 3.12 or 3.13 (3.14 not supported yet due to dependency wheels missing)
5353

5454
### Using `uv` (preferred)
5555

@@ -377,7 +377,6 @@ Before proposing changes, ensure:
377377
- **All model libraries** (Outlines, DSPy, LangChain, Transformers, GLiNER2) are **core dependencies**
378378
- Serialization excludes complex third-party objects (models, converters); must pass at load time
379379
- Ingestion tasks may require system packages (Tesseract for OCR, etc.)
380-
- Python 3.12 exact version required (not 3.12+)
381380

382381
---
383382

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212

1313
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/mantisai/sieves/test.yml)](https://github.com/mantisai/sieves/actions/workflows/test.yml)
14-
![GitHub top language](https://img.shields.io/github/languages/top/mantisai/sieves)
14+
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sieves)
1515
[![Version](https://img.shields.io/github/v/release/mantisai/sieves?include_prereleases&label=version)](https://github.com/mantisai/sieves/releases)
1616
![Status](https://img.shields.io/badge/status-beta-blue)
1717
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/ambv/black)
@@ -24,7 +24,7 @@
2424

2525
<br>
2626

27-
## A Unified Interface for Document AI.
27+
## A Unified Interface for Structured Document AI.
2828

2929
`sieves` provides a **framework-agnostic abstraction for building document AI pipelines**.
3030

@@ -89,7 +89,6 @@ to skip having to define tasks from scratch.
8989
```bash
9090
pip install sieves
9191
```
92-
*Requires Python 3.12 (due to dependency constraints in `docling` and `pyarrow`).*
9392

9493
**2. Basic: text classification with a small local model**
9594

docs/assets/pipeline.png

694 KB
Loading

docs/assets/pipeline.svg

Lines changed: 102 additions & 0 deletions
Loading

docs/blog_post.md

Lines changed: 170 additions & 0 deletions
Large diffs are not rendered by default.

docs/examples/crisis_tweets.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Crisis Tweet Analysis
2+
3+
<iframe src="../crisis_tweets_raw.html" width="100%" height="1000px" frameborder="0"></iframe>

docs/img.png

33.3 KB
Loading

mkdocs.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
site_name: sieves
1+
site_name: Sieves
22
site_url: https://sieves.ai/docs
33
docs_dir: docs
44
repo_url: https://github.com/mantisai/sieves
5-
repo_name: "sieves on GitHub"
5+
repo_name: "<code>sieves</code> on GitHub"
66

77
theme:
88
name: material
@@ -93,3 +93,5 @@ nav:
9393
- guides/optimization.md
9494
- guides/distillation.md
9595
- guides/observability.md
96+
- Examples:
97+
- examples/crisis_tweets.md

0 commit comments

Comments
 (0)