This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Creates a new Model Studio configuration version.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:models-write.
objectstringHuman readable name of the configuration version and experiment.
objectThe compute resources allocated for training runs.
stringoptionalChangelog describing changes in this version.
objectThe worker configuration including inputs, outputs, and custom settings.
stringThe identifier of the trainer to use for this configuration.
objectThe created ModelStudioConfigVersion
stringHuman readable name of the configuration version and experiment.
integerThe version number of this configuration.
stringThe identifier of the trainer to use for this configuration.
objectThe trainer and version used for this configuration.
objectThe worker configuration including inputs, outputs, and custom settings.
objectThe compute resources allocated for training runs.
stringoptionalChangelog describing changes in this version.
stringThe Foundry user who created this resource
stringThe time at which the resource was created.
1
2
3
4
5
curl -X POST \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/models/modelStudios/ri.models.main.model-studio.a1b2c3d4-e5f6-7890-abcd-ef1234567890/configVersions?preview=true" \
-d '{"name":"Initial configuration","resources":{"memory":"4G","cpu":"2"},"workerConfig":{"outputs":{"model":{"type":"model","modelRid":"ri.models.main.model.a1b2c3d4-e5f6-7890-abcd-ef1234567890"}},"inputs":{"input_df":{"type":"dataset","rid":"ri.foundry.main.dataset.a1b2c3d4-e5f6-7890-abcd-ef1234567890","columnMapping":{"target_column":["target"]},"ignoreColumns":[],"selectColumns":[]}}},"trainerId":"ri.models..trainer.autogluon_tabular_regression"}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
{
"createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"trainer": {
"trainerId": "ri.models..trainer.autogluon_tabular_regression",
"version": "0.388.0"
},
"name": "Initial configuration",
"resources": {
"memory": "4G",
"cpu": "2"
},
"createdTime": "2003-05-06T12:34:56.789Z",
"version": 1,
"workerConfig": {
"outputs": {
"model": {
"type": "model",
"modelRid": "ri.models.main.model.a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
},
"inputs": {
"input_df": {
"type": "dataset",
"rid": "ri.foundry.main.dataset.a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"columnMapping": {
"target_column": [
"target"
]
},
"ignoreColumns": [],
"selectColumns": []
}
}
},
"trainerId": "ri.models..trainer.autogluon_tabular_regression"
}| Error Name | ||
|---|---|---|
Model | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The requested Model Studio was not found. | |
| Parameters | studioRid | |
Trainer | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The specified trainer does not exist. | |
| Parameters | trainerId | |
Create | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The provided configuration is invalid. | |
| Parameters | studioRid, validationFailures | |
Create | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not create the ModelStudioConfigVersion. | |
| Parameters | modelStudioRid | |
See Errors for a general overview of errors in the platform.