citrine.informatics.design_spaces.product_design_space module
- class citrine.informatics.design_spaces.product_design_space.ProductDesignSpace(*args, **kwargs)
Bases:
EngineResource[ProductDesignSpace],DesignSpaceA Cartesian product of design spaces.
Factors can be other design spaces and/or univariate dimensions.
- Parameters:
name (str) – the name of the design space
description (str) – the description of the design space
subspaces (List[Union[UUID, DesignSpace]]) – the list of subspaces to combine, either design spaces defined in-line or UUIDs that reference design spaces on the platform
dimensions (list[Dimension]) – univariate dimensions that are factors of the design space; can be enumerated or continuous
- access_control_dict() dict
Return an access control entity representation of this resource. Internal use only.
- classmethod build(data: dict)
Build an instance of this object from given data.
- classmethod build_with_parent(data: dict, base_cls) Self
- 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]
- 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
- property is_archived
whether the resource is archived (hidden but not deleted).
- Type:
bool
- name: str = 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]
- subspaces: List[UUID | DesignSpace] = []
- typ = 'ProductDesignSpace'
- 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]