Skip to content

Commit e2344f3

Browse files
update readme
1 parent fc3d962 commit e2344f3

1 file changed

Lines changed: 24 additions & 1 deletion

File tree

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,19 @@ Production-minded Python components and recipes (cookbook) by Inference Stack.
1010

1111
ElectriPy Studio is a curated collection of production-ready Python components and recipes designed to accelerate development while maintaining high code quality standards.
1212

13+
## Design principles
14+
15+
- Ports & Adapters: swap providers (LLMs, embedders, vector stores) without rewriting business logic.
16+
- Deterministic by default: stable IDs and reproducible evaluation runs.
17+
- Safe logging posture: avoid leaking prompts/responses; prefer hashes + redaction seams.
18+
- Typed, production APIs: small public surfaces, strict typing, structured outputs where it matters.
19+
- Testability: unit tests are offline and deterministic by default (no network required).
20+
1321
## Status & recent updates
1422

1523
- **Last updated**: 2026-03-04
1624
- **Maturity**: Early alpha (APIs may still evolve), but core components, CLI, concurrency primitives, and first AI building blocks are in place.
25+
- **Versioning**: SemVer begins at `v0.x` — expect breaking changes until `v1.0`.
1726
- **Recent highlights**:
1827
- Added an LLM Gateway for provider-agnostic LLM calls with structured output and safety seams.
1928
- Added a RAG Evaluation Runner and `electripy rag eval` CLI for benchmarking retrieval quality over JSONL datasets.
@@ -87,6 +96,17 @@ for record in read_jsonl("output.jsonl"):
8796
print(record)
8897
```
8998

99+
### AI quick start (LLM + RAG eval)
100+
101+
- Run a basic RAG evaluation over JSONL datasets:
102+
103+
```bash
104+
electripy rag eval --corpus data/corpus.jsonl --queries data/queries.jsonl \
105+
--top-k 3,5,10 --report-json out/report.json
106+
```
107+
108+
- LLM Gateway usage (offline-friendly fake provider example): see recipes/02_llm_gateway/.
109+
90110
## Documentation
91111

92112
Full documentation is available in the [docs/](docs/) directory:
@@ -98,7 +118,7 @@ Full documentation is available in the [docs/](docs/) directory:
98118
- [I/O Utilities](docs/user-guide/io.md)
99119
- [CLI Guide](docs/user-guide/cli.md)
100120
- [LLM Gateway & AI](docs/user-guide/ai-llm-gateway.md)
101-
- [RAG Evaluation Runner](src/electripy/ai/rag_eval_runner/README.md)
121+
- [RAG Evaluation Runner](src/electripy/ai/rag_eval_runner/README.md) (TODO: mirror this page into docs/user-guide/ai-rag-eval-runner.md)
102122
- [Recipes](docs/recipes/cli-tool.md)
103123
- [API Reference](docs/api.md)
104124

@@ -128,6 +148,9 @@ electripy-studio/
128148
│ ├── concurrency/ # Retry & rate limiting
129149
│ ├── io/ # JSONL utilities
130150
│ └── cli/ # CLI commands
151+
│ └── ai/ # AI building blocks (LLM + RAG)
152+
│ ├── llm_gateway/ # Provider-agnostic LLM client + structured output helpers
153+
│ └── rag_eval_runner/# Dataset + eval runner + CLI benchmarking
131154
├── tests/ # Test suite
132155
├── docs/ # Documentation
133156
├── recipes/ # Example recipes

0 commit comments

Comments
 (0)