citrine.informatics.design_spaces.formulation_design_space module

class citrine.informatics.design_spaces.formulation_design_space.FormulationDesignSpace(name: str, *, description: str, formulation_descriptor: FormulationDescriptor, ingredients: Set[str], constraints: Set[Constraint], labels: Mapping[str, Set[str]] | None = None, resolution: float = 0.0001)

Bases: EngineResource[FormulationDesignSpace], DesignSpace

Design space composed of mixtures of ingredients.

Parameters:

• name (str) – the name of the design space

• description (str) – the description of the design space

• formulation_descriptor (FormulationDescriptor) – descriptor used to store formulations sampled from the design space

• ingredients (Set[str]) – set of ingredient names that can be used in a formulation

• constraints (Set[IngredientConstraint]) – set of constraints that restricts formulations sampled from the space. This must include an IngredientCountConstraint with maximum count of 32 or fewer.

• labels (Optional[Mapping[str, Set[str]]]) – map from a label to each ingredient that should given that label when it’s included in a formulation, e.g., {'solvent': {'water', 'alcohol'}}

• resolution (float, optional) – Minimum increment used to specify ingredient quantities. Default is 0.0001.

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.

classmethod get_type(data) → Type[Serializable]

Return the subtype.

in_progress() → bool

Whether the backend process is in progress.

succeeded() → bool

Whether the backend process has completed successfully.

static wrap_instance(subspace_data: dict) → dict

Insert a serialized embedded design space into an entity envelope.

This facilitates deserialization.

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]

constraints: Set[Constraint] = None

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]

description: str = None

formulation_descriptor: FormulationDescriptor = None

ingredients: Set[str] = None

property is_archived

whether the resource is archived (hidden but not deleted).

Type:

bool

labels: Mapping[str, Set[str]] | None = None

name: str = None

resolution: float = None

property sample_design_space_executions

Start a Sample Design Space Execution using the current Design Space.

status = None

short description of the resource’s status

Type:

Optional[str]

status_detail = []

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

Type:

List[StatusDetail]

typ = 'FormulationDesignSpace'

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]