Skip to content

MatrAIx Handbook

Documentation for MatrAIx — evaluate products with simulated users across Survey, Chatbot, Web, and App. For install and a short repo overview, see the project README.

uv run --with mkdocs-material mkdocs serve   # http://127.0.0.1:8000

1. Start here

Quickstart — install → smoke → one persona → batch → Playground.

Also Page
Job YAML Configuration
Agents & API keys Environment → Agents

2. Three pillars

Pillar Path What it covers
Persona persona/ Schema, 1M coreset, sampling, pipeline, validation
Application application/ Tasks, Playground; contracts in application/task-spec/
Environment environment/ Matraix Playground runtime, agents, web modes, scaling

Optional packages: packages.md.


3. Persona 1M (optional)

huggingface-cli download MatrAIx2026/MatrAIx_Persona_1M_Public_Release \
  --repo-type dataset \
  --local-dir persona/datasets/matraix-persona-1m/release

Playground: Dataset → matraix-persona-1m. CLI: --dataset persona/datasets/matraix-persona-1m.
Details: Persona.


4. Author a task

Start from application/task-spec/README.md (contracts and type diagrams), then the task guide. Copy an example-* under application/tasks/ and smoke it with the Quickstart.


Map

docs/
├── README.md              this page
├── quickstart.md          install → first runs → Playground
├── configuration.md       job recipes
├── persona/               schema · 1M · pipeline · validation
├── application/           tasks overview · task guide · Playground API
├── environment/           Matraix Playground · agents · web modes · scaling
└── packages.md

application/task-spec/     task contracts and deep-dive notes
application/tasks/         runnable scenarios
persona/ · environment/    data/schema · runtime code