citrine.informatics.workflows.design_workflow module
- class citrine.informatics.workflows.design_workflow.DesignWorkflow(name: str, *, design_space_id: UUID | None = None, predictor_id: UUID | None = None, predictor_version: int | str | None = None, data_source: DataSource | None = None, description: str | None = None)
Bases:
Resource[DesignWorkflow],Workflow,AIResourceMetadataObject that generates scored materials that may approach higher values of the score.
- Parameters:
name (str) – the name of the workflow
design_space_id (Optional[UUID]) – the UUID corresponding to the design space to use
predictor_id (Optional[UUID]) – the UUID corresponding to the predictor to use
predictor_version (Optional[Union[int, str]]) – the version of the predictor to use
description (Optional[str]) – a description of the workflow
- 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]
- branch_root_id: UUID | None = None
Root ID of the branch that contains this workflow.
- Type:
Optional[UUID]
- branch_version: int | None = None
Version number of the branch that contains this workflow.
- Type:
Optional[int]
- 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]
- data_source = None
- property data_source_id: str | None
A resource referencing the workflow’s data source.
- description = None
- property design_executions: DesignExecutionCollection
Return a resource representing all visible executions of this workflow.
- design_space_id = None
- name = None
- predictor_id = None
- predictor_version = 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 = 'DesignWorkflow'
- 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]