API Definitions
Definitions
auth.credential_key
Name | Description | Schema |
---|---|---|
access_key optional | string | |
label optional | Optional credentials label | string |
last_used optional | string (date-time) | |
last_used_from optional | string |
auth.credentials
Name | Description | Schema |
---|---|---|
access_key optional | Credentials access key | string |
label optional | Optional credentials label | string |
secret_key optional | Credentials secret key | string |
auth.role
Type : enum (admin, superuser, user, annotator)
events.debug_image_sample_response
Name | Description | Schema |
---|---|---|
event optional | Debug image event | object |
max_iteration optional | maximal valid iteration for the variant | integer |
min_iteration optional | minimal valid iteration for the variant | integer |
scroll_id optional | Scroll ID to pass to the next calls to get_debug_image_sample or next_debug_image_sample | string |
events.debug_images_response
Name | Description | Schema |
---|---|---|
metrics optional | Debug image events grouped by tasks and iterations | < events.debug_images_response_task_metrics > array |
scroll_id optional | Scroll ID for getting more results | string |
events.debug_images_response_task_metrics
Name | Description | Schema |
---|---|---|
iterations optional | < iterations > array | |
task optional | Task ID | string |
iterations
Name | Description | Schema |
---|---|---|
events optional | < object > array | |
iter optional | Iteration number | integer |
events.event_type_enum
Type : enum (training_stats_scalar, training_stats_vector, training_debug_image, plot, log)
events.log_level_enum
Type : enum (notset, debug, verbose, info, warn, warning, error, fatal, critical)
events.metric_variants
Name | Description | Schema |
---|---|---|
metric optional | The metric name | string |
variants optional | The names of the metric variants | < string > array |
events.metrics_image_event
An image or video was dumped to storage for debugging
Name | Description | Schema |
---|---|---|
iter optional | Iteration | integer |
key optional | File key | string |
metric optional | Metric name, e.g. 'count', 'loss', 'accuracy' | string |
task required | Task ID (required) | string |
timestamp optional | Epoch milliseconds UTC, will be set by the server if not set. | number |
type required | 'training_debug_image' | string |
url optional | File URL | string |
variant optional | E.g. 'class_1', 'total', 'average | string |
events.metrics_plot_event
An entire plot (not single datapoint) and it's layout. Used for plotting ROC curves, confidence matrices, etc. when evaluating the net.
Name | Description | Schema |
---|---|---|
iter optional | Iteration | integer |
metric optional | Metric name, e.g. 'count', 'loss', 'accuracy' | string |
plot_str optional | An entire plot (not single datapoint) and it's layout. Used for plotting ROC curves, confidence matrices, etc. when evaluating the net. | string |
skip_validation optional | If set then plot_str is not checked for a valid json. The default is False | boolean |
task required | Task ID (required) | string |
timestamp optional | Epoch milliseconds UTC, will be set by the server if not set. | number |
type required | 'plot' | string |
variant optional | E.g. 'class_1', 'total', 'average | string |
events.metrics_scalar_event
Used for reporting scalar metrics during training task
Name | Description | Schema |
---|---|---|
iter optional | Iteration | integer |
metric optional | Metric name, e.g. 'count', 'loss', 'accuracy' | string |
task required | Task ID (required) | string |
timestamp optional | Epoch milliseconds UTC, will be set by the server if not set. | number |
type required | 'training_stats_scalar' | string |
value optional | number | |
variant optional | E.g. 'class_1', 'total', 'average | string |
events.metrics_vector_event
Used for reporting vector metrics during training task
Name | Description | Schema |
---|---|---|
iter optional | Iteration | integer |
metric optional | Metric name, e.g. 'count', 'loss', 'accuracy' | string |
task required | Task ID (required) | string |
timestamp optional | Epoch milliseconds UTC, will be set by the server if not set. | number |
type optional | 'training_stats_vector' | string |
values optional | vector of float values | < number > array |
variant optional | E.g. 'class_1', 'total', 'average | string |
events.plot_sample_response
Name | Description | Schema |
---|---|---|
events optional | Plot events | < object > array |
max_iteration optional | maximal valid iteration for the metric | integer |
min_iteration optional | minimal valid iteration for the metric | integer |
scroll_id optional | Scroll ID to pass to the next calls to get_plot_sample or next_plot_sample | string |
events.plots_response
Name | Description | Schema |
---|---|---|
metrics optional | Plot events grouped by tasks and iterations | < events.plots_response_task_metrics > array |
scroll_id optional | Scroll ID for getting more results | string |
events.plots_response_task_metrics
Name | Description | Schema |
---|---|---|
iterations optional | < iterations > array | |
task optional | Task ID | string |
iterations
Name | Description | Schema |
---|---|---|
events optional | < object > array | |
iter optional | Iteration number | integer |
events.scalar_key_enum
Type : enum (iter, timestamp, iso_time)
events.single_value_metrics_response
Name | Description | Schema |
---|---|---|
tasks optional | Single value metrics grouped by task | < events.single_value_task_metrics > array |
events.single_value_task_metrics
Name | Description | Schema |
---|---|---|
task optional | Task ID | string |
task_name optional | Task name | string |
values optional | < values > array |
values
Name | Schema |
---|---|
metric optional | string |
timestamp optional | number |
value optional | number |
variant optional | string |
events.task_log_event
A log event associated with a task.
Name | Description | Schema |
---|---|---|
level optional | Log level. | events.log_level_enum |
msg optional | Log message. | string |
task required | Task ID (required) | string |
timestamp optional | Epoch milliseconds UTC, will be set by the server if not set. | number |
type required | 'log' | string |
worker optional | Name of machine running the task. | string |
events.task_metric
Name | Description | Schema |
---|---|---|
metric optional | Metric name | string |
task required | Task ID | string |
events.task_metric_variants
Name | Description | Schema |
---|---|---|
metric optional | Metric name | string |
task required | Task ID | string |
variants optional | Metric variant names | < string > array |
models.last_metrics_event
Name | Description | Schema |
---|---|---|
max_value optional | Maximum value reported | number |
max_value_iteration optional | The iteration at which the maximum value was reported | integer |
metric optional | Metric name | string |
min_value optional | Minimum value reported | number |
min_value_iteration optional | The iteration at which the minimum value was reported | integer |
value optional | Last value reported | number |
variant optional | Variant name | string |
models.last_metrics_variants
Last metric events, one for each variant hash
Type : < string, models.last_metrics_event > map
models.metadata_item
Name | Description | Schema |
---|---|---|
key optional | The key uniquely identifying the metadata item inside the given entity | string |
type optional | The type of the metadata item | string |
value optional | The value stored in the metadata item | string |
models.model
Name | Description | Schema |
---|---|---|
comment optional | Model comment | string |
company optional | Company id | string |
created optional | Model creation time | string (date-time) |
design optional | Json object representing the model design. Should be identical to the network design of the task which created the model | object |
framework optional | Framework on which the model is based. Should be identical to the framework of the task which created the model | string |
id optional | Model id | string |
labels optional | Json object representing the ids of the labels in the model. The keys are the layers' names and the values are the ids. | < string, integer > map |
last_iteration optional | Last iteration reported for this model | integer |
last_metrics optional | Last metric variants (hash to events), one for each metric hash | < string, models.last_metrics_variants > map |
last_update optional | Model last update time | string (date-time) |
metadata optional | Model metadata | < string, models.metadata_item > map |
name optional | Model name | string |
parent optional | Parent model ID | string |
project optional | Associated project ID | string |
ready optional | Indication if the model is final and can be used by other tasks | boolean |
stats optional | Model statistics | stats |
system_tags optional | System tags. This field is reserved for system use, please don't use it. | < string > array |
tags optional | User-defined tags | < string > array |
task optional | Task ID of task in which the model was created | string |
ui_cache optional | UI cache for this model | object |
uri optional | URI for the model, pointing to the destination storage. | string |
user optional | Associated user id | string |
stats
Name | Description | Schema |
---|---|---|
labels_count optional | Number of the model labels | integer |
models.multi_field_pattern_data
Name | Description | Schema |
---|---|---|
fields optional | List of field names | < string > array |
pattern optional | Pattern string (regex) | string |
organization.field_mapping
Name | Description | Schema |
---|---|---|
field required | The source field name as specified in the only_fields | string |
name optional | The column name in the exported csv file | string |
values optional | < organization.value_mapping > array |
organization.value_mapping
Name | Description | Schema |
---|---|---|
key required | Original value | object |
value required | Translated value | object |
projects.metric_variant_result
Name | Description | Schema |
---|---|---|
metric optional | Metric name | string |
metric_hash optional | Metric name hash. Used instead of the metric name when categorizing last metrics events in task objects. | string |
variant optional | Variant name | string |
variant_hash optional | Variant name hash. Used instead of the variant name when categorizing last metrics events in task objects. | string |
projects.multi_field_pattern_data
Name | Description | Schema |
---|---|---|
fields optional | List of field names | < string > array |
pattern optional | Pattern string (regex) | string |
projects.project
Name | Description | Schema |
---|---|---|
basename optional | Project base name | string |
company optional | Company id | string |
created optional | Creation time | string (date-time) |
default_output_destination optional | The default output destination URL for new tasks under this project | string |
description optional | Project description | string |
id optional | Project id | string |
last_update optional | Last project update time. Reflects the last time the project metadata was changed or a task in this project has changed status | string (date-time) |
name optional | Project name | string |
system_tags optional | System tags. This field is reserved for system use, please don't use it. | < string > array |
tags optional | User-defined tags | < string > array |
user optional | Associated user id | string |
projects.projects_get_all_response_single
Name | Description | Schema |
---|---|---|
basename optional | Project base name | string |
company optional | Company id | string |
created optional | Creation time | string (date-time) |
dataset_stats optional | Project dataset statistics | dataset_stats |
default_output_destination optional | The default output destination URL for new tasks under this project | string |
description optional | Project description | string |
hidden optional | Returned if the search_hidden flag was specified in the get_all_ex call and the project is hidden | boolean |
id optional | Project id | string |
last_update optional | Last project update time. Reflects the last time the project metadata was changed or a task in this project has changed status | string (date-time) |
name optional | Project name | string |
own_datasets optional | The amount of datasets/hyperdatasers under this project (without children projects). Returned if 'check_own_contents' flag is set in the request and children_type is set to 'dataset' or 'hyperdataset' | integer |
own_models optional | The amount of models under this project (without children projects). Returned if 'check_own_contents' flag is set in the request | integer |
own_tasks optional | The amount of tasks under this project (without children projects). Returned if 'check_own_contents' flag is set in the request | integer |
stats optional | Additional project stats | projects.stats |
sub_projects optional | The list of sub projects | < sub_projects > array |
system_tags optional | System tags. This field is reserved for system use, please don't use it. | < string > array |
tags optional | User-defined tags | < string > array |
user optional | Associated user id | string |
dataset_stats
Name | Description | Schema |
---|---|---|
file_count optional | The number of files stored in the dataset | integer |
total_size optional | The total dataset size in bytes | integer |
sub_projects
Name | Description | Schema |
---|---|---|
id optional | Subproject ID | string |
name optional | Subproject name | string |
projects.stats
Name | Description | Schema |
---|---|---|
active optional | Stats for active tasks | projects.stats_status_count |
archived optional | Stats for archived tasks | projects.stats_status_count |
datasets optional | Stats for childrent datasets | projects.stats_datasets |
projects.stats_datasets
Name | Description | Schema |
---|---|---|
count optional | Number of datasets | integer |
tags optional | Dataset tags | < string > array |
projects.stats_status_count
Name | Description | Schema |
---|---|---|
completed_tasks_24h optional | Number of tasks completed in the last 24 hours | integer |
last_task_run optional | The most recent started time of a task | integer |
status_count optional | Status counts | status_count |
total_runtime optional | Total run time of all tasks in project (in seconds) | integer |
total_tasks optional | Number of tasks | integer |
status_count
Name | Description | Schema |
---|---|---|
closed optional | Number of 'closed' tasks in project | integer |
completed optional | Number of 'completed' tasks in project | integer |
created optional | Number of 'created' tasks in project | integer |
failed optional | Number of 'failed' tasks in project | integer |
in_progress optional | Number of 'in_progress' tasks in project | integer |
published optional | Number of 'published' tasks in project | integer |
queued optional | Number of 'queued' tasks in project | integer |
stopped optional | Number of 'stopped' tasks in project | integer |
unknown optional | Number of 'unknown' tasks in project | integer |
projects.urls
Name | Schema |
---|---|
artifact_urls optional | < string > array |
event_urls optional | < string > array |
model_urls optional | < string > array |
queues.entry
Name | Description | Schema |
---|---|---|
added optional | Time this entry was added to the queue | string (date-time) |
task optional | Queued task ID | string |
queues.metadata_item
Name | Description | Schema |
---|---|---|
key optional | The key uniquely identifying the metadata item inside the given entity | string |
type optional | The type of the metadata item | string |
value optional | The value stored in the metadata item | string |
queues.queue
Name | Description | Schema |
---|---|---|
company optional | Company id | string |
created optional | Queue creation time | string (date-time) |
entries optional | List of ordered queue entries | < queues.entry > array |
id optional | Queue id | string |
metadata optional | Queue metadata | < string, queues.metadata_item > map |
name optional | Queue name | string |
system_tags optional | System tags. This field is reserved for system use, please don't use it. | < string > array |
tags optional | User-defined tags | < string > array |
user optional | Associated user id | string |
queues.queue_metrics
Name | Description | Schema |
---|---|---|
avg_waiting_times optional | List of average waiting times for tasks in the queue. The points correspond to the timestamps in the dates list. If more than one value exists for the given interval then the maximum value is taken. | < number > array |
dates optional | List of timestamps (in seconds from epoch) in the acceding order. The timestamps are separated by the requested interval. Timestamps where no queue status change was recorded are omitted. | < integer > array |
queue optional | ID of the queue | string |
queue_lengths optional | List of tasks counts in the queue. The points correspond to the timestamps in the dates list. If more than one value exists for the given interval then the count that corresponds to the maximum average value is taken. | < integer > array |
reports.artifact
Name | Description | Schema |
---|---|---|
content_size optional | Raw data length in bytes | integer |
display_data optional | User-defined list of key/value pairs, sorted | < < string > array > array |
hash optional | Hash of entire raw data | string |
key required | Entry key | string |
mode optional | System defined input/output indication | reports.artifact_mode_enum |
timestamp optional | Epoch time when artifact was created | integer |
type required | System defined type | string |
type_data optional | Additional fields defined by the system | reports.artifact_type_data |
uri optional | Raw data location | string |
reports.artifact_mode_enum
Type : enum (input, output)
reports.artifact_type_data
Name | Description | Schema |
---|---|---|
content_type optional | System defined raw data content type | string |
data_hash optional | Hash of raw data, without any headers or descriptive parts | string |
preview optional | Description or textual data | string |
reports.configuration_item
Name | Description | Schema |
---|---|---|
description optional | The parameter description. Optional | string |
name optional | Name of the parameter. Should be unique | string |
type optional | Type of the parameter. Optional | string |
value optional | Value of the parameter | string |
reports.debug_images_response_task_metrics
Name | Description | Schema |
---|---|---|
iterations optional | < iterations > array | |
task optional | Task ID | string |
iterations
Name | Description | Schema |
---|---|---|
events optional | < object > array | |
iter optional | Iteration number | integer |
reports.execution
Name | Description | Schema |
---|---|---|
artifacts optional | Task artifacts | < reports.artifact > array |
docker_cmd optional | Command for running docker script for the execution of the task | string |
framework optional | Framework related to the task. Case insensitive. Mandatory for Training tasks. | string |
model optional | Execution input model ID Not applicable for Register (Import) tasks | string |
model_desc optional | Json object representing the Model descriptors | object |
model_labels optional | Json object representing the ids of the labels in the model. The keys are the layers' names and the values are the IDs. Not applicable for Register (Import) tasks. Mandatory for Training tasks | < string, integer > map |
parameters optional | Json object containing the Task parameters | object |
queue optional | Queue ID where task was queued. | string |
reports.last_metrics_event
Name | Description | Schema |
---|---|---|
max_value optional | Maximum value reported | number |
max_value_iteration optional | The iteration at which the maximum value was reported | integer |
metric optional | Metric name | string |
min_value optional | Minimum value reported | number |
min_value_iteration optional | The iteration at which the minimum value was reported | integer |
value optional | Last value reported | number |
variant optional | Variant name | string |
reports.last_metrics_variants
Last metric events, one for each variant hash
Type : < string, reports.last_metrics_event > map
reports.metric_variants
Name | Description | Schema |
---|---|---|
metric optional | The metric name | string |
variants optional | The names of the metric variants | < string > array |
reports.multi_field_pattern_data
Name | Description | Schema |
---|---|---|
fields optional | List of field names | < string > array |
pattern optional | Pattern string (regex) | string |
reports.output
Name | Description | Schema |
---|---|---|
destination optional | Storage id. This is where output files will be stored. | string |
error optional | Last error text | string |
model optional | Model id. | string |
result optional | Task result. Values: 'success', 'failure' | string |
reports.params_item
Name | Description | Schema |
---|---|---|
description optional | The parameter description. Optional | string |
name optional | Name of the parameter. The combination of section and name should be unique | string |
section optional | Section that the parameter belongs to | string |
type optional | Type of the parameter. Optional | string |
value optional | Value of the parameter | string |
reports.report
Name | Description | Schema |
---|---|---|
comment optional | Free text comment | string |
company optional | Company ID | string |
created optional | Report creation time (UTC) | string (date-time) |
id optional | Report id | string |
last_update optional | Last time this report was created, edited, changed | string (date-time) |
name optional | Report Name | string |
project optional | Project ID of the project to which this report is assigned | string |
published optional | Report publish time | string (date-time) |
report optional | Report template | string |
report_assets optional | List of the external report assets | < string > array |
status optional | reports.report_status_enum | |
status_changed optional | Last status change time | string (date-time) |
status_message optional | free text string representing info about the status | string |
status_reason optional | Reason for last status change | string |
system_tags optional | System tags list. This field is reserved for system use, please don't use it. | < string > array |
tags optional | User-defined tags list | < string > array |
user optional | Associated user id | string |
reports.report_status_enum
Type : enum (created, published)
reports.scalar_key_enum
Type : enum (iter, timestamp, iso_time)
reports.script
Name | Description | Schema |
---|---|---|
binary optional | Binary to use when running the script Default : "python" | string |
branch optional | Repository branch id If not provided and tag not provided, default repository branch is used. | string |
diff optional | Uncommitted changes found in the repository when task was run | string |
entry_point optional | Path to execute within the repository | string |
repository optional | Name of the repository where the script is located | string |
requirements optional | A JSON object containing requirements strings by key | object |
tag optional | Repository tag | string |
version_num optional | Version (changeset) number. Optional (default is head version) Unused if tag is provided. | string |
working_dir optional | Path to the folder from which to run the script Default - root folder of repository | string |
reports.section_params
Task section params
Type : < string, reports.params_item > map
reports.single_value_task_metrics
Name | Description | Schema |
---|---|---|
task optional | Task ID | string |
task_name optional | Task name | string |
values optional | < values > array |
values
Name | Schema |
---|---|
metric optional | string |
timestamp optional | number |
value optional | number |
variant optional | string |
reports.task
Name | Description | Schema |
---|---|---|
active_duration optional | Task duration time (seconds) | integer |
comment optional | Free text comment | string |
company optional | Company ID | string |
completed optional | Task end time (UTC) | string (date-time) |
configuration optional | Task configuration params | < string, reports.configuration_item > map |
container optional | Docker container parameters | < string, string > map |
created optional | Task creation time (UTC) | string (date-time) |
execution optional | Task execution params | reports.execution |
hyperparams optional | Task hyper params per section | < string, reports.section_params > map |
id optional | Task id | string |
last_change optional | Last time any update was done to the task | string (date-time) |
last_iteration optional | Last iteration reported for this task | integer |
last_metrics optional | Last metric variants (hash to events), one for each metric hash | < string, reports.last_metrics_variants > map |
last_update optional | Last time this task was created, edited, changed or events for this task were reported | string (date-time) |
last_worker optional | ID of last worker that handled the task | string |
last_worker_report optional | Last time a worker reported while working on this task | string (date-time) |
models optional | Task models | reports.task_models |
name optional | Task Name | string |
output optional | Task output params | reports.output |
parent optional | Parent task id | string |
project optional | Project ID of the project to which this task is assigned | string |
published optional | Task publish time | string (date-time) |
runtime optional | Task runtime mapping | object |
script optional | Script info | reports.script |
started optional | Task start time (UTC) | string (date-time) |
status optional | reports.task_status_enum | |
status_changed optional | Last status change time | string (date-time) |
status_message optional | free text string representing info about the status | string |
status_reason optional | Reason for last status change | string |
system_tags optional | System tags list. This field is reserved for system use, please don't use it. | < string > array |
tags optional | User-defined tags list | < string > array |
type optional | Type of task. Values: 'training', 'testing' | reports.task_type_enum |
user optional | Associated user id | string |
reports.task_model_item
Name | Description | Schema |
---|---|---|
model required | The model ID | string |
name required | The task model name | string |
reports.task_models
Name | Description | Schema |
---|---|---|
input optional | The list of task input models | < reports.task_model_item > array |
output optional | The list of task output models | < reports.task_model_item > array |
reports.task_status_enum
Type : enum (created, queued, in_progress, stopped, published, publishing, closed, failed, completed, unknown)
reports.task_type_enum
Type : enum (training, testing, inference, data_processing, application, monitor, controller, optimizer, service, qc, custom)
tasks.artifact
Name | Description | Schema |
---|---|---|
content_size optional | Raw data length in bytes | integer |
display_data optional | User-defined list of key/value pairs, sorted | < < string > array > array |
hash optional | Hash of entire raw data | string |
key required | Entry key | string |
mode optional | System defined input/output indication | tasks.artifact_mode_enum |
timestamp optional | Epoch time when artifact was created | integer |
type required | System defined type | string |
type_data optional | Additional fields defined by the system | tasks.artifact_type_data |
uri optional | Raw data location | string |
tasks.artifact_id
Name | Description | Schema |
---|---|---|
key required | Entry key | string |
mode optional | System defined input/output indication | tasks.artifact_mode_enum |
tasks.artifact_mode_enum
Type : enum (input, output)
tasks.artifact_type_data
Name | Description | Schema |
---|---|---|
content_type optional | System defined raw data content type | string |
data_hash optional | Hash of raw data, without any headers or descriptive parts | string |
preview optional | Description or textual data | string |
tasks.configuration_item
Name | Description | Schema |
---|---|---|
description optional | The parameter description. Optional | string |
name optional | Name of the parameter. Should be unique | string |
type optional | Type of the parameter. Optional | string |
value optional | Value of the parameter | string |
tasks.execution
Name | Description | Schema |
---|---|---|
artifacts optional | Task artifacts | < tasks.artifact > array |
docker_cmd optional | Command for running docker script for the execution of the task | string |
framework optional | Framework related to the task. Case insensitive. Mandatory for Training tasks. | string |
model optional | Execution input model ID Not applicable for Register (Import) tasks | string |
model_desc optional | Json object representing the Model descriptors | object |
model_labels optional | Json object representing the ids of the labels in the model. The keys are the layers' names and the values are the IDs. Not applicable for Register (Import) tasks. Mandatory for Training tasks | < string, integer > map |
parameters optional | Json object containing the Task parameters | object |
queue optional | Queue ID where task was queued. | string |
tasks.last_metrics_event
Name | Description | Schema |
---|---|---|
max_value optional | Maximum value reported | number |
max_value_iteration optional | The iteration at which the maximum value was reported | integer |
metric optional | Metric name | string |
min_value optional | Minimum value reported | number |
min_value_iteration optional | The iteration at which the minimum value was reported | integer |
value optional | Last value reported | number |
variant optional | Variant name | string |
tasks.last_metrics_variants
Last metric events, one for each variant hash
Type : < string, tasks.last_metrics_event > map
tasks.model_type_enum
Type : enum (input, output)
tasks.multi_field_pattern_data
Name | Description | Schema |
---|---|---|
fields optional | List of field names | < string > array |
pattern optional | Pattern string (regex) | string |
tasks.output
Name | Description | Schema |
---|---|---|
destination optional | Storage id. This is where output files will be stored. | string |
error optional | Last error text | string |
model optional | Model id. | string |
result optional | Task result. Values: 'success', 'failure' | string |
tasks.param_key
Name | Description | Schema |
---|---|---|
name optional | Name of the parameter. If the name is ommitted then the corresponding operation is performed on the whole section | string |
section optional | Section that the parameter belongs to | string |
tasks.params_item
Name | Description | Schema |
---|---|---|
description optional | The parameter description. Optional | string |
name optional | Name of the parameter. The combination of section and name should be unique | string |
section optional | Section that the parameter belongs to | string |
type optional | Type of the parameter. Optional | string |
value optional | Value of the parameter | string |
tasks.replace_hyperparams_enum
Type : enum (none, section, all)
tasks.script
Name | Description | Schema |
---|---|---|
binary optional | Binary to use when running the script Default : "python" | string |
branch optional | Repository branch id If not provided and tag not provided, default repository branch is used. | string |
diff optional | Uncommitted changes found in the repository when task was run | string |
entry_point optional | Path to execute within the repository | string |
repository optional | Name of the repository where the script is located | string |
requirements optional | A JSON object containing requirements strings by key | object |
tag optional | Repository tag | string |
version_num optional | Version (changeset) number. Optional (default is head version) Unused if tag is provided. | string |
working_dir optional | Path to the folder from which to run the script Default - root folder of repository | string |
tasks.section_params
Task section params
Type : < string, tasks.params_item > map
tasks.task
Name | Description | Schema |
---|---|---|
active_duration optional | Task duration time (seconds) | integer |
comment optional | Free text comment | string |
company optional | Company ID | string |
completed optional | Task end time (UTC) | string (date-time) |
configuration optional | Task configuration params | < string, tasks.configuration_item > map |
container optional | Docker container parameters | < string, string > map |
created optional | Task creation time (UTC) | string (date-time) |
execution optional | Task execution params | tasks.execution |
hyperparams optional | Task hyper params per section | < string, tasks.section_params > map |
id optional | Task id | string |
last_change optional | Last time any update was done to the task | string (date-time) |
last_iteration optional | Last iteration reported for this task | integer |
last_metrics optional | Last metric variants (hash to events), one for each metric hash | < string, tasks.last_metrics_variants > map |
last_update optional | Last time this task was created, edited, changed or events for this task were reported | string (date-time) |
last_worker optional | ID of last worker that handled the task | string |
last_worker_report optional | Last time a worker reported while working on this task | string (date-time) |
models optional | Task models | tasks.task_models |
name optional | Task Name | string |
output optional | Task output params | tasks.output |
parent optional | Parent task id | string |
project optional | Project ID of the project to which this task is assigned | string |
published optional | Task publish time | string (date-time) |
runtime optional | Task runtime mapping | object |
script optional | Script info | tasks.script |
started optional | Task start time (UTC) | string (date-time) |
status optional | tasks.task_status_enum | |
status_changed optional | Last status change time | string (date-time) |
status_message optional | free text string representing info about the status | string |
status_reason optional | Reason for last status change | string |
system_tags optional | System tags list. This field is reserved for system use, please don't use it. | < string > array |
tags optional | User-defined tags list | < string > array |
type optional | Type of task. Values: 'training', 'testing' | tasks.task_type_enum |
user optional | Associated user id | string |
tasks.task_model_item
Name | Description | Schema |
---|---|---|
model required | The model ID | string |
name required | The task model name | string |
tasks.task_models
Name | Description | Schema |
---|---|---|
input optional | The list of task input models | < tasks.task_model_item > array |
output optional | The list of task output models | < tasks.task_model_item > array |
tasks.task_status_enum
Type : enum (created, queued, in_progress, stopped, published, publishing, closed, failed, completed, unknown)
tasks.task_type_enum
Type : enum (training, testing, inference, data_processing, application, monitor, controller, optimizer, service, qc, custom)
tasks.task_urls
Name | Schema |
---|---|
artifact_urls optional | < string > array |
event_urls optional | < string > array |
model_urls optional | < string > array |
users.get_current_user_response_user_object
like user, but returns company object instead of ID
Name | Description | Schema |
---|---|---|
avatar optional | string | |
company optional | company | |
family_name optional | string | |
given_name optional | string | |
id optional | string | |
name optional | string | |
preferences optional | User preferences | object |
role optional | string |
company
Name | Schema |
---|---|
id optional | string |
name optional | string |
users.user
Name | Description | Schema |
---|---|---|
avatar optional | Avatar URL | string |
company optional | Company ID | string |
created optional | User creation date | string (date-time) |
email optional | User email | string (email) |
family_name optional | Family name | string |
given_name optional | Given name | string |
id optional | User ID | string |
name optional | Full name | string |
providers optional | Providers uses has logged-in with | object |
role optional | User's role (admin only) | string |
workers.activity_series
Name | Description | Schema |
---|---|---|
counts optional | List of worker counts corresponding to the timestamps in the dates list. None values are returned for the dates with no workers. | < integer > array |
dates optional | List of timestamps (in seconds from epoch) in the acceding order. The timestamps are separated by the requested interval. | < integer > array |
workers.aggregation_stats
Name | Description | Schema |
---|---|---|
aggregation optional | workers.aggregation_type | |
values optional | List of values corresponding to the dates in metric statistics | < number > array |
workers.aggregation_type
Metric aggregation type
Type : enum (avg, min, max)
workers.current_task_entry
Name | Description | Schema |
---|---|---|
id optional | Worker ID | string |
last_iteration optional | Last task iteration | integer |
name optional | Worker name | string |
running_time optional | Task running time | integer |
workers.id_name_entry
Name | Description | Schema |
---|---|---|
id optional | Worker ID | string |
name optional | Worker name | string |
workers.machine_stats
Name | Description | Schema |
---|---|---|
cpu_temperature optional | CPU temperature | < number > array |
cpu_usage optional | Average CPU usage per core | < number > array |
disk_free_home optional | Mbytes free space of /home drive | integer |
disk_free_temp optional | Mbytes free space of /tmp drive | integer |
disk_read optional | Mbytes read per second | integer |
disk_write optional | Mbytes write per second | integer |
gpu_memory_free optional | GPU free memory MBs | < integer > array |
gpu_memory_used optional | GPU used memory MBs | < integer > array |
gpu_temperature optional | GPU temperature | < number > array |
gpu_usage optional | Average GPU usage per GPU card | < number > array |
memory_free optional | Free memory MBs | integer |
memory_used optional | Used memory MBs | integer |
network_rx optional | Mbytes per second | integer |
network_tx optional | Mbytes per second | integer |
workers.metric_stats
Name | Description | Schema |
---|---|---|
dates optional | List of timestamps (in seconds from epoch) in the acceding order. The timestamps are separated by the requested interval. Timestamps where no workers activity was recorded are omitted. | < integer > array |
metric optional | Name of the metric (cpu_usage, memory_used etc.) | string |
stats optional | Statistics data by type | < workers.aggregation_stats > array |
variant optional | Name of the metric component. Set only if 'split_by_variant' was set in the request | string |
workers.metrics_category
Name | Description | Schema |
---|---|---|
metric_keys optional | The names of the metrics in the category. | < string > array |
name optional | Name of the metrics category. | string |
workers.queue_entry
Name | Description | Schema |
---|---|---|
id optional | Worker ID | string |
name optional | Worker name | string |
next_task optional | Next task in the queue | workers.id_name_entry |
num_tasks optional | Number of task entries in the queue | integer |
workers.stat_item
Name | Description | Schema |
---|---|---|
category optional | workers.aggregation_type | |
key optional | Name of a metric | string |
workers.worker
Name | Description | Schema |
---|---|---|
company optional | Associated company | workers.id_name_entry |
id optional | Worker ID | string |
ip optional | IP of the worker | string |
key optional | Worker entry key | string |
last_activity_time optional | Last activity time (even if an error occurred) | string (date-time) |
last_report_time optional | Last successful report time | string (date-time) |
project optional | Project in which currently executing task resides | workers.id_name_entry |
queue optional | Queue from which running task was taken | workers.queue_entry |
queues optional | List of queues on which the worker is listening | < workers.queue_entry > array |
register_time optional | Registration time | string (date-time) |
system_tags optional | System tags for the worker | < string > array |
tags optional | User tags for the worker | < string > array |
task optional | Task currently being run by the worker | workers.current_task_entry |
user optional | Associated user (under whose credentials are used by the worker daemon) | workers.id_name_entry |
workers.worker_stats
Name | Description | Schema |
---|---|---|
metrics optional | List of the metrics statistics for the worker | < workers.metric_stats > array |
worker optional | ID of the worker | string |