model
List, describe, estimate, and backtest macroeconomic and satellite specifications; manage version hashes and map quantities to satellite estimators for stress-test scenarios.
Instructions
Model versions and plugins. kind: macro, satellites, catalog.
The episode check of the models is backtest (python -m mst.metrics).
Actions for macro: list, describe, estimate, backtest; for satellites: list,
describe, estimate; for catalog: list, the installed model plugins.
model_id names the macro model to estimate or backtest — the only one installed
when omitted; assignment maps a quantity to the satellite model that estimates
it in an estimate of the satellites, overriding the model that declares it.
version is the version hash describe reads and the macro version the
satellites of an estimate are built on; list takes no version.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | ||
| only | No | ||
| as_of | No | ||
| action | Yes | ||
| version | No | ||
| model_id | No | ||
| assignment | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||