Create and manage instances of AI Model Experiments
Last updated on
Prerequisites
Section titled “Prerequisites”Before creating an instance, ensure you meet the following prerequisites:
- You have a STACKIT customer account: Create a customer Account
- You have a STACKIT user account: Create a user account
- You have a STACKIT project: Create a project
Understanding Instances
Section titled “Understanding Instances”In AI Model Experiments, an instance is a dedicated MLflow™ Tracking Server environment that ensures your machine learning lifecycle is organized and secure. Each instance operates with its own independent database for metadata (parameters, metrics, tags) and dedicated storage for artifacts (models, plots, data). Therefore, instances can be used to create boundaries between different teams, projects, or stages of development.
Every instance is accessible via a unique URL. You can log in directly using your STACKIT account to view the MLflow™ UI and inspect experiments. To interact with an instance programmatically (via the MLflow™ Python SDK or REST API), you must generate access tokens as explained in Manage tokens. These tokens allow you to securely authenticate your local environments or CI/CD pipelines with the server.
To facilitate artifact storage, a dedicated object storage bucket is automatically generated in your project for every instance you create. Because instances rely on these buckets, you must have Object Storage enabled in your project before you can enable AI Model Experiments.
To keep your storage costs optimized and your workspace clean, instances include a custom setting called DeletedExperimentRetention. When you delete an experiment in the MLflow™ UI or via the API, the data is initially only “marked for deletion” (Soft Delete). This setting defines the grace period before that data is permanently deleted from the database and artifact storage. If you do not specify a value, the retention period defaults to 30 days. You can adjust this timeframe to meet your team’s specific data-handling policies or to reclaim disk space.
Create an Instance
Section titled “Create an Instance”- On the sidebar click on AI Model Experiments.
- On the top bar click on Create AI Model Experiments.
- Enter an Instance name and optionally a Description and a DeletedExperimentRetention.
- Click on Order fee-based.
To obtain an instance with the API, you need an auth token for your user or for your service account. To distinguish it from the auth token for the AI Model Experiments tracking server, we call it STACKIT auth token. The following table gives you a complete overview about all parameters:
| Parameter | Meaning | Example |
|---|---|---|
| stackit-auth-token | User or service account auth token | BZasjkdasbu… |
| project-id | The ID of your project | 89783241-32… |
| region-id | The ID of your region | eu01 |
| instance-description | Description of the instance’s purpose | My instance |
| instance-name | Name of the instance | my-instance |
| experiment-retention | Desired retention period of deleted experiments | 30d |
curl -X POST https://model-experiments.api.stackit.cloud/v1alpha/projects/[project-id]/regions/[region-id]/instances \--header "Authorization: Bearer [stackit-auth-token]" \--header "Content-Type: application/json" \--data '{"description": "[instance-description]", "name": "[instance-name]", "deletedExperimentRetention": "[experiment-retention]"}'List Instances
Section titled “List Instances”- On the sidebar click on AI Model Experiments.
- You can see a list of all instances. Click on an instance to view the details pane.
To get a list of all available instances, execute the following API call:
| Parameter | Meaning | Example |
|---|---|---|
| stackit-auth-token | User or service account auth token | BZasjkdasbu… |
| project-id | The ID of your project | 89783241-32… |
| region-id | The ID of your region | eu01 |
curl -X GET https://model-experiments.api.stackit.cloud/v1alpha/projects/[project-id]/regions/[region-id]/instances \--header "Authorization: Bearer [stackit-auth-token]"Update Instances
Section titled “Update Instances”- On the sidebar click on AI Model Experiments.
- You can see a list of all instances. Click on an instance to view the details pane.
- Modify the desired entry.
- Click on Save to update the instance.
To change the description, name or deletedExperimentRetention of an instance, use the following API call. In the shown example the description of an instance is updated.
| Parameter | Meaning | Example |
|---|---|---|
| stackit-auth-token | User or service account auth token | BZasjkdasbu… |
| project-id | The ID of your project | 89783241-32… |
| region-id | The ID of your region | eu01 |
| instance-id | The ID of your instance | 12345678-12… |
| instance-description | Description of the instance’s purpose | My instance |
curl -X PATCH https://model-experiments.api.stackit.cloud/v1alpha/projects/[project-id]/regions/[region-id]/instances/[instance-id] \--header "Authorization: Bearer [stackit-auth-token]" \--header "Content-Type: application/json" \--data '{"description": "[instance-description]"}'Delete Instances
Section titled “Delete Instances”- On the sidebar click on AI Model Experiments.
- You can see a list of all instances. Click on an instance’s three dots button and then on Delete to open the delete pane.
- Enter the instance’s name and click on Delete to finally delete the instance.
To delete an instance, use the following API call:
| Parameter | Meaning | Example |
|---|---|---|
| stackit-auth-token | User or service account auth token | BZasjkdasbu… |
| project-id | The ID of your project | 89783241-32… |
| region-id | The ID of your region | eu01 |
| instance-id | The ID of your instance | 12345678-12… |
curl -X DELETE https://model-experiments.api.stackit.cloud/v1alpha/projects/[project-id]/regions/[region-id]/instances/[instance-id] \--header "Authorization: Bearer [stackit-auth-token]"