Skip to content

Resolver API

The resolver turns a raw model reference into a normalized ResolvedModel without loading model weights.

Bases: str, Enum

Describe where a model reference originates from.

Bases: str, Enum

Known optimized-native model families.

Resolved model metadata used by planning, inspection, and loading.

Attributes:

Name Type Description
reference ModelReference

Parsed user-facing model reference.

source_kind ModelSourceKind

Where the model was resolved from.

normalized_name str

Stable display name used by planning and docs.

model_path Path | None

Local materialization path when one exists.

repo_id str | None

Hugging Face repository identifier when materialization is supported.

revision str | None

Optional requested revision.

catalog_entry ModelCatalogEntry | None

Built-in catalog entry when one matched.

capabilities CapabilityProfile

Capability and support metadata.

native_family NativeFamily | None

Matching optimized-native family when one exists.

resolution_message str

Human-readable resolution summary.

architecture str | None

Inspected architecture for local models.

model_type str | None

Inspected model type for local models.

generic_model_kind GenericModelKind | None

Generic execution kind when one can be inferred.

is_downloadable

is_downloadable() -> bool

Return whether the resolved model can be materialized locally.

Returns:

Name Type Description
bool bool

True when both a repository ID and a local model path are

bool

available.

Resolve model references into built-in, local, or Hugging Face forms.

Parameters:

Name Type Description Default
capability_discovery CapabilityDiscovery | None

Optional capability discovery helper for inspecting local model directories.

None

resolve

resolve(
    raw_reference: str, models_dir: Path
) -> ResolvedModel

Resolve a raw model reference without loading model weights.

Parameters:

Name Type Description Default
raw_reference str

User-facing model reference string.

required
models_dir Path

Local models root used for implicit path resolution.

required

Returns:

Name Type Description
ResolvedModel ResolvedModel

Normalized model metadata used by planning and

ResolvedModel

loading.

discover_local_models

discover_local_models(
    models_dir: Path,
) -> tuple[ResolvedModel, ...]

Inspect local materialized model directories under a models root.

Parameters:

Name Type Description Default
models_dir Path

Local models root to scan.

required

Returns:

Type Description
ResolvedModel

tuple[ResolvedModel, ...]: Resolved local model directories found

...

under the given root.

inspect_materialized_model

inspect_materialized_model(
    reference: ModelReference,
    model_path: Path,
    *,
    source_kind: ModelSourceKind,
    repo_id: str | None,
    revision: str | None,
    catalog_entry: ModelCatalogEntry | None,
) -> ResolvedModel

Inspect a materialized local model directory and derive capabilities.

Parameters:

Name Type Description Default
reference ModelReference

Parsed reference associated with the local model path.

required
model_path Path

Materialized model directory to inspect.

required
source_kind ModelSourceKind

Source bucket for the materialized model.

required
repo_id str | None

Optional repository ID for materialized managed models.

required
revision str | None

Optional requested revision.

required
catalog_entry ModelCatalogEntry | None

Matching built-in catalog entry when one exists.

required

Returns:

Name Type Description
ResolvedModel ResolvedModel

Inspected model metadata with derived capabilities and

ResolvedModel

native-family information.