ModelVersion Class

Model Version Definition.

Constructor

ModelVersion(*args: Any, **kwargs: Any)

Variables

Name Description
system_data

System related metadata.

blob_uri
str

URI of the model artifact in blob storage. Required.

weight_type

The weight type of the model. Known values are: "FullWeight", "LoRA", and "DraftModel".

base_model
str

Base model asset ID.

source

The source of the model.

lora_config

Adapter-specific configuration. Required when weight_type is lora; ignored otherwise. May be auto-populated from adapter_config.json when present in the uploaded files — user-provided values take precedence over auto-detected values.

artifact_profile

The artifact profile of the model.

warnings

Service-computed advisory warnings derived from the artifact profile.

id
str

Asset ID, a unique identifier for the asset.

name
str

The name of the resource. Required.

version
str

The version of the resource. Required.

description
str

The asset description text.

tags

Tag dictionary. Tags can be added, removed, and updated.

Methods

as_dict

Return a dict that can be turned into json using json.dump.

clear

Remove all items from D.

copy
get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any

items
keys
pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly

Whether to remove the readonly properties.

Default value: False

Returns

Type Description

A dict JSON compatible object

clear

Remove all items from D.

clear() -> None

copy

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type Description

set-like object providing a view on D's items

keys

keys() -> KeysView[str]

Returns

Type Description

a set-like object providing a view on D's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

popitem() -> tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Returns

Type Description

an object providing a view on D's values

Attributes

artifact_profile

The artifact profile of the model.

artifact_profile: _models.ArtifactProfile | None

base_model

Base model asset ID.

base_model: str | None

blob_uri

URI of the model artifact in blob storage. Required.

blob_uri: str

description

The asset description text.

description: str | None

id

Asset ID, a unique identifier for the asset.

id: str | None

lora_config

Adapter-specific configuration. Required when weight_type is lora; ignored otherwise. May be auto-populated from adapter_config.json when present in the uploaded files — user-provided values take precedence over auto-detected values.

lora_config: _models.LoraConfig | None

name

The name of the resource. Required.

name: str

source

The source of the model.

source: _models.ModelSourceData | None

system_data

System related metadata.

system_data: _models.SystemDataV3 | None

tags

Tag dictionary. Tags can be added, removed, and updated.

tags: dict[str, str] | None

version

The version of the resource. Required.

version: str

warnings

Service-computed advisory warnings derived from the artifact profile.

warnings: list['_models.FoundryModelWarning'] | None

weight_type

"FullWeight", "LoRA", and "DraftModel".

weight_type: str | _models.FoundryModelWeightType | None