ai_api_client_sdk.models.metric module

class ai_api_client_sdk.models.metric.Metric(name: str, value: float, timestamp: datetime, step: int = None, labels: List[MetricLabel] = None, **kwargs)

Bases: object

The Metric object, defines a single metric.

Parameters:

  • name (str) – Name of the metric

  • value (float) – numeric value of the metric

  • timestamp (datetime) – Time when the metric was created

  • step (int) – any measurement of training progress (number of training iterations, number of epochs, etc.)

  • labels (List[class:ai_api_client_sdk.models.metric_label.MetricLabel]) – List of the labels of the metric, defaults to None

  • **kwargs – The keyword arguments are there in case there are additional attributes returned from server

__init__(name: str, value: float, timestamp: datetime, step: int = None, labels: List[MetricLabel] = None, **kwargs)
static from_dict(metric_dict: Dict[str, Any])

Returns a ai_api_client_sdk.models.metric.Metric object, created from the values in the dict provided as parameter

Parameters:

metric_dict (Dict[str, Any]) – Dict which includes the necessary values to create the object

Returns:

An object, created from the values provided

Return type:

class:ai_api_client_sdk.models.metric.Metric

to_dict()

Returns the attributes of the object as a dictionary

Returns:

A dict, including all the attributes of the object

Return type:

Dict[str, str]