citrine.informatics.design_spaces.enumerated_design_space module
- class citrine.informatics.design_spaces.enumerated_design_space.EnumeratedDesignSpace(*args, **kwargs)
Bases:
EngineResource[EnumeratedDesignSpace],DesignSpaceAn explicit enumeration of candidate materials to score.
Enumerated design spaces are intended to capture small spaces with fewer than 1000 values. For larger spaces, use the DataSourceDesignSpace.
- Parameters:
name (str) – the name of the design space
description (str) – the description of the design space
descriptors (list[Descriptor]) – the list of descriptors included in the candidates of the design space
data (list[dict]) – list of dicts of the shape {<descriptor_key>: <descriptor_value>} where each dict corresponds to a candidate in the design space
- 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]
- property data: List[Mapping[str, int | float | str]]
List of dicts corresponding to candidates in the design space.
- description: str = None
- descriptors: List[Descriptor] = 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]
- typ = 'EnumeratedDesignSpace'
- 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]