/train

get
list training jobs

https://xxxx.yyyy.zzzz.com/train/{workspace}
This route lists all training jobs within a workspace.
Request
Response
Request
Path Parameters
workspace
required
string
selected workspace
Response
200: OK

get
inspect training pipeline

https://xxxx.yyyy.zzzz.com/train/{workspace}/inspect
This route inspects the current training pipeline within a workspace.
Request
Response
Request
Path Parameters
workspace
required
string
selected workspaces__
Response
200: OK

post
create training job

https://xxxx.yyyy.zzzz.com/train/{workspace}
This route creates a new training job within a workspace.
Request
Response
Request
Path Parameters
workspace
required
string
selected workspace
Query Parameters
user
optional
string
user for tracking ownership of training job
Body Parameters
data
required
string
binary source bundle
Response
200: OK

post
training job info

https://xxxx.yyyy.zzzz.com/train/{workspace}/{job_id}
This route returns information about a particular training job within a workspace.
Request
Response
Request
Path Parameters
workspace
required
string
selected workspace
job_id
required
string
selected training job id
Query Parameters
page_id
optional
integer
page number for pagination of listing itrained models
sort_by
optional
string
metric for sorting trained models
Response
200: OK

get
source training bundle

https://xxxx.yyyy.zzzz.com/train/{workspace}/{job_id}/bundle
This route retrieves the source bundle associated with a particular training job within a workspace.
Request
Response
Request
Path Parameters
workspace
required
string
selected workspace
job_id
required
string
selected job id (training)
Query Parameters
include-code
optional
boolean
flag for downloading source code
include-data
optional
boolean
flag for downloading source data
include-model
optional
boolean
flag for downloading trained model
Response
200: OK

get
training model provenance

https://xxxx.yyyy.zzzz.com/train/{workspace}/{model_id}/provenance
This route retrieves the provenance of a particular trained model within a workspace.
Request
Response
Request
Path Parameters
workspace
required
string
selected workspace
model_id
required
string
selected model id
Response
200: OK

get
training job logs

https://xxxx.yyyy.zzzz.com/train/{workspace}/{job_id}/logs
This route retrieves logs associated with a particular training job within a workspace.
Request
Response
Request
Path Parameters
workspace
required
string
selected workspace
job_id
required
string
selected training job id
Response
200: OK

delete
kill a training job

https://xxxx.yyyy.zzzz.com/train/{workspace}/{job_id}/
Allows to kill building and running training jobs
Request
Response
Request
Path Parameters
job_id
required
string
selected training or building job id
workspace
required
string
selected workspace
Response
200: OK
Is returned if the job was successfully killed
400: Bad Request
Is returned if the job was not in a running state
{"error_code": "JOB_NOT_RUNNING", "message": "Job is not running, id: 1234"}
404: Not Found
Is returned if the job is not found
{"error_code": "JOB_NOT_FOUND", "message": "There is no job with id: 1234"}