Skip to main content

​
Methods

Get a model by its ID.

​
Parameters

​
id
str
required

​
Returns

​
GetModelResponse
GetModelResponse
🔗 GetModelResponseThe model data

​
Usage

from truefoundry import TrueFoundry

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

client.models.get(
    id="id_value",
)
Delete a model 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.models.delete(
    id="id_value",
)
List models with optional filtering by FQN, ML Repo, name, or run ID.

​
Parameters

​
fqn
typing.Optional[str]
Fully qualified name to filter models by (format: ‘model://’)
​
ml_repo_id
typing.Optional[str]
ID of the ML Repo to filter models by
​
name
typing.Optional[str]
Name of the model to filter by
​
offset
typing.Optional[int]
Number of models to skip for pagination
​
limit
typing.Optional[int]
Maximum number of models to return
​
run_id
typing.Optional[str]
ID of the run to filter models by
​
include_empty_models
typing.Optional[bool]
Whether to include models that have no versions

​
Returns

​
SyncPager[Model, ListModelsResponse]
SyncPager[Model, ListModelsResponse]
🔗 ListModelsResponseList of models 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.models.list(
    fqn="value",
    ml_repo_id="value",
    name="value",
    offset=10,
    limit=10,
    run_id="value",
    include_empty_models="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)
Create or update a model version.

​
Parameters

​
manifest
ModelManifest
required
🔗 ModelManifestManifest containing metadata for the model to apply

​
Returns

​
GetModelVersionResponse
GetModelVersionResponse
🔗 GetModelVersionResponseThe created or updated model version

​
Usage

from truefoundry import TrueFoundry

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

client.models.create_or_update(
    manifest={"key": "value"},
)
Get Model by FQN.

​
Parameters

​
fqn
str
required
FQN of the model

​
Returns

​
GetModelResponse
GetModelResponse
🔗 GetModelResponseModel details

​
Usage

from truefoundry import TrueFoundry

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

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