Retrain the specified automation project

put/projects/{projectId}

To retrain an automation project with changed parameters, use the retrainProject endpoint. By default, the service generates a new automated pipeline. This behavior can be overwritten with an optional query parameter replacePreviousPipelines. When set to true, the parameter instructs the service to remove all previous automatically generated pipelines before creating a new pipeline.

Request Samples

1

Response Samples

1{
2  "creationTimeStamp": "2022-03-01T19:55:42.658381Z",
3  "createdBy": "username",
4  "modifiedTimeStamp": "2022-03-02T07:02:38.617258Z",
5  "modifiedBy": "username",
6  "revision": 10,
7  "id": "07d7b51f-6970-4225-8f03-eda03fcc810c",
8  "name": "Modified Project Name",
9  "links": [
10    {
11      "method": "GET",
12      "rel": "up",
13      "href": "/mlPipelineAutomation/projects",
14      "uri": "/mlPipelineAutomation/projects",
15      "type": "application/vnd.sas.collection",
16      "itemType": "application/vnd.sas.analytics.ml.pipeline.automation.project"
17    },
18    {
19      "method": "GET",
20      "rel": "self",
21      "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c",
22      "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c",
23      "type": "application/vnd.sas.analytics.ml.pipeline.automation.project"
24    },
25    {
26      "method": "PUT",
27      "rel": "update",
28      "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c",
29      "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c",
30      "type": "application/vnd.sas.analytics.ml.pipeline.automation.project"
31    },
32    {
33      "method": "DELETE",
34      "rel": "delete",
35      "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c",
36      "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c"
37    },
38    {
39      "method": "DELETE",
40      "rel": "propagateDelete",
41      "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c?propagate=true",
42      "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c?propagate=true"
43    },
44    {
45      "method": "GET",
46      "rel": "state",
47      "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/state",
48      "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/state",
49      "type": "text/plain"
50    },
51    {
52      "method": "PUT",
53      "rel": "updateState",
54      "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/state?value={value}",
55      "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/state?value={value}",
56      "responseType": "text/plain"
57    }
58  ],
59  "version": 3,
60  "dataTableUri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~Public/tables/DATA",
61  "type": "predictive",
62  "state": "retraining",
63  "settings": {
64    "locale": "en-US",
65    "replacePreviousPipelines": false
66  },
67  "analyticsProjectAttributes": {
68    "analyticsProjectId": "0594f275-4c39-4bd1-a50b-3d25714becc3",
69    "targetVariable": "LOAN",
70    "targetEventLevel": "1"
71  },
72  "championModel": {},
73  "pipelineBuildMethod": "automatic"
74}

Path Parameters

NameTypeRequiredDescription
projectId
string
true

projectId

Query Parameters

NameTypeRequiredDescription
replacePreviousPipelines
boolean
false

Flag to replace previous pipelines

Default:
false
action
string
true

The retrain project action

Allowed value:
retrainProject
Default:
retrainProject

Header Parameters

NameTypeRequiredDescription
Accept-Language
string
true

Accept-Language

If-Match
string
true

If-Match

Request Body

project

This object contains metadata and information about an automation project.

NameTypeRequiredDescription
analyticsProjectAttributes
Analytics Project Attributes
true

This object contains a list of analytics project attributes related to Model Studio project settings.

dataTableUri
string
true

Data table URI

description
string
false

Description of the automation project

id
string
false

ID of the automation project

name
string
true

Name of the automation project

revision
integer<int64>
false

Revision of the automation project instance

settings
Automation Project Settings
false

A collection of optional settings to configure an automation project after Model Studio project is created based on analyticsProjectAttributes.

state
string
false

Automation Project state. One of the enums [pending, preparing, waiting, ready, modeling, constructingPipeline, runningPipeline, quiescing, quiesced, completed, canceled, failed, oversampling, retraining].

Allowed values:
pendingpreparingwaitingreadymodelingconstructingPipelinerunningPipelinequiescingquiescedcompletedcanceledfailedoversamplingretraining
type
string
true

Automation project type

Allowed value:
predictive
pipelineBuildMethod
string
false

The method used to generate the project pipeline

Allowed values:
automatictemplate
version
integer<int32>
false

Version of the resource

championModel
Champion Model
false

This object contains a summary of champion model.

customProperties
object
false

Custom properties expressed as a map of strings that are associated with the automation project. These properties are added to the ProviderSpecificProperties map of the generated analytics project (prefixed with 'customMLPA_').

links
array [Link]
false

The links that apply to this automation project

Responses

StatusMeaningDescription
202Accepted

The action was accepted and the automation project was updated.

HeadersSchema
400Bad Request

One or more parameters were invalid.

Schema
404Not Found

No automation project with the provided entity ID was found.

Schema
412Precondition Failed

The value supplied in the If-Match header did not match the expected value.

Schema
428Precondition Required

An If-Match header was not supplied on the update request.

Schema