abacusai.custom_metric
======================

.. py:module:: abacusai.custom_metric


Classes
-------

.. autoapisummary::

   abacusai.custom_metric.CustomMetricVersion
   abacusai.custom_metric.AbstractApiClass
   abacusai.custom_metric.CustomMetric


Module Contents
---------------

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

   Bases: :py:obj:`abacusai.return_class.AbstractApiClass`


   Custom metric version

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param customMetricVersion: Unique string identifier for the custom metric version.
   :type customMetricVersion: str
   :param name: Name assigned to the custom metric.
   :type name: str
   :param createdAt: ISO-8601 string indicating when the custom metric was created.
   :type createdAt: str
   :param customMetricFunctionName: The name of the function defined in the source code.
   :type customMetricFunctionName: str
   :param codeSource: Information about the source code of the custom metric.
   :type codeSource: CodeSource


   .. py:method:: __repr__()

      Return repr(self).



   .. py:method:: to_dict()

      Get a dict representation of the parameters in this class

      :returns: The dict value representation of the class parameters
      :rtype: dict



   .. py:method:: refresh()

      Calls describe and refreshes the current object's fields

      :returns: The current object
      :rtype: CustomMetricVersion



   .. py:method:: describe()

      Describes a given custom metric version

      :param custom_metric_version: A unique string identifier for the custom metric version.
      :type custom_metric_version: str

      :returns: An object describing the custom metric version.
      :rtype: CustomMetricVersion



.. py:class:: AbstractApiClass(client, id)

   .. py:method:: __eq__(other)

      Return self==value.



   .. py:method:: _get_attribute_as_dict(attribute)


.. py:class:: CustomMetric(client, customMetricId=None, name=None, createdAt=None, problemType=None, notebookId=None, latestCustomMetricVersion={})

   Bases: :py:obj:`abacusai.return_class.AbstractApiClass`


   Custom metric.

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param customMetricId: Unique string identifier of the custom metric.
   :type customMetricId: str
   :param name: Name assigned to the custom metric.
   :type name: str
   :param createdAt: Date and time when the custom metric was created (ISO 8601 format).
   :type createdAt: str
   :param problemType: Problem type that this custom metric is applicable to (e.g. regression).
   :type problemType: str
   :param notebookId: Unique string identifier of the notebook used to create/edit the custom metric.
   :type notebookId: str
   :param latestCustomMetricVersion: Latest version of the custom metric.
   :type latestCustomMetricVersion: CustomMetricVersion


   .. py:method:: __repr__()

      Return repr(self).



   .. py:method:: to_dict()

      Get a dict representation of the parameters in this class

      :returns: The dict value representation of the class parameters
      :rtype: dict



