A model can be defined as files: aDocumentation Index
Fetch the complete documentation index at: https://u22a8-police-sweep-2026-06-01.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
model.yaml that declares its traits and where training data comes from, alongside JSONL files of labelled samples. Both formats are published as JSON Schemas, so a model repository can validate its inputs in CI without depending on the platform.
| Schema | Describes |
|---|---|
model.schema.json | The model.yaml configuration. |
samples.schema.json | One line of a training JSONL file. |
This is the file-based authoring path — used for local builds and version-controlled model repositories. The hosted path defines the same model through the REST API or MCP server; traits and samples there are sent as JSON request bodies rather than files.
model.yaml
model.yaml declares one model. traits is the only required field.
| Field | Required | Purpose |
|---|---|---|
traits | yes | The traits the model measures — a list of trait objects, or the string discover to derive them from data. |
description | no | One-line summary shown on the model. |
sources | no | Where training samples come from (see Sources). |
effort | no | Build cost and quality: low, medium, high, xhigh, or max. Defaults to high. |
additional_terms | no | Extra terms of use shown on the model card. Their presence prompts callers to acknowledge them. |
upstream_sources | no | Provenance for datasets used — name, license, citation. Displayed as attribution. |
| Field | Required | Purpose |
|---|---|---|
type | yes | The trait type: spectrum, topic, claim, or outlier. |
key | yes | Stable identifier — lowercase letters, digits, _, and -. |
name | no | Display name. Defaults to the title-cased key. |
description | no | What the trait measures. |
positive_label / negative_label | no | The two poles, e.g. warm / cold. |
aggregation | no | How per-segment scores combine: mean (default), max, min, or none. |
model.yaml
Advanced training overrides
The optionaltraining: block exposes host-level knobs that effort does not control. Most models do not need this section.
training: fields
training: fields
| Field | Type | Default | Purpose |
|---|---|---|---|
max_parallel_methods | integer ≥ 1 | 4 | Concurrent method studies during Optuna optimization. Tune to host concurrency. |
boundary_low | number 0–50 | — | Fixed low percentile boundary. When set with boundary_high, skips the boundary sweep. |
boundary_high | number 50–100 | — | Fixed high percentile boundary. Pair with boundary_low. |
boundary_mode | exclude | interpolate | exclude | How samples between the fixed boundaries are handled. Only used when boundary_low/boundary_high are set. |
training: fields are deprecated — use the top-level effort field instead.Sources
A source supplies training samples. Each entry has atype; the remaining fields depend on it.
type | Provides |
|---|---|
jsonl | Lines from a local JSONL file, mapped to traits. |
csv / github_csv | Columns from a CSV file, local or in a GitHub repository. |
huggingface | Rows from a Hugging Face dataset split. |
url / file | A single document, fetched by URL or read from a path. |
noise | Background negative samples drawn from a dataset. |
Samples (JSONL)
A samples file has one JSON object per line. Each object carries thecontent to learn from and one field per trait it labels. A trait field’s value is either a quality label or a number in [0, 1], where 1.0 is the positive pole and 0.0 the negative.
samples/replies.jsonl
positive, good, yes, high, strong, excellent; fair, moderate, mixed, medium; poor, no, low, weak, bad, negative. The field names in each line are mapped to traits by the mapping of the jsonl source that reads the file.
Validate
Validate authoring files against the published schemas with any JSON Schema validator. Doing this in CI catches a malformedmodel.yaml before a build.
validate.py
Next
Score types
What each trait type measures.
REST API
Define the same model over HTTP.