citrine.informatics.workflows.predictor_evaluation_workflow module

class citrine.informatics.workflows.predictor_evaluation_workflow.PredictorEvaluationWorkflow(name: str, *, description: str = '', evaluators: List[PredictorEvaluator])

Bases: Resource[PredictorEvaluationWorkflow], Workflow, AIResourceMetadata

A workflow that evaluations a predictor.

Parameters:

name (str) – name of the predictor evaluation workflow
description (str) – the description of the predictor evaluation workflow
evaluators (List[PredictorEvaluator]) – the list of evaluators to apply to the predictor

access_control_dict() → dict: Return an access control entity representation of this resource. Internal use only.

classmethod build(data: dict) → Self: Build an instance of this object from given data.

dump() → dict: Dump this instance.

failed() → bool: Whether the backend process has completed unsuccessfully.

in_progress() → bool: Whether the backend process is in progress.

succeeded() → bool: Whether the backend process has completed successfully.

archive_time = None

date and time at which the resource was archived, if it has been archived

Type:: Optional[datetime]

archived = False

whether the resource is archived (hidden but not deleted)

Type:: bool

archived_by = None

id of the user who archived the resource, if it has been archived

Type:: Optional[UUID]

create_time = None

date and time at which the resource was created

Type:: Optional[datetime]

created_by = None

id of the user who created the resource

Type:: Optional[UUID]

description: str = None

evaluators: List[PredictorEvaluator] = None

property executions: PredictorEvaluationExecutionCollection: Return a resource representing all visible executions of this workflow.

name: str = None

project_id: UUID | None = None

Unique ID of the project that contains this workflow.

Type:: Optional[UUID]

status = None

short description of the resource’s status

Type:: Optional[str]

status_description = None

more detailed description of the workflow’s status

Type:: str

status_detail = []

a list of structured status info, containing the message and level

Type:: List[StatusDetail]

typ = 'PredictorEvaluationWorkflow'

uid = None

Citrine Platform unique identifier

Type:: Optional[UUID]

update_time = None

date and time at which the resource was most recently updated, if it has been updated

Type:: Optional[datetime]

updated_by = None

id of the user who most recently updated the resource, if it has been updated

Type:: Optional[UUID]