abacusai.python_plot_function

Classes

CodeSource

Code source for python-based custom feature groups and models

AbstractApiClass

PythonPlotFunction

Create a Plot for a Dashboard

Module Contents

class abacusai.python_plot_function.CodeSource(client, sourceType=None, sourceCode=None, applicationConnectorId=None, applicationConnectorInfo=None, packageRequirements=None, status=None, error=None, publishingMsg=None, moduleDependencies=None)

Bases: abacusai.return_class.AbstractApiClass

Code source for python-based custom feature groups and models

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

  • sourceType (str) – The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR

  • sourceCode (str) – If the type of the source is TEXT, the raw text of the function

  • applicationConnectorId (str) – The Application Connector to fetch the code from

  • applicationConnectorInfo (str) – Args passed to the application connector to fetch the code

  • packageRequirements (list) – The pip package dependencies required to run the code

  • status (str) – The status of the code and validations

  • error (str) – If the status is failed, an error message describing what went wrong

  • publishingMsg (dict) – Warnings in the source code

  • moduleDependencies (list) – The list of internal modules dependencies required to run the code

__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

import_as_cell()

Adds the source code as an unexecuted cell in the notebook.

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

Return self==value.

_get_attribute_as_dict(attribute)
class abacusai.python_plot_function.PythonPlotFunction(client, notebookId=None, name=None, createdAt=None, functionVariableMappings=None, functionName=None, pythonFunctionId=None, functionType=None, plotName=None, graphReferenceId=None, codeSource={})

Bases: abacusai.return_class.AbstractApiClass

Create a Plot for a Dashboard

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

  • notebookId (str) – Unique string identifier of the notebook used to spin up the notebook upon creation.

  • name (str) – The name used to identify the algorithm. Only uppercase letters, numbers, and underscores are allowed.

  • createdAt (str) – Date and time when the Python function was created, in ISO-8601 format.

  • functionVariableMappings (dict) – The mappings for function parameters’ names.

  • functionName (str) – The name of the Python function to be used.

  • pythonFunctionId (str) – Unique string identifier of the Python function.

  • functionType (str) – The type of the Python function.

  • plotName (str) – Name of the plot.

  • graphReferenceId (str) – Reference ID of the dashboard to the plot.

  • codeSource (CodeSource) – Info about the source code of the Python function.

__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