Skip to main content

aip_sdk.MetricConfigResolution

aip_sdk.MetricConfigResolution(metric_name: str, default: MetricConfigResolutionVersion, overrides: list[MetricConfigResolutionOverrideGroup], preselected_scope: str, preselected_config_name: str, preselected_config_version: str)

What one metric resolves to for a workspace: its workspace default, every named override with its version history, and which one a new run preselects.

Attributes

  • metric_name str: The metric implementation this resolution is for.
  • default MetricConfigResolutionVersion: The workspace's current default for this metric.
  • overrides list[MetricConfigResolutionOverrideGroup]: Every named override stored for this metric, grouped by config_name.
  • preselected_scope str: Always "default" today — nothing else can be preselected. Exists because preselected_config_name/preselected_config_version alone are ambiguous: Table A and Table B mint identity independently, so a workspace default can coincidentally share both with an entry in overrides. Branch on this field rather than searching overrides for a matching identity — when it is "default", the preselected payload is default, not a lookup result.
  • preselected_config_name str: The default's config name — not a metric_config_refs target (see below).
  • preselected_config_version str: The default's config version — not a metric_config_refs target (see below).

default/preselected_config_name/preselected_config_version identify the workspace's admin default, which metric_config_refs cannot pin (it resolves only named overrides). Omit the metric from metric_config_refs to use the default instead; pinning the preselected identity directly can fail, or worse, silently hit an unrelated override. Build refs only from overrides.

aip_sdk.MetricConfigResolution.default​

aip_sdk.MetricConfigResolution.default: MetricConfigResolutionVersion

No docstring is defined in the source.

aip_sdk.MetricConfigResolution.metric_name​

aip_sdk.MetricConfigResolution.metric_name: str

No docstring is defined in the source.

aip_sdk.MetricConfigResolution.overrides​

aip_sdk.MetricConfigResolution.overrides: list[MetricConfigResolutionOverrideGroup]

No docstring is defined in the source.

aip_sdk.MetricConfigResolution.preselected_config_name​

aip_sdk.MetricConfigResolution.preselected_config_name: str

No docstring is defined in the source.

aip_sdk.MetricConfigResolution.preselected_config_version​

aip_sdk.MetricConfigResolution.preselected_config_version: str

No docstring is defined in the source.

aip_sdk.MetricConfigResolution.preselected_scope​

aip_sdk.MetricConfigResolution.preselected_scope: str

No docstring is defined in the source.