Truefoundry Docs

On this page

Methods

Methods

list

List environments, if no environments are found, default environments are created and returned. 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

🔗 EnvironmentReturns a list of environment. 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.environments.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

Creates a new Environment or updates an existing Environment.

Parameters

manifest

EnvironmentManifest

required

🔗 EnvironmentManifestEnvironment Manifest

dry_run

typing.Optional[bool]

Dry run

Returns

GetEnvironmentResponse

🔗 GetEnvironmentResponseReturns the created or updated Environment

Usage

from truefoundry import TrueFoundry

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

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

get

Get Environment associated with the provided id.

Parameters

str

required

Environment id

Returns

GetEnvironmentResponse

🔗 GetEnvironmentResponseReturns the Environment associated with the provided id

Usage

from truefoundry import TrueFoundry

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

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

delete

Delete Environment associated with the provided id.

Parameters

str

required

Environment id

Returns

bool

Returns true if the Environment is deleted successfully

Usage

from truefoundry import TrueFoundry

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

client.environments.delete(
    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

Environments

Methods

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