valtron-core 0.1.0__tar.gz

valtron_core-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

valtron_core-0.1.0/PKG-INFO

@@ -0,0 +1,248 @@
+Metadata-Version: 2.4
+Name: valtron-core
+Version: 0.1.0
+Summary: LLM call optimization across various providers (online and local models)
+License: Apache-2.0
+License-File: LICENSE
+Author: InferLink
+Author-email: valtron@inferlink.com
+Requires-Python: >=3.12,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: accelerate (>=1.12.0,<2.0.0)
+Requires-Dist: datasets (>=2.14.0,<3.0.0)
+Requires-Dist: flask (>=3.0.0,<4.0.0)
+Requires-Dist: flask-cors (>=4.0.0,<5.0.0)
+Requires-Dist: google-cloud-aiplatform (>=1.129.0,<2.0.0)
+Requires-Dist: google-generativeai (>=0.8.5,<0.9.0)
+Requires-Dist: jinja2 (>=3.1.0,<4.0.0)
+Requires-Dist: litellm (>=1.0.0,<2.0.0)
+Requires-Dist: matplotlib (>=3.8.0,<4.0.0)
+Requires-Dist: nltk (>=3.9.2,<4.0.0)
+Requires-Dist: plotly (>=5.18.0,<6.0.0)
+Requires-Dist: pydantic (>=2.0,<3.0)
+Requires-Dist: pydantic-settings (>=2.0,<3.0)
+Requires-Dist: pydyf (>=0.11.0,<0.12.0)
+Requires-Dist: pylatex (>=1.4.2,<2.0.0)
+Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
+Requires-Dist: rapidfuzz (>=3.14.3,<4.0.0)
+Requires-Dist: requests (>=2.31.0,<3.0.0)
+Requires-Dist: rich (>=13.0.0,<14.0.0)
+Requires-Dist: scikit-learn (>=1.3.0,<2.0.0)
+Requires-Dist: structlog (>=24.0.0,<25.0.0)
+Requires-Dist: torch (>=2.1.0,<3.0.0)
+Requires-Dist: transformers (>=4.35.0,<5.0.0)
+Requires-Dist: typer (>=0.12.0,<0.13.0)
+Requires-Dist: weasyprint (>=62.0,<63.0)
+Project-URL: Documentation, https://valtron.ai/docs/
+Project-URL: Homepage, https://github.com/inferlinkdev/valtron-core/
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+# Valtron Core
+
+[Documentation](https://valtron.ai/docs) · [Quick Start](#quick-start) · [Examples](#examples) · [Contributing](#contributing)
+
+A Python framework for evaluating and optimizing LLM calls across any provider.
+
+Proudly built and backed by [InferLink](https://inferlink.com).
+
+</div>
+
+---
+
+Valtron lets you run the same task across multiple LLMs simultaneously, then compare them on accuracy, cost, and speed. Define a prompt, a labeled dataset, and the models you want to test — Valtron evaluates each one, scores the results, and produces an interactive HTML/PDF report with an AI recommendation.
+
+## Features
+
+- **Multi-model comparison** — run GPT-4o, Claude, Gemini, Llama, and any LiteLLM-compatible model side-by-side on the same dataset
+- **Detailed evaluation** — label classification (string match) and structured extraction (nested JSON with field-level precision/recall/F1)
+- **Prompt optimization** — seven built-in strategies (few-shot generation, chain-of-thought, decomposition, hallucination filtering, and more) applied per model
+- **Cost and latency tracking** — per-document and aggregate cost, response time, and accuracy metrics
+- **HTML and PDF reports** — interactive charts, per-document breakdowns, and an AI-generated recommendation
+- **Transformer training** — train a local DistilBERT classifier from your evaluation data for zero-cost inference
+- **Self-hosted model support** — Ollama, vLLM, LM Studio, and more for free, private inference
+
+## Quick Start
+
+### Prerequisites
+
+- Python 3.12+
+- [Poetry](https://python-poetry.org/) for dependency management
+- Docker (optional)
+
+### Install
+
+```bash
+poetry install
+```
+
+Copy `.env.example` to `.env` and add at least one provider key:
+
+```env
+OPENAI_API_KEY=sk-...
+ANTHROPIC_API_KEY=sk-ant-...
+GOOGLE_API_KEY=...
+```
+
+### Run an evaluation
+
+```python
+from valtron_core.recipes import ModelEval
+
+data = [
+    {"id": "1", "content": "Fast shipping, exactly what I ordered.", "label": "positive"},
+    {"id": "2", "content": "Wrong item sent. Refund process was painful.", "label": "negative"},
+    {"id": "3", "content": "Average experience, nothing special.", "label": "neutral"},
+]
+
+config = {
+    "models": [
+        {"name": "gpt-4o-mini"},
+        {"name": "claude-haiku-4-5-20251001"},
+    ],
+    "prompt": "Classify the sentiment of the following review as positive, negative, or neutral.\n\nReview: {document}\n\nSentiment:",
+    "output_dir": "./results",
+}
+
+experiment = ModelEval(config=config, data=data)
+report_path = experiment.run()
+print(f"Report: {report_path}")
+```
+
+Open `./results/evaluation_report.html` to see accuracy, cost, latency, and a recommendation.
+
+## Configuration
+
+The config accepts a dict, a JSON file path, or a typed `ModelEvalConfig` object. Key fields:
+
+| Field | Required | Description |
+|---|---|---|
+| `models` | Yes | Models to evaluate; each has a `name` and optional `prompt_manipulation` list |
+| `prompt` | Yes | Prompt template containing `{document}` |
+| `output_dir` | No | Where to write results (can also be passed to `run()`) |
+| `few_shot` | No | Settings for few-shot example generation |
+| `output_formats` | No | `["html"]` by default; add `"pdf"` for a PDF report |
+
+**Prompt manipulation options** (set per model via `"prompt_manipulation": [...]`):
+
+- `"explanation"` — add chain-of-thought reasoning before the answer
+- `"few_shot"` — inject generated few-shot examples into the prompt
+- `"decompose"` — split the prompt into sequential sub-calls *(structured extraction only)*
+- `"hallucination_filter"` — drop extracted values not grounded in the source text *(structured extraction only)*
+- `"multi_pass"` — call the model twice and merge results *(structured extraction only)*
+
+See [Config Format](https://valtron.ai/docs/config-format) for the full reference, including field-level metrics, structured extraction, and few-shot settings.
+
+**Prefer a guided setup?** The Configuration Wizard is a browser-based UI that builds your config file step by step:
+
+```bash
+poetry run python -m valtron_core.utilities.config_wizard
+# or with Docker
+docker compose run --rm -p 5000:5000 server poetry run python -m valtron_core.utilities.config_wizard
+```
+
+Open `http://localhost:5000` in your browser.
+
+## Examples
+
+| Script | What it demonstrates |
+|---|---|
+| `examples/sentiment_classification.py` | Label classification across two models |
+| `examples/affiliation_extraction.py` | Structured extraction with field-level metrics |
+| `examples/transformer_comparison.py` | Train a local transformer and compare against cloud LLMs |
+| `examples/multimodal_molecules.py` | Multimodal classification with image attachments |
+| `examples/incremental_evaluation.py` | Load a prior run and add new models without re-evaluating |
+
+```bash
+# Run any example
+poetry run python examples/sentiment_classification.py
+
+# With Docker
+docker compose run --rm server poetry run python examples/sentiment_classification.py
+```
+
+See [Examples](https://valtron.ai/docs/examples/) for detailed walkthroughs.
+
+## Docker
+
+```bash
+# Build the image (first run is slow; installs system dependencies including LaTeX)
+docker compose build server
+
+# Run an example
+docker compose run --rm server poetry run python examples/sentiment_classification.py
+
+# Interactive shell
+docker compose run --rm --service-ports server bash
+
+# Run the test suite
+docker compose run --rm pipeline-test
+```
+
+> **Using Ollama with Docker?** Set `OLLAMA_API_BASE=http://host.docker.internal:11434` in `.env` so the container can reach Ollama running on your host.
+
+## Development
+
+```bash
+# Install dependencies
+poetry install
+
+# Run tests
+poetry run pytest
+
+# Run with coverage
+poetry run pytest --cov=src/valtron_core --cov-report=html
+
+# Format and lint
+poetry run black src/ tests/
+poetry run ruff check src/ tests/
+poetry run mypy src/
+```
+
+The test suite covers the evaluation pipeline, report generation, prompt optimizers, few-shot generation, transformer training, and the `ModelEval` recipe. The Docker Compose `pipeline-test` service runs the full suite with coverage and JUnit XML output.
+
+## Architecture
+
+Valtron is built on [LiteLLM](https://github.com/BerriAI/litellm), which provides a unified interface to 100+ LLM providers. On top of that, Valtron adds the evaluation pipeline, prompt optimization strategies, report generation, and transformer training:
+
+```
+Input data (documents + expected labels)
+    ↓
+Config (models, prompt, optimizations)
+    ↓
+ModelEval.run()
+    ├── Generate few-shot examples (optional)
+    ├── Prepare per-model prompts (apply manipulations)
+    ├── Evaluate all models concurrently
+    ├── Compute metrics (accuracy, cost, time, field scores)
+    └── Generate report (HTML + optional PDF)
+    ↓
+evaluation_report.html  ·  models/*.json  ·  metadata.json
+```
+
+Full documentation lives in [docs/valtron/](https://valtron.ai/docs/intro). To run the docs site locally:
+
+```bash
+cd docs/valtron && docker compose up
+```
+
+Then open `http://localhost:3000`.
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes and run the test suite
+4. Submit a pull request
+
+## License
+
+TBD
+

valtron_core-0.1.0/README.md

@@ -0,0 +1,202 @@
+<div align="center">
+
+# Valtron Core
+
+[Documentation](https://valtron.ai/docs) · [Quick Start](#quick-start) · [Examples](#examples) · [Contributing](#contributing)
+
+A Python framework for evaluating and optimizing LLM calls across any provider.
+
+Proudly built and backed by [InferLink](https://inferlink.com).
+
+</div>
+
+---
+
+Valtron lets you run the same task across multiple LLMs simultaneously, then compare them on accuracy, cost, and speed. Define a prompt, a labeled dataset, and the models you want to test — Valtron evaluates each one, scores the results, and produces an interactive HTML/PDF report with an AI recommendation.
+
+## Features
+
+- **Multi-model comparison** — run GPT-4o, Claude, Gemini, Llama, and any LiteLLM-compatible model side-by-side on the same dataset
+- **Detailed evaluation** — label classification (string match) and structured extraction (nested JSON with field-level precision/recall/F1)
+- **Prompt optimization** — seven built-in strategies (few-shot generation, chain-of-thought, decomposition, hallucination filtering, and more) applied per model
+- **Cost and latency tracking** — per-document and aggregate cost, response time, and accuracy metrics
+- **HTML and PDF reports** — interactive charts, per-document breakdowns, and an AI-generated recommendation
+- **Transformer training** — train a local DistilBERT classifier from your evaluation data for zero-cost inference
+- **Self-hosted model support** — Ollama, vLLM, LM Studio, and more for free, private inference
+
+## Quick Start
+
+### Prerequisites
+
+- Python 3.12+
+- [Poetry](https://python-poetry.org/) for dependency management
+- Docker (optional)
+
+### Install
+
+```bash
+poetry install
+```
+
+Copy `.env.example` to `.env` and add at least one provider key:
+
+```env
+OPENAI_API_KEY=sk-...
+ANTHROPIC_API_KEY=sk-ant-...
+GOOGLE_API_KEY=...
+```
+
+### Run an evaluation
+
+```python
+from valtron_core.recipes import ModelEval
+
+data = [
+    {"id": "1", "content": "Fast shipping, exactly what I ordered.", "label": "positive"},
+    {"id": "2", "content": "Wrong item sent. Refund process was painful.", "label": "negative"},
+    {"id": "3", "content": "Average experience, nothing special.", "label": "neutral"},
+]
+
+config = {
+    "models": [
+        {"name": "gpt-4o-mini"},
+        {"name": "claude-haiku-4-5-20251001"},
+    ],
+    "prompt": "Classify the sentiment of the following review as positive, negative, or neutral.\n\nReview: {document}\n\nSentiment:",
+    "output_dir": "./results",
+}
+
+experiment = ModelEval(config=config, data=data)
+report_path = experiment.run()
+print(f"Report: {report_path}")
+```
+
+Open `./results/evaluation_report.html` to see accuracy, cost, latency, and a recommendation.
+
+## Configuration
+
+The config accepts a dict, a JSON file path, or a typed `ModelEvalConfig` object. Key fields:
+
+| Field | Required | Description |
+|---|---|---|
+| `models` | Yes | Models to evaluate; each has a `name` and optional `prompt_manipulation` list |
+| `prompt` | Yes | Prompt template containing `{document}` |
+| `output_dir` | No | Where to write results (can also be passed to `run()`) |
+| `few_shot` | No | Settings for few-shot example generation |
+| `output_formats` | No | `["html"]` by default; add `"pdf"` for a PDF report |
+
+**Prompt manipulation options** (set per model via `"prompt_manipulation": [...]`):
+
+- `"explanation"` — add chain-of-thought reasoning before the answer
+- `"few_shot"` — inject generated few-shot examples into the prompt
+- `"decompose"` — split the prompt into sequential sub-calls *(structured extraction only)*
+- `"hallucination_filter"` — drop extracted values not grounded in the source text *(structured extraction only)*
+- `"multi_pass"` — call the model twice and merge results *(structured extraction only)*
+
+See [Config Format](https://valtron.ai/docs/config-format) for the full reference, including field-level metrics, structured extraction, and few-shot settings.
+
+**Prefer a guided setup?** The Configuration Wizard is a browser-based UI that builds your config file step by step:
+
+```bash
+poetry run python -m valtron_core.utilities.config_wizard
+# or with Docker
+docker compose run --rm -p 5000:5000 server poetry run python -m valtron_core.utilities.config_wizard
+```
+
+Open `http://localhost:5000` in your browser.
+
+## Examples
+
+| Script | What it demonstrates |
+|---|---|
+| `examples/sentiment_classification.py` | Label classification across two models |
+| `examples/affiliation_extraction.py` | Structured extraction with field-level metrics |
+| `examples/transformer_comparison.py` | Train a local transformer and compare against cloud LLMs |
+| `examples/multimodal_molecules.py` | Multimodal classification with image attachments |
+| `examples/incremental_evaluation.py` | Load a prior run and add new models without re-evaluating |
+
+```bash
+# Run any example
+poetry run python examples/sentiment_classification.py
+
+# With Docker
+docker compose run --rm server poetry run python examples/sentiment_classification.py
+```
+
+See [Examples](https://valtron.ai/docs/examples/) for detailed walkthroughs.
+
+## Docker
+
+```bash
+# Build the image (first run is slow; installs system dependencies including LaTeX)
+docker compose build server
+
+# Run an example
+docker compose run --rm server poetry run python examples/sentiment_classification.py
+
+# Interactive shell
+docker compose run --rm --service-ports server bash
+
+# Run the test suite
+docker compose run --rm pipeline-test
+```
+
+> **Using Ollama with Docker?** Set `OLLAMA_API_BASE=http://host.docker.internal:11434` in `.env` so the container can reach Ollama running on your host.
+
+## Development
+
+```bash
+# Install dependencies
+poetry install
+
+# Run tests
+poetry run pytest
+
+# Run with coverage
+poetry run pytest --cov=src/valtron_core --cov-report=html
+
+# Format and lint
+poetry run black src/ tests/
+poetry run ruff check src/ tests/
+poetry run mypy src/
+```
+
+The test suite covers the evaluation pipeline, report generation, prompt optimizers, few-shot generation, transformer training, and the `ModelEval` recipe. The Docker Compose `pipeline-test` service runs the full suite with coverage and JUnit XML output.
+
+## Architecture
+
+Valtron is built on [LiteLLM](https://github.com/BerriAI/litellm), which provides a unified interface to 100+ LLM providers. On top of that, Valtron adds the evaluation pipeline, prompt optimization strategies, report generation, and transformer training:
+
+```
+Input data (documents + expected labels)
+    ↓
+Config (models, prompt, optimizations)
+    ↓
+ModelEval.run()
+    ├── Generate few-shot examples (optional)
+    ├── Prepare per-model prompts (apply manipulations)
+    ├── Evaluate all models concurrently
+    ├── Compute metrics (accuracy, cost, time, field scores)
+    └── Generate report (HTML + optional PDF)
+    ↓
+evaluation_report.html  ·  models/*.json  ·  metadata.json
+```
+
+Full documentation lives in [docs/valtron/](https://valtron.ai/docs/intro). To run the docs site locally:
+
+```bash
+cd docs/valtron && docker compose up
+```
+
+Then open `http://localhost:3000`.
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes and run the test suite
+4. Submit a pull request
+
+## License
+
+TBD