citrine.informatics.predictors.ingredients_to_formulation_predictor module

class citrine.informatics.predictors.ingredients_to_formulation_predictor.IngredientsToFormulationPredictor(name: str, *, description: str, id_to_quantity: Mapping[str, RealDescriptor], labels: Mapping[str, Set[str]])

Bases: Resource[IngredientsToFormulationPredictor], PredictorNode

A predictor interface that constructs a formulation from ingredient quantities.

Parameters:

• name (str) – name of the configuration

• description (str) – description of the predictor

• id_to_quantity (Mapping[str, RealDescriptor]) – Map from ingredient identifier to the descriptor that represents its quantity, e.g., {'water': RealDescriptor('water quantity', 0, 1, "")}

• labels (Mapping[str, Set[str]]) – Map from each label to all ingredients assigned that label, when present in a mixture, e.g., {'solvent': {'water'}}

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.

classmethod get_type(data) → Type[PredictorNode]

Return the subtype.

description: str = None

id_to_quantity: Mapping[str, RealDescriptor] = None

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

name: str = None

property output: FormulationDescriptor

The output formulation descriptor with key ‘Formulation’.

typ = 'IngredientsToSimpleMixture'