citrine.resources.predictor_evaluation_workflow module

Resources that represent both individual and collections of workflow executions.

class citrine.resources.predictor_evaluation_workflow.PredictorEvaluationWorkflowCollection(project_id: UUID, session: Session)

Bases: Collection[PredictorEvaluationWorkflow]

A collection of PredictorEvaluationWorkflows.

archive(uid: UUID | str)

Archive a predictor evaluation workflow.

Parameters:

uid (Union[UUID, str]) – Unique identifier of the workflow to archive

Deprecated since version 3.23.0: This will be removed in 4.0.0. Please use PredictorEvaluations instead, which doesn’t store workflows.

build(data: dict) → PredictorEvaluationWorkflow

Build an individual PredictorEvaluationExecution.

create_default(*, predictor_id: UUID, predictor_version: int | str | None = None) → PredictorEvaluationWorkflow

Create a default predictor evaluation workflow for a predictor and execute it.

The current default predictor evaluation workflow performs 5-fold, 1-trial cross-validation on all valid predictor responses. Valid responses are those that are not produced by the following predictors:

• GeneralizedMeanPropertyPredictor

• MeanPropertyPredictor

• IngredientFractionsPredictor

• IngredientsToSimpleMixturePredictor

• IngredientsToFormulationPredictor

• LabelFractionsPredictor

• MolecularStructureFeaturizer

• SimpleMixturePredictor

If there are no valid responses, a default workflow is not created.

Parameters:

• predictor_id (UUID) – Unique identifier of the predictor used to create a default workflow

• predictor_version (Option[Union[int, str]]) – The version of the predictor used to create a default workflow

Returns:

Default workflow

Return type:

PredictorEvaluationWorkflow

Deprecated since version 3.23.0: This will be removed in 4.0.0. Please use PredictorEvaluations.trigger_default instead. It doesn’t store a workflow, but it triggers an evaluation with the default evaluators.

delete(uid: UUID | str) → Response

Predictor Evaluation Workflows cannot be deleted; they can be archived instead.

Deprecated since version 3.23.0: This will be removed in 4.0.0.

get(uid: UUID | str) → PredictorEvaluationWorkflow

Get a particular element of the collection.

Deprecated since version 3.23.0: This will be removed in 4.0.0. Please use PredictorEvaluations instead, which doesn’t store workflows.

list(*, per_page: int = 100) → Iterator[PredictorEvaluationWorkflow]

Paginate over the elements of the collection.

Deprecated since version 3.23.0: This will be removed in 4.0.0. Please use PredictorEvaluations instead, which doesn’t store workflows.

register(model: PredictorEvaluationWorkflow) → PredictorEvaluationWorkflow

Create a new element of the collection by registering an existing resource.

Deprecated since version 3.23.0: This will be removed in 4.0.0. Please use PredictorEvaluations instead, which doesn’t store workflows.

restore(uid: UUID | str = None)

Restore an archived predictor evaluation workflow.

Parameters:

uid (Union[UUID, str]) – Unique identifier of the workflow to restore

Deprecated since version 3.23.0: This will be removed in 4.0.0. Please use PredictorEvaluations instead, which doesn’t store workflows.

update(model: PredictorEvaluationWorkflow) → PredictorEvaluationWorkflow

Update a particular element of the collection.

Deprecated since version 3.23.0: This will be removed in 4.0.0. Please use PredictorEvaluations instead, which doesn’t store workflows.