# {{ repo_name }}

> Generated by **Sherpa-ML** — preset: `{{ preset }}`, framework: `{{ framework }}`.

<p align="left">
  <img alt="Python" src="https://img.shields.io/badge/Python-3.10%20|%203.11%20|%203.12-blue">
  <img alt="License" src="https://img.shields.io/badge/License-{{ license | replace('-', '%2D') }}-green">
  <img alt="CI" src="https://img.shields.io/badge/CI-GitHub%20Actions-{{ 'active' if ci else 'inactive' }}">
</p>

## Quickstart

```
python -m venv .venv && . .venv/bin/activate  # Windows: .venv\Scripts\activate
pip install -e .[dev]
pytest -q
python -m {{ pkg }}.train
````

{% if tracking_mlflow -%}
Open MLflow UI locally:

```
mlflow ui --backend-store-uri mlruns --port 5000
```

Or via Docker Compose:

```
cp .env.example .env
docker compose --env-file .env up -d --build
```

{%- endif %}

## Config Matrix

| Component     | Selection                                      |
| ------------- | ---------------------------------------------- |
| Config system | **{{ config_system }}**                        |
| Tracking      | **{{ tracking }}**                             |
| Serving       | **{{ 'enabled' if serving else 'disabled' }}** |
| Docker        | **{{ docker }}**                               |

## Common Commands

{% if "makefile" in extras -%}

```
make help
make train
make eval
make serve     # if serving enabled
make clean
```

{%- else -%}

```
python -m {{ pkg }}.train
python -m {{ pkg }}.eval
python -m {{ pkg }}.infer   # see preset-specific args
```

{%- endif %}

## Export & Serve

* **Vision**: `python -m {{ pkg }}.export_onnx` then (optional) `python -m {{ pkg }}.bench_ort_cpu`
* **Tabular**: `python -m {{ pkg }}.infer --json rows.json`
* **NLP**: `python -m {{ pkg }}.infer --json texts.json`
* **Serving** (if enabled): `uvicorn {{ pkg }}.serve.app:app --host 0.0.0.0 --port 8000`

## Repro Checklist

* [x] Fixed seeds
* [x] Env pinning via `pyproject.toml`
* [x] Data and artifacts not committed (`data/`, `artifacts/`)
* [x] Smoke tests via `pytest -q`

## Cards

* See **MODEL_CARD.md** and **DATA_CARD.md** for details.

## Contributing & Security

See **CONTRIBUTING.md**, **CODE_OF_CONDUCT.md**, **SECURITY.md**.

