Truefoundry Docs

Get Ml Repo

curl --request GET \
  --url https://{controlPlaneURL}/api/ml/v1/ml-repos/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "tenant_name": "truefoundry",
    "manifest": {
      "name": "devtest-finetuning-test-420",
      "type": "ml-repo",
      "description": "This is a test MLRepo for fine-tuning experiments.",
      "collaborators": [
        {
          "role_id": "mlf-project-admin",
          "subject": "user:[email protected]"
        },
        {
          "role_id": "mlf-project-admin",
          "subject": "team:teamb"
        }
      ],
      "storage_integration_fqn": "truefoundry:aws:aws-4:blob-storage:devtest-test-1"
    },
    "created_by_subject": {
      "subjectId": "cm1xxxp",
      "subjectSlug": "[email protected]",
      "subjectType": "user",
      "subjectDisplayName": "Test User"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "id": "420",
    "account_id": "<string>",
    "num_runs": 10,
    "artifact_type_counts": {},
    "datasets_count": 10
  }
}

GET

api

ml-repos

{id}

Get Ml Repo

curl --request GET \
  --url https://{controlPlaneURL}/api/ml/v1/ml-repos/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "tenant_name": "truefoundry",
    "manifest": {
      "name": "devtest-finetuning-test-420",
      "type": "ml-repo",
      "description": "This is a test MLRepo for fine-tuning experiments.",
      "collaborators": [
        {
          "role_id": "mlf-project-admin",
          "subject": "user:[email protected]"
        },
        {
          "role_id": "mlf-project-admin",
          "subject": "team:teamb"
        }
      ],
      "storage_integration_fqn": "truefoundry:aws:aws-4:blob-storage:devtest-test-1"
    },
    "created_by_subject": {
      "subjectId": "cm1xxxp",
      "subjectSlug": "[email protected]",
      "subjectType": "user",
      "subjectDisplayName": "Test User"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "id": "420",
    "account_id": "<string>",
    "num_runs": 10,
    "artifact_type_counts": {},
    "datasets_count": 10
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Response

Successful Response

data

MLRepo · object

required

ML Repo

Show child attributes

data.tenant_name

string

required

Tenant Name

Example:

"truefoundry"

data.manifest

MLRepoManifest · object

required

+label=MLRepo +usage=MLRepo is a repository ML training runs that log params, metrics, plots, images and versioned entities like artifacts, models, prompts, tools, agents

Show child attributes

data.manifest.type

enum<string>

required

+value=ml-repo

Available options:

ml-repo

data.manifest.name

string

required

+label=Name +icon=fa-desktop:#black +usage=Name of the ML Repo. +message=Alphanumeric word, may contain '-' with a maximum length of 100 characters +sort=1

data.manifest.storage_integration_fqn

string

required

+label=Storage Integration +icon=hard-drive +usage=Storage Integration to store artifacts and models. A storage integration represents a connected blob storage like AWS S3 / Azure Blob Storage / Google Cloud Storage. +message=Select the storage-integration where you want to save your artifacts and models View Docs +sort=4

data.manifest.collaborators

Collaborator · object[]

required

+label=Collaborators +sort=5 +usage=Users and Teams that have access to MLRepo +uiType=Collaborators

Show child attributes

data.manifest.collaborators.subject

string

required

+label=Subject FQN +usage=Fully Qualified Name of the subject. eg: user:email or team:teamname

data.manifest.collaborators.role_id

string

required

+label=Role ID +usage=Role ID for the resource

data.manifest.description

string

+label=Description +icon=fa-desktop:#black +usage=Description for the ML Repo. +message=Description can be maximum 500 characters +sort=2 +placeholder=MLRepo to track text-classification experiments and models +uiProps={"descriptionInline":true}

data.manifest.ownedBy

OwnedBy · object

+label=Owner +usage=Names of the owners that own this resource

Show child attributes

data.manifest.ownedBy.account

string

required

+label=Account Name +sort=1 +usage=The name of the account that owns this resource +placeholder=Search Account +uiType=AccountSelect +uiProps={"maxAllowedAccounts": 1}

Example:

{
  "name": "devtest-finetuning-test-420",
  "type": "ml-repo",
  "description": "This is a test MLRepo for fine-tuning experiments.",
  "collaborators": [
    {
      "role_id": "mlf-project-admin",
      "subject": "user:[email protected]"
    },
    {
      "role_id": "mlf-project-admin",
      "subject": "team:teamb"
    }
  ],
  "storage_integration_fqn": "truefoundry:aws:aws-4:blob-storage:devtest-test-1"
}

data.created_by_subject

Subject · object

required

Show child attributes

data.created_by_subject.subjectId

string

required

Subject ID

data.created_by_subject.subjectType

enum<string>

required

Subject type

Available options:

user,

team,

serviceaccount,

virtualaccount

data.created_by_subject.subjectSlug

string

Subject slug

data.created_by_subject.subjectDisplayName

string

Subject display name

Example:

{
  "subjectId": "cm1xxxp",
  "subjectSlug": "[email protected]",
  "subjectType": "user",
  "subjectDisplayName": "Test User"
}

data.created_at

string<date-time>

required

Created At

data.id

string

required

Experiment Id

Example:

"420"

data.account_id

string | null

data.num_runs

integer

Number of runs

Example:

10

data.artifact_type_counts

object

Show child attributes

data.artifact_type_counts.{key}

integer

data.datasets_count

integer

Number of datasets

Example:

10

Create or Update MLRepo Delete Ml Repo

⌘I

TrueFoundry SDK

TrueFoundry ML Client

Apply API Guides

Applications

Apply

Artifacts

Audit Logs

Clusters

Jobs

Logs

MLRepos

Model Deployments

Models

Personal Access Tokens

Prompts

Provider Integrations

Secret Groups

Secrets

Teams

Traces

Users

Virtual Accounts

Workspaces

Get Ml Repo

Authorizations

Path Parameters

Response