citrine.informatics.executions.design_execution module

class citrine.informatics.executions.design_execution.DesignExecution

Bases: Resource[DesignExecution], Execution

The execution of a DesignWorkflow.

Possible statuses are INPROGRESS, SUCCEEDED, and FAILED. Design 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.

candidates(*, per_page: int = 100) → Iterable[DesignCandidate]: Fetch the Design Candidates for the particular execution, paginated.

dump() → dict: Dump this instance.

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

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

predict(predict_request: PredictRequest) → DesignCandidate: Invoke a prediction on a design candidate.

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]

descriptors = None

all of the descriptors in the candidates generated by this execution

Type:: List[Descriptor]

project_id: UUID | None = None

score = None

score by which this execution was evaluated

Type:: Score

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]

version_number = None

Integer identifier that increases each time the workflow is executed. The first execution has version_number = 1.

Type:: int

workflow_id = None

Unique identifier of the workflow that was executed

Type:: UUID