Truefoundry Docs

On this page

Methods

Methods

list

Retrieves a list of all latest Clusters. Pagination is available based on query parameters.

Parameters

limit

typing.Optional[int]

Number of items per page

offset

typing.Optional[int]

Number of items to skip

Returns

🔗 ClusterRetrieve latest Clusters. If pagination parameters are provided, the response includes paginated data.

Usage

from truefoundry import TrueFoundry

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

client.clusters.list(
    limit=10,
    offset=10,
)

# 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

Create or Update cluster with provided manifest

Parameters

manifest

ClusterManifest

required

🔗 ClusterManifestCluster manifest

dry_run

typing.Optional[bool]

Dry run the cluster creation/update

Returns

GetClusterResponse

🔗 GetClusterResponseReturns newly created/updated cluster on success

Usage

from truefoundry import TrueFoundry

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

client.clusters.create_or_update(
    manifest={"key": "value"},
    dry_run=False,
)

get

Get cluster associated with provided id

Parameters

str

required

Cluster id of the cluster

Returns

GetClusterResponse

🔗 GetClusterResponseReturn the cluster associated with provided id

Usage

from truefoundry import TrueFoundry

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

client.clusters.get(
    id="id_value",
)

delete

Delete cluster associated with provided cluster id

Parameters

str

required

Cluster id of the cluster

Returns

ClustersDeleteResponse

🔗 ClustersDeleteResponseReturns success message on successful deletion

Usage

from truefoundry import TrueFoundry

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

client.clusters.delete(
    id="id_value",
)

get_addons

List addons for the provided cluster.Pagination is available based on query parameters.

Parameters

str

required

Cluster id of the cluster

limit

typing.Optional[int]

Number of items per page

offset

typing.Optional[int]

Number of items to skip

Returns

ListClusterAddonsResponse

🔗 ListClusterAddonsResponseReturns the list of addons for the cluster And also response includes paginated data

Usage

from truefoundry import TrueFoundry

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

client.clusters.get_addons(
    id="id_value",
    limit=10,
    offset=10,
)

is_connected

Get the status of provided cluster

Parameters

str

required

Cluster id of the cluster

Returns

IsClusterConnectedResponse

🔗 IsClusterConnectedResponseReturns the status of provided cluster

Usage

from truefoundry import TrueFoundry

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

client.clusters.is_connected(
    id="id_value",
)

TrueFoundry SDK

Clusters

Workspaces

MLRepos

Applications

Jobs

Models

Artifacts

Prompts

Secret Groups

Secrets

Model Deployments

Users

Teams

Personal Access Tokens

Virtual Accounts

Logs

Audit Logs

Apply

Clusters

Methods

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

TrueFoundry SDK

Clusters

Workspaces

MLRepos

Applications

Jobs

Models

Artifacts

Prompts

Secret Groups

Secrets

Model Deployments

Users

Teams

Personal Access Tokens

Virtual Accounts

Logs

Audit Logs

Apply

​Methods

Methods