Skip to main content

​
Methods

Apply tags to a model version.

​
Parameters

​
model_version_id
str
required
ID of the model version to apply tags to
​
tags
typing.Sequence[str]
required
List of tags to apply to the model version
​
force
typing.Optional[bool]
Whether to overwrite existing tags if they conflict

​
Returns

​
EmptyResponse
EmptyResponse
🔗 EmptyResponseEmpty response indicating successful tag application

​
Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.model_versions.apply_tags(
    model_version_id="value",
    tags="value",
    force="value",
)
Get a model version by its ID.

​
Parameters

​
id
str
required

​
Returns

​
GetModelVersionResponse
GetModelVersionResponse
🔗 GetModelVersionResponseThe model version data

​
Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.model_versions.get(
    id="id_value",
)
Delete a model version by its ID.

​
Parameters

​
id
str
required

​
Returns

​
EmptyResponse
EmptyResponse
🔗 EmptyResponseEmpty response indicating successful deletion

​
Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.model_versions.delete(
    id="id_value",
)
List model versions with optional filtering by tag, FQN, model ID, ML Repo, name, version, run IDs, or run steps.

​
Parameters

​
tag
typing.Optional[str]
Tag to filter model versions by
​
fqn
typing.Optional[str]
Fully qualified name to filter model versions by (format: ‘model://’ or ‘model://:’)
​
model_id
typing.Optional[str]
ID of the model to filter versions by
​
ml_repo_id
typing.Optional[str]
ID of the ML Repo to filter model versions by
​
name
typing.Optional[str]
Name of the model to filter versions by
​
version
typing.Optional[int]
Version number (positive integer) or ‘latest’ to filter by specific version
​
run_ids
typing.Optional[typing.Union[str, typing.Sequence[str]]]
List of run IDs to filter model versions by
​
run_steps
typing.Optional[typing.Union[int, typing.Sequence[int]]]
List of run step numbers to filter model versions by
​
offset
typing.Optional[int]
Number of model versions to skip for pagination
​
limit
typing.Optional[int]
Maximum number of model versions to return
​
include_internal_metadata
typing.Optional[bool]
Whether to include internal metadata in the response

​
Returns

​
SyncPager[ModelVersion, ListModelVersionsResponse]
SyncPager[ModelVersion, ListModelVersionsResponse]
🔗 ListModelVersionsResponseList of model versions matching the query with pagination information

​
Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.model_versions.list(
    tag="value",
    fqn="value",
    model_id="value",
    ml_repo_id="value",
    name="value",
    version="value",
    run_ids="value",
    run_steps="value",
    offset=10,
    limit=10,
    include_internal_metadata="value",
)

# Iterate through results
for item in response:
    print(item.name)

# Or paginate page by page
for page in response.iter_pages():
    for item in page:
        print(item.name)
Get Model Version by FQN.

​
Parameters

​
fqn
str
required
FQN of the model version

​
Returns

​
GetModelVersionResponse
GetModelVersionResponse
🔗 GetModelVersionResponseModel version details

​
Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.model_versions.get_by_fqn(
    fqn="value",
)