events
POST /events.add
Description
Adds a single event
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| allow_locked optional | Allow adding events to published tasks or models Default : false | boolean |
| model_event optional | If set then the event is for a model. Otherwise for a task. Cannot be used with task log events. If used in batch then all the events should be marked the same Default : false | boolean |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | object |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.add_batch
Description
Adds a batch of events in a single call (json-lines format, stream-friendly)
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | requests required | Json encoded newline-terminated lines, each representing an event in the batch and uses the same parameters used for events.add | < object > array |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Schema |
|---|---|
| added optional | integer |
| errors optional | integer |
| errors_info optional | object |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.clear_scroll
Description
Clear an open Scroll ID
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| scroll_id required | Scroll ID as returned by previous events service calls | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | object |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.clear_task_log
Description
Remove old logs from task
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| allow_locked optional | Allow deleting events even if the task is locked Default : false | boolean |
| exclude_metrics optional | If passed then events for these metrics are retained | < string > array |
| include_metrics optional | If passed then only events for these metrics are deleted | < string > array |
| task required | Task ID | string |
| threshold_sec optional | The amount of seconds ago to retain the log records. The older log records will be deleted. If not passed or 0 then all the log records for the task will be deleted | integer |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| deleted optional | The number of deleted log records | integer |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.debug_images
Description
Get the debug image events for the requested amount of iterations per each task
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| iters optional | Max number of latest iterations for which to return debug images | integer |
| metrics required | List of metrics and variants | < events.task_metric_variants > array |
| model_events optional | If set then the retrieving model events. Otherwise task events Default : false | boolean |
| navigate_earlier optional | If set then events are retreived from latest iterations to earliest ones. Otherwise from earliest iterations to the latest. The default is True | boolean |
| refresh optional | If set then scroll will be moved to the latest iterations. The default is False | boolean |
| scroll_id optional | Scroll ID of previous call (used for getting more results) | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | events.debug_images_response |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.delete_for_model
Description
Delete all model events. This cannot be undone!
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| allow_locked optional | Allow deleting events even if the model is locked Default : false | boolean |
| model required | Model ID | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| deleted optional | Number of deleted events | boolean |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.delete_for_task
Description
Delete all task events. This cannot be undone!
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| allow_locked optional | Allow deleting events even if the task is locked Default : false | boolean |
| task required | Task ID | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| deleted optional | Number of deleted events | boolean |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.download_task_log
Description
Get an attachment containing the task's log
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| line_format optional | Line string format. Used if the line type is 'text' Default : "{asctime} {worker} {level} {msg}" | string |
| line_type optional | Line format type | enum (json, text) |
| task required | Task ID | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | string |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.get_debug_image_sample
Description
Return the debug image per metric and variant for the provided iteration
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| iteration optional | The iteration to bring debug image from. If not specified then the latest reported image is retrieved | integer |
| metric required | Metric name | string |
| model_events optional | If set then the retrieving model debug images. Otherwise task debug images Default : false | boolean |
| navigate_current_metric optional | If set then subsequent navigation with next_debug_image_sample is done on the debug images for the passed metric only. Otherwise for all the metrics Default : true | boolean |
| refresh optional | If set then scroll state will be refreshed to reflect the latest changes in the debug images | boolean |
| scroll_id optional | Scroll ID from the previous call to get_debug_image_sample or empty | string |
| task required | Task ID | string |
| variant required | Metric variant | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | events.debug_image_sample_response |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.get_multi_task_metrics
Description
Get unique metrics and variants from the events of the specified type. Only
events reported for the passed task or model ids are analyzed.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| event_type optional | Event type. If not specified then metrics are collected from the reported events of all types | events.event_type_enum |
| model_events optional | If not set or set to Falsethen passed ids are task ids otherwise model ids Default : false | boolean |
| tasks required | task ids to get metrics from | < string > array |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| metrics optional | List of metrics and variants | < events.metric_variants > array |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.get_multi_task_plots
Description
Get 'plot' events for the given tasks
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| iters optional | Max number of latest iterations for which to return plots | integer |
| last_iters_per_task_metric optional | If set to 'true' and iters passed then last iterations for each task metrics are retrieved. Otherwise last iterations for the whole task are retrieved Default : true | boolean |
| metrics optional | List of metrics and variants | < events.metric_variants > array |
| model_events optional | If set then the retrieving model events. Otherwise task events Default : false | boolean |
| no_scroll optional | If Truethen no scroll is created. Suitable for one time calls Default : false | boolean |
| scroll_id optional | Scroll ID of previous call (used for getting more results) | string |
| tasks required | List of task IDs | < string > array |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| plots optional | Plots mapping (keyed by task name) | object |
| returned optional | Number of results returned | integer |
| scroll_id optional | Scroll ID for getting more results | string |
| total optional | Total number of results available for this query. In case there are more than 10000 results it is set to 10000 | number |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.get_plot_sample
Description
Return plots for the provided iteration
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| iteration optional | The iteration to bring plot from. If not specified then the latest reported plot is retrieved | integer |
| metric required | Metric name | string |
| model_events optional | If set then the retrieving model plots. Otherwise task plots Default : false | boolean |
| navigate_current_metric optional | If set then subsequent navigation with next_plot_sample is done on the plots for the passed metric only. Otherwise for all the metrics Default : true | boolean |
| refresh optional | If set then scroll state will be refreshed to reflect the latest changes in the plots | boolean |
| scroll_id optional | Scroll ID from the previous call to get_plot_sample or empty | string |
| task required | Task ID | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | events.plot_sample_response |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.get_scalar_metric_data
Description
get scalar metric data for task
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| metric optional | type of metric | string |
| model_events optional | If set then the retrieving model events. Otherwise task events Default : false | boolean |
| no_scroll optional | If Truethen no scroll is created. Suitable for one time calls Default : false | boolean |
| scroll_id optional | Scroll ID of previous call (used for getting more results) | string |
| task optional | task ID | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| events optional | task scalar metric events | < object > array |
| returned optional | amount of events returned | integer |
| scroll_id optional | Scroll ID for getting more results | string |
| total optional | amount of events in task | integer |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.get_scalar_metrics_and_variants
Description
get task scalar metrics and variants
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| model_events optional | If set then the retrieving model events. Otherwise task events Default : false | boolean |
| task required | task ID | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Schema |
|---|---|
| metrics optional | object |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.get_task_events
Description
Scroll through task events, sorted by timestamp
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| batch_size optional | Number of events to return each time (default 500) | integer |
| event_type optional | Return only events of this type | string |
| metrics optional | List of metrics and variants | < events.metric_variants > array |
| model_events optional | If set then get retrieving model events. Otherwise task events Default : false | boolean |
| order optional | 'asc' (default) or 'desc'. | enum (asc, desc) |
| scroll_id optional | Pass this value on next call to get next page | string |
| task required | Task ID | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| events optional | Events list | < object > array |
| returned optional | Number of results returned | integer |
| scroll_id optional | Scroll ID for getting more results | string |
| total optional | Total number of results available for this query. In case there are more than 10000 results it is set to 10000 | number |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.get_task_latest_scalar_values
Description
Get the tasks's latest scalar values
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| task required | Task ID | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Schema |
|---|---|
| metrics optional | < metrics > array |
metrics
| Name | Description | Schema |
|---|---|---|
| name optional | Metric name | string |
| variants optional | < variants > array |
variants
| Name | Description | Schema |
|---|---|---|
| last_100_value optional | Average of 100 last reported values | number |
| last_value optional | Last reported value | number |
| name optional | Variant name | string |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.get_task_log
Description
Get 'log' events for this task
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| batch_size optional | The amount of log events to return | integer |
| from_timestamp optional | Epoch time in UTC ms to use as the navigation start. Optional. If not provided, reference timestamp is determined by the 'navigate_earlier' parameter (if true, reference timestamp is the last timestamp and if false, reference timestamp is the first timestamp) | number |
| metrics optional | List of metrics and variants | < events.metric_variants > array |
| navigate_earlier optional | If set then log events are retreived from the latest to the earliest ones (in timestamp descending order, unless order='asc'). Otherwise from the earliest to the latest ones (in timestamp ascending order, unless order='desc'). The default is True | boolean |
| order optional | If set, changes the order in which log events are returned based on the value of 'navigate_earlier' | enum (asc, desc) |
| task required | Task ID | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| events optional | Log items list | < object > array |
| returned optional | Number of log events returned | integer |
| total optional | Total number of log events available for this query. In case there are more than 10000 events it is set to 10000 | number |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.get_task_metrics
Description
For each task, get a list of metrics for which the requested event type was
reported
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| event_type optional | Event type | events.event_type_enum |
| model_events optional | If set then get metrics from model events. Otherwise from task events Default : false | boolean |
| tasks required | Task IDs | < string > array |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| metrics optional | List of task with their metrics | < object > array |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.get_task_plots
Description
Get all 'plot' events for this task
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| iters optional | Max number of latest iterations for which to return plots | integer |
| metrics optional | List of metrics and variants | < events.metric_variants > array |
| model_events optional | If set then the retrieving model events. Otherwise task events Default : false | boolean |
| no_scroll optional | If Truethen no scroll is created. Suitable for one time calls Default : false | boolean |
| scroll_id optional | Scroll ID of previous call (used for getting more results) | string |
| task required | Task ID | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| plots optional | Plots list | < object > array |
| returned optional | Number of results returned | integer |
| scroll_id optional | Scroll ID for getting more results | string |
| total optional | Total number of results available for this query. In case there are more than 10000 results it is set to 10000 | number |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.get_task_single_value_metrics
Description
Get single value metrics for the passed tasks
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| metrics optional | List of metrics and variants | < events.metric_variants > array |
| model_events optional | If set then the retrieving model events. Otherwise task events Default : false | boolean |
| tasks required | List of task Task IDs | < string > array |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | events.single_value_metrics_response |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.get_vector_metrics_and_variants
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| model_events optional | If set then the retrieving model events. Otherwise task events Default : false | boolean |
| task required | Task ID | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Schema |
|---|---|
| metrics optional | < object > array |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.multi_task_scalar_metrics_iter_histogram
Description
Used to compare scalar stats histogram of multiple tasks
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| key optional | Histogram x axis to use: iter - iteration number iso_time - event time as ISO formatted string timestamp - event timestamp as milliseconds since epoch | events.scalar_key_enum |
| metrics optional | List of metrics and variants | < events.metric_variants > array |
| model_events optional | If set then the retrieving model events. Otherwise task events Default : false | boolean |
| samples optional | The amount of histogram points to return. Optional, the default value is 6000 | integer |
| tasks required | List of task Task IDs. Maximum amount of tasks is 100 | < string > array |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | object |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.next_debug_image_sample
Description
Get the image for the next variant for the same iteration or for the next
iteration
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| model_events optional | If set then the retrieving model debug images. Otherwise task debug images Default : false | boolean |
| navigate_earlier optional | If set then get the either previous variant event from the current iteration or (if does not exist) the last variant event from the previous iteration. Otherwise next variant event from the current iteration or first variant event from the next iteration | boolean |
| next_iteration optional | If set then navigate to the next/previous iteration Default : false | boolean |
| scroll_id required | Scroll ID from the previous call to get_debug_image_sample | string |
| task required | Task ID | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | events.debug_image_sample_response |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.next_plot_sample
Description
Get the plot for the next metric for the same iteration or for the next
iteration
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| model_events optional | If set then the retrieving model plots. Otherwise task plots Default : false | boolean |
| navigate_earlier optional | If set then get the either previous metric events from the current iteration or (if does not exist) the last metric events from the previous iteration. Otherwise next metric events from the current iteration or first metric events from the next iteration | boolean |
| next_iteration optional | If set then navigate to the next/previous iteration Default : false | boolean |
| scroll_id required | Scroll ID from the previous call to get_plot_sample | string |
| task required | Task ID | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | events.plot_sample_response |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.plots
Description
Get plot events for the requested amount of iterations per each task
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| iters optional | Max number of latest iterations for which to return plots | integer |
| metrics required | List of metrics and variants | < events.task_metric_variants > array |
| model_events optional | If set then the retrieving model plots. Otherwise task plots Default : false | boolean |
| navigate_earlier optional | If set then events are retreived from latest iterations to earliest ones. Otherwise from earliest iterations to the latest. The default is True | boolean |
| refresh optional | If set then scroll will be moved to the latest iterations. The default is False | boolean |
| scroll_id optional | Scroll ID of previous call (used for getting more results) | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | events.plots_response |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.scalar_metrics_iter_histogram
Description
Get histogram data of all the scalar metrics and variants in the task
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| key optional | Histogram x axis to use: iter - iteration number iso_time - event time as ISO formatted string timestamp - event timestamp as milliseconds since epoch | events.scalar_key_enum |
| metrics optional | List of metrics and variants | < events.metric_variants > array |
| model_events optional | If set then the retrieving model events. Otherwise task events Default : false | boolean |
| samples optional | The amount of histogram points to return (0 to return all the points). Optional, the default value is 6000. | integer |
| task required | Task ID | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Schema |
|---|---|
| images optional | < object > array |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.scalar_metrics_iter_raw
Description
Get raw data for a specific metric variants in the task
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| batch_size optional | The number of data points to return for this call. Optional, the default value is 10000. Maximum batch size is 200000 | integer |
| count_total optional | Count the total number of data points. If false, total number of data points is not counted and null is returned Default : false | boolean |
| key optional | Array of x axis to return. Supported values: iter - iteration number timestamp - event timestamp as milliseconds since epoch | events.scalar_key_enum |
| metric required | Metric and variants for which to return data points | events.metric_variants |
| model_events optional | If set then the retrieving model events. Otherwise task events Default : false | boolean |
| scroll_id optional | Optional Scroll ID. Use to get more data points following a previous call | string |
| task required | Task ID | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| returned optional | Number of data points returned in this call. If 0 results were returned, no more results are avilable | integer |
| scroll_id optional | Scroll ID. Use to get more data points when calling this endpoint again | string |
| total optional | Total data points count. If count_total is false, null is returned | integer |
| variants optional | Raw data points for each variant | object |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /events.vector_metrics_iter_histogram
Description
Get histogram data of all the scalar metrics and variants in the task
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| metric required | string | |
| model_events optional | If set then the retrieving model events. Otherwise task events Default : false | boolean |
| task required | Task ID | string |
| variant required | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Schema |
|---|---|
| images optional | < object > array |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |