abacusai.custom_metric

Classes

CustomMetricVersion

Custom metric version

AbstractApiClass

CustomMetric

Custom metric.

Module Contents

class abacusai.custom_metric.CustomMetricVersion(client, customMetricVersion=None, name=None, createdAt=None, customMetricFunctionName=None, codeSource={})

Bases: abacusai.return_class.AbstractApiClass

Custom metric version

Parameters:
  • client (ApiClient) – An authenticated API Client instance

  • customMetricVersion (str) – Unique string identifier for the custom metric version.

  • name (str) – Name assigned to the custom metric.

  • createdAt (str) – ISO-8601 string indicating when the custom metric was created.

  • customMetricFunctionName (str) – The name of the function defined in the source code.

  • codeSource (CodeSource) – Information about the source code of the custom metric.

__repr__()

Return repr(self).

to_dict()

Get a dict representation of the parameters in this class

Returns:

The dict value representation of the class parameters

Return type:

dict

refresh()

Calls describe and refreshes the current object’s fields

Returns:

The current object

Return type:

CustomMetricVersion

describe()

Describes a given custom metric version

Parameters:

custom_metric_version (str) – A unique string identifier for the custom metric version.

Returns:

An object describing the custom metric version.

Return type:

CustomMetricVersion

class abacusai.custom_metric.AbstractApiClass(client, id)
__eq__(other)

Return self==value.

_get_attribute_as_dict(attribute)
class abacusai.custom_metric.CustomMetric(client, customMetricId=None, name=None, createdAt=None, problemType=None, notebookId=None, latestCustomMetricVersion={})

Bases: abacusai.return_class.AbstractApiClass

Custom metric.

Parameters:
  • client (ApiClient) – An authenticated API Client instance

  • customMetricId (str) – Unique string identifier of the custom metric.

  • name (str) – Name assigned to the custom metric.

  • createdAt (str) – Date and time when the custom metric was created (ISO 8601 format).

  • problemType (str) – Problem type that this custom metric is applicable to (e.g. regression).

  • notebookId (str) – Unique string identifier of the notebook used to create/edit the custom metric.

  • latestCustomMetricVersion (CustomMetricVersion) – Latest version of the custom metric.

__repr__()

Return repr(self).

to_dict()

Get a dict representation of the parameters in this class

Returns:

The dict value representation of the class parameters

Return type:

dict