| |
- builtins.object
-
- Metric
class Metric(builtins.object) |
|
Metric(name: str, value: float, timestamp: datetime.datetime, step: int = None, labels: List[ai_api_client_sdk.models.metric_label.MetricLabel] = None, **kwargs)
The Metric object, defines a single metric.
:param name: Name of the metric
:type name: str
:param value: numeric value of the metric
:type value: float
:param timestamp: Time when the metric was created
:type timestamp: datetime
:param step: any measurement of training progress (number of training iterations, number of epochs, etc.)
:type step: int
:param labels: List of the labels of the metric, defaults to None
:type labels: List[class:`ai_api_client_sdk.models.metric_label.MetricLabel`]
:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server |
|
Methods defined here:
- __eq__(self, other)
- Return self==value.
- __init__(self, name: str, value: float, timestamp: datetime.datetime, step: int = None, labels: List[ai_api_client_sdk.models.metric_label.MetricLabel] = None, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __str__(self)
- Return str(self).
- to_dict(self)
- Returns the attributes of the object as a dictionary
:return: A dict, including all the attributes of the object
:rtype: Dict[str, str]
Static methods defined here:
- from_dict(metric_dict: Dict[str, Any])
- Returns a :class:`ai_api_client_sdk.models.metric.Metric` object, created from the values in the dict
provided as parameter
:param metric_dict: Dict which includes the necessary values to create the object
:type metric_dict: Dict[str, Any]
:return: An object, created from the values provided
:rtype: class:`ai_api_client_sdk.models.metric.Metric`
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
| |