citrine.informatics.executions.predictor_evaluation module
- class citrine.informatics.executions.predictor_evaluation.PredictorEvaluation
Bases:
EngineResourceWithoutStatus[PredictorEvaluation],AsynchronousObjectThe evaluation of a predictor’s performance.
- 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:
- 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_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]
- property evaluator_names
Names of the predictor evaluators. Used when calling the
results()method.
- evaluators = None
the predictor evaluators that were executed. These are used when calling the
results()method.- Type:
List{PredictorEvaluator]
- property is_archived
whether the resource is archived (hidden but not deleted).
- Type:
bool
- predictor_id = None
UUID:
- predictor_version = None
- project_id: UUID | None = None
- status = None
short description of the evaluation’s status
- Type:
str
- status_description = None
more detailed description of the evaluation’s status
- Type:
str
- status_detail = []
a list of structured status info, containing the message and level
- Type:
List[StatusDetail]
- uid: UUID = None
Unique identifier of the evaluation
- 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]
- class citrine.informatics.executions.predictor_evaluation.PredictorEvaluationRequest(*, evaluators: List[PredictorEvaluator], predictor_id: UUID | str, predictor_version: int | str | None = None)
Bases:
Serializable[EvaluatorsPayload]Container object for a predictor evaluation request.
- classmethod build(data: dict) Self
Build an instance of this object from given data.
- dump() dict
Dump this instance.
- evaluators = None
- predictor = None
- class citrine.informatics.executions.predictor_evaluation.PredictorEvaluatorsResponse(evaluators: List[PredictorEvaluator])
Bases:
Serializable[EvaluatorsPayload]Container object for a default predictor evaluator response.
- classmethod build(data: dict) Self
Build an instance of this object from given data.
- dump() dict
Dump this instance.
- evaluators = None