Documentation Index Fetch the complete documentation index at: https://www.truefoundry.com/llms.txt
Use this file to discover all available pages before exploring further.
Methods
Get a model by its ID. Parameters Returns 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 Returns 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 Fully qualified name to filter models by (format: ‘model://’)
ID of the ML Repo to filter models by
Name of the model to filter by
Number of models to skip for pagination
Maximum number of models to return
ID of the run to filter models by
Whether to include models that have no versions
Returns 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 Returns 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 Returns 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" ,
)