citrine.informatics.feature_effects module

class citrine.informatics.feature_effects.FeatureEffects

Bases: Resource

Captures information about the feature effects associated with a predictor.

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.

property as_dict: Dict[str, Dict[str, Dict[UUID, float]]]

Presents the feature effects as a dictionary by output.

failure_reason = None
outputs = None
predictor_id = None
predictor_version = None
status = None
class citrine.informatics.feature_effects.ShapleyFeature

Bases: Resource

All feature effects for this feature by material.

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.

feature = None
property material_dict: Dict[UUID, float]

Presents the feature’s effects as a dictionary by material.

materials = None
class citrine.informatics.feature_effects.ShapleyMaterial

Bases: Resource

The feature effect of a material.

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.

material_id = None
value = None
class citrine.informatics.feature_effects.ShapleyOutput

Bases: Resource

All feature effects for this output by feature.

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.

property feature_dict: Dict[str, Dict[UUID, float]]

Presents the output’s feature effects as a dictionary by feature.

features = None
output = None