abacusai.pipeline_step_version — AbacusAI documentation

# abacusai.pipeline_step_version

## Classes

`CodeSource` | Code source for python-based custom feature groups and models
`PipelineStepVersionReference` | A reference from a pipeline step version to the versions that were output from the pipeline step.
`AbstractApiClass` |
`PipelineStepVersion` | A version of a pipeline step.

## Module Contents

class abacusai.pipeline_step_version.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.pipeline_step_version.PipelineStepVersionReference(client, pipelineStepVersionReferenceId=None, pipelineStepVersion=None, objectType=None, datasetVersion=None, modelVersion=None, deploymentVersion=None, batchPredictionId=None, modelMonitorVersion=None, notebookVersion=None, featureGroupVersion=None, status=None, error=None)

  Bases: `abacusai.return_class.AbstractApiClass`

  A reference from a pipeline step version to the versions that were output from the pipeline step.

  Parameters:

    - client (ApiClient) – An authenticated API Client instance

    - pipelineStepVersionReferenceId (str) – The id of the reference.

    - pipelineStepVersion (str) – The pipeline step version the reference is connected to.

    - objectType (str) – The object type of the reference.

    - datasetVersion (str) – The dataset version the reference is connected to.

    - modelVersion (str) – The model version the reference is connected to.

    - deploymentVersion (str) – The deployment version the reference is connected to.

    - batchPredictionId (str) – The batch prediction id the reference is connected to.

    - modelMonitorVersion (str) – The model monitor version the reference is connected to.

    - notebookVersion (str) – The notebook version the reference is connected to.

    - featureGroupVersion (str) – The feature group version the reference is connected to.

    - status (str) – The status of the reference

    - error (str) – The error message if the reference is in an error state.

  __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

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

    Return self==value.

  _get_attribute_as_dict(attribute)

class abacusai.pipeline_step_version.PipelineStepVersion(client, stepName=None, pipelineStepVersion=None, pipelineStepId=None, pipelineId=None, pipelineVersion=None, createdAt=None, updatedAt=None, status=None, error=None, outputErrors=None, pythonFunctionId=None, functionVariableMappings=None, stepDependencies=None, outputVariableMappings=None, cpuSize=None, memory=None, timeout=None, pipelineStepVersionReferences={}, codeSource={})

  Bases: `abacusai.return_class.AbstractApiClass`

  A version of a pipeline step.

  Parameters:

    - client (ApiClient) – An authenticated API Client instance

    - stepName (str) – The name of the step.

    - pipelineStepVersion (str) – The reference to the pipeline step version.

    - pipelineStepId (str) – The reference to this step.

    - pipelineId (str) – The reference to the pipeline this step belongs to.

    - pipelineVersion (str) – The reference to the pipeline version.

    - createdAt (str) – The date and time which this step was created.

    - updatedAt (str) – The date and time when this step was last updated.

    - status (str) – The status of the pipeline version.

    - error (str) – The error message if the pipeline step failed.

    - outputErrors (str) – The error message of a pipeline step’s output.

    - pythonFunctionId (str) – The reference to the python function

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

    - stepDependencies (list[str]) – List of steps this step depends on.

    - outputVariableMappings (dict) – The mappings for the output variables to the step.

    - cpuSize (str) – CPU size specified for the step function.

    - memory (int) – Memory in GB specified for the step function.

    - timeout (int) – The timeout in minutes for the pipeline step.

    - pipelineStepVersionReferences (PipelineStepVersionReference) – A list to the output instances of the pipeline step version.

    - codeSource (CodeSource) – Information about the source code of the pipeline step version.

  __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:

      PipelineStepVersion

  describe()

    Describes a pipeline step version.

    Parameters:

      pipeline_step_version (str) – The ID of the pipeline step version.

    Returns:

      An object describing the pipeline step version.

    Return type:

      PipelineStepVersion

  get_step_version_logs()

    Gets the logs for a given step version.

    Parameters:

      pipeline_step_version (str) – The id of the pipeline step version.

    Returns:

      Object describing the pipeline step logs.

    Return type:

      PipelineStepVersionLogs