ModelCapabilities
model_settings.ModelCapabilities
Mandatory capability flags for a registered model (see settings.yaml).
Attributes
| Attribute | Type | Description |
|---|---|---|
covariates |
CovariateMode |
How external covariate channels are wired into the model. |
univariate |
bool |
Safe to run on tasks under tempus_bench/tasks/univariate/. |
multivariate |
bool |
Safe to run on tasks under tempus_bench/tasks/multivariate/. |
parse_capabilities_from_settings
model_settings.parse_capabilities_from_settings
| Parameter | Type | Default | Description |
|---|---|---|---|
settings |
dict[str, Any] |
- | (undocumented) |
model_name |
str |
- | (undocumented) |
Returns: ModelCapabilities
load_model_settings_yaml
model_settings.load_model_settings_yaml
Load raw models/<name>/settings.yaml as a mapping (cached).
| Parameter | Type | Default | Description |
|---|---|---|---|
model_name |
str |
- | (undocumented) |
Returns: dict[str, Any]
load_capabilities_for_model
model_settings.load_capabilities_for_model
Load and validate capabilities from models/
| Parameter | Type | Default | Description |
|---|---|---|---|
model_name |
str |
- | (undocumented) |
Returns: ModelCapabilities
merge_benchmark_params_with_default_grid
model_settings.merge_benchmark_params_with_default_grid
Merge benchmark model.<name> hyperparameters with default_hyperparameter_grid.
Foundation models: returns a shallow copy of benchmark_params (no grid merge).
Non-foundation: for each key in default_hyperparameter_grid, if the key is absent
from benchmark_params, sets it to a copy of that grid entry as a list (full search
space for :class:~tempus_bench.utils.configs.ModelConfig). Scalars become [scalar].
| Parameter | Type | Default | Description |
|---|---|---|---|
model_name |
str |
- | (undocumented) |
benchmark_params |
dict[str, Any] |
- | (undocumented) |
Returns: dict[str, Any]
task_path_to_family
model_settings.task_path_to_family
Infer task family from dataset path (folder under tempus_bench/tasks/).
| Parameter | Type | Default | Description |
|---|---|---|---|
task_path |
str |
- | (undocumented) |
Returns: TaskFamily
assert_model_supports_task_family
model_settings.assert_model_supports_task_family
| Parameter | Type | Default | Description |
|---|---|---|---|
cap |
ModelCapabilities |
- | (undocumented) |
model_name |
str |
- | (undocumented) |
family |
TaskFamily |
- | (undocumented) |
Returns: None
iter_capabilities_for_all_registered_models
model_settings.iter_capabilities_for_all_registered_models
Scan models directory for valid settings (same discovery as get_available_models).
Returns: list[tuple[str, ModelCapabilities]]
get_covariate_support
model_settings.get_covariate_support
Return covariate mode: past_future | past_only | future_only | none.
| Parameter | Type | Default | Description |
|---|---|---|---|
model_name |
str |
- | (undocumented) |
Returns: str
is_past_only_covariates
model_settings.is_past_only_covariates
True if the model receives only past covariates (x_context); x_target=None.
| Parameter | Type | Default | Description |
|---|---|---|---|
model_name |
str |
- | (undocumented) |
Returns: bool
is_no_covariates
model_settings.is_no_covariates
True if the model supports no covariates; x_context=None, x_target=None.
| Parameter | Type | Default | Description |
|---|---|---|---|
model_name |
str |
- | (undocumented) |
Returns: bool
has_covariate_support
model_settings.has_covariate_support
True if the model supports any covariate mode other than none.
| Parameter | Type | Default | Description |
|---|---|---|---|
model_name |
str |
- | (undocumented) |
Returns: bool
get_past_only_covariate_models
model_settings.get_past_only_covariate_models
Returns: frozenset[str]
get_no_covariate_models
model_settings.get_no_covariate_models
Returns: frozenset[str]
clear_model_settings_cache
model_settings.clear_model_settings_cache
Clear caches (e.g. in tests after editing settings.yaml).
Returns: None