citrine.informatics.executions.predictor_evaluation_execution module

class citrine.informatics.executions.predictor_evaluation_execution.PredictorEvaluationExecution

Bases: Resource[PredictorEvaluationExecution], Execution

The execution of a PredictorEvaluationWorkflow.

Possible statuses are INPROGRESS, SUCCEEDED, and FAILED. Predictor evaluation executions also have a status_description field with more information.

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.

results(evaluator_name: str) → PredictorEvaluationResult

Get a specific evaluation result by the name of the evaluator that produced it.

Parameters:

evaluator_name (str) – Name of the evaluator for which to get the results

Returns:

The evaluation result from the evaluator with the given name

Return type:

PredictorEvaluationResult

succeeded() → bool

Whether the backend process has completed successfully.

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]

evaluator_names = None

names of the predictor evaluators that were executed. These are used when calling the results() method.

Type:

List[str]

predictor_id = None

predictor_version = None

project_id: UUID | None = None

status = None

short description of the execution’s status

Type:

Optional[str]

status_description = None

more detailed description of the execution’s status

Type:

Optional[str]

status_detail = []

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

Type:

List[StatusDetail]

uid: UUID = None

Unique identifier of the execution

Type:

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]

workflow_id = None

Unique identifier of the workflow that was executed

Type:

UUID