Skip to main content

Methods

Get model version API

Parameters

id
str
required

Returns

GetModelVersionResponse
GetModelVersionResponse
🔗 GetModelVersionResponseSuccessful Response

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 model versions API

Parameters

id
str
required

Returns

EmptyResponse
EmptyResponse
🔗 EmptyResponseSuccessful Response

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 version API

Parameters

fqn
typing.Optional[str]
model_id
typing.Optional[str]
ml_repo_id
typing.Optional[str]
name
typing.Optional[str]
version
typing.Optional[int]
run_ids
typing.Optional[typing.Union[str, typing.Sequence[str]]]
run_steps
typing.Optional[typing.Union[int, typing.Sequence[int]]]
offset
typing.Optional[int]
limit
typing.Optional[int]
include_internal_metadata
typing.Optional[bool]

Returns

SyncPager[ModelVersion]
SyncPager[ModelVersion]
🔗 ModelVersionSuccessful Response

Usage

from truefoundry import TrueFoundry

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

client.model_versions.list(
    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",
)
I