Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/test_toolbox_dsl.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
run: |
set -o errexit
python -m pip install --upgrade pip
python -m pip install pytest pyyaml jinja2 jsonpath_ng
python -m pip install -e .[testing]

- name: Run projects/core/tests
run: |
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ htmlcov/
.coverage
.coverage.*
.cache
.caliper_cache/
nosetests.xml
coverage.xml
*.cover
Expand Down
32 changes: 27 additions & 5 deletions projects/caliper/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,30 @@
# Caliper (file export)
# Caliper

This package is trimmed to **file artifact export** (MLflow) and **orchestration** helpers used by FORGE project CI (e.g. `projects.skeleton`).
Artifact post-processing: parse labeled test trees, visualize, KPIs, export to OpenSearch / S3 / MLflow.

- CLI: `caliper artifacts export ...` (see `--help`)
- Code: `projects.caliper.engine.file_export` and `projects.caliper.orchestration`
**Specification**: [specs/009-artifact-post-processing/spec.md](../../specs/009-artifact-post-processing/spec.md)

For product requirements, see the FORGE `specs/` tree (not modified here per project policy).
## CLI

- `--artifacts-dir` (`--base-dir`): root directory of the **test artifact tree** (where `__test_labels__.yaml` lives). Manifest YAML is discovered here unless `--postprocess-config` points elsewhere.
- `--plugin-module` (`--plugin`): dotted Python **import path** for the plugin module (`get_plugin()`), overriding `plugin_module` in the manifest when both are set.

```bash
caliper --artifacts-dir /path/to/artifacts parse
caliper --plugin-module my_package.caliper_plugin --artifacts-dir /path visualize \
--output-dir ./out --report-group default
```

Install optional backends: `pip install -e '.[caliper]'`

## Commands

| Command | Purpose |
|---------|---------|
| `parse` | Traverse, parse, write parse cache |
| `visualize` | Plots + HTML from unified model |
| `kpi generate` / `import` / `export` / `analyze` | Canonical KPI pipeline |
| `artifacts export` | File upload to S3 / MLflow |
| `ai-eval-export` | AI evaluation JSON |

See [quickstart.md](../../specs/009-artifact-post-processing/quickstart.md) and [plan.md](../../specs/009-artifact-post-processing/plan.md).
Loading
Loading