project setup: pyproject.toml, deps, tooling
Configure Python project with pydantic, structlog, typer, rich dependencies. Set up ruff, mypy, pytest tooling with strict type checking.
This commit is contained in:
50
readme.md
Normal file
50
readme.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# Veritext
|
||||
|
||||
Semantic text validation framework for Python.
|
||||
|
||||
Validates text outputs against quality criteria using metrics like BLEU, ROUGE,
|
||||
and semantic similarity. Designed for developers building systems that produce
|
||||
text (chatbots, content generators, summarisation tools) who need automated
|
||||
quality assurance beyond simple string matching.
|
||||
|
||||
## Status
|
||||
|
||||
Under active development. See [changelog.md](changelog.md) for progress.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
pip install veritext
|
||||
|
||||
# With semantic similarity support
|
||||
pip install veritext[semantic]
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
```python
|
||||
from veritext import validators as v
|
||||
from veritext.core.types import ValidationContext
|
||||
|
||||
# Create validators
|
||||
validator = v.all_of([
|
||||
v.bleu(min_score=0.7),
|
||||
v.length(max_chars=500),
|
||||
])
|
||||
|
||||
# Validate text
|
||||
context = ValidationContext(reference="The cat sat on the mat.")
|
||||
result = validator.check("A cat is sitting on the mat.", context)
|
||||
|
||||
if not result.passed:
|
||||
print(result.failure_summary)
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Project Plan](docs/project-plan.md)
|
||||
- [Implementation Plan](docs/implementation-plan.md)
|
||||
|
||||
## Licence
|
||||
|
||||
MIT
|
||||
Reference in New Issue
Block a user