Skip to main content

Methods

Parameters

Parameters

id
str
required

Returns

GetModelResponse
GetModelResponse
🔗 GetModelResponseSuccessful Response

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",
)
Parameters

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.models.delete(
    id="id_value",
)
Parameters

Parameters

fqn
typing.Optional[str]
ml_repo_id
typing.Optional[str]
name
typing.Optional[str]
offset
typing.Optional[int]
limit
typing.Optional[int]
run_id
typing.Optional[str]

Returns

SyncPager[Model]
SyncPager[Model]
🔗 ModelSuccessful Response

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",
)

# 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)
Parameters

Parameters

manifest
ModelManifest
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.models.create_or_update(
    manifest={"key": "value"},
)
Get Model by FQN.

Parameters

fqn
str
required
FQN of the model

Returns

GetModelResponse
GetModelResponse

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",
)
I