citrine.informatics.predictors.expression_predictor module

class citrine.informatics.predictors.expression_predictor.ExpressionPredictor(name: str, *, description: str, expression: str, output: RealDescriptor, aliases: Mapping[str, RealDescriptor])

Bases: Resource[ExpressionPredictor], PredictorNode

A predictor that computes an output from an expression and set of bounded inputs.

For a discussion of expression syntax and a list of allowed symbols, please see the documentation.

Parameters:
  • name (str) – name of the configuration

  • description (str) – the description of the predictor

  • expression (str) – expression that computes an output from aliased inputs

  • output (RealDescriptor) – descriptor that represents the output of the expression

  • aliases (Mapping[str, RealDescriptor]) – a mapping from each unknown argument to its descriptor. All unknown arguments must have an associated descriptor.

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.

aliases: Mapping[str, RealDescriptor] = None
description: str = None
expression: str = None
name: str = None
output: RealDescriptor = None
typ = 'AnalyticExpression'