api.interfaces.inputs package

Submodules

api.interfaces.inputs.interface module

class api.interfaces.inputs.interface.FeaturesExtractorConfiguration(extractor_configuration)[source]

Bases: object

Class implementing the input extractor configuration interface

classmethod from_request(request)[source]

Creates the FeaturesExtractorConfiguration instance.

Parameters

request (dict or str) – dict with the features pipeline

Returns

class instance

Return type

api.interfaces.inputs.FeaturesExtractorConfiguration

schema = <FeaturesExtractorConfigurationSchema(many=False)>
class api.interfaces.inputs.interface.FeaturesPipeline(pipeline)[source]

Bases: object

Class implementing the input features pipeline interface

classmethod from_request(request)[source]

Creates the FeaturesPipeline instance.

Parameters

request (dict or str) – dict with the features pipeline

Returns

class instance

Return type

api.interfaces.inputs.FeaturesPipeline

schema = <FeaturesPipelineSchema(many=False)>
class api.interfaces.inputs.interface.Sample(values, labels)[source]

Bases: object

Class implementing the input samples interface

classmethod from_request(request)[source]

Creates the Sample instance utilizing the schema.

Parameters

request (dict) – dict with the data sample values and labels

Returns

class instance

Return type

api.interfaces.inputs.Sample

schema = <SampleSchema(many=False)>

api.interfaces.inputs.schema module

class api.interfaces.inputs.schema.FeaturesExtractorConfigurationSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)[source]

Bases: marshmallow.schema.Schema

Class defining the schema for the features extractor configuration

class Meta[source]

Bases: object

unknown = 'exclude'
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>
class api.interfaces.inputs.schema.FeaturesPipelineElementSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)[source]

Bases: marshmallow.schema.Schema

Class defining the schema for the features pipeline input element

class Meta[source]

Bases: object

unknown = 'exclude'
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>
class api.interfaces.inputs.schema.FeaturesPipelineSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)[source]

Bases: marshmallow.schema.Schema

Class defining the schema for the features pipeline input interface

class Meta[source]

Bases: object

unknown = 'exclude'
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>
class api.interfaces.inputs.schema.SampleSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)[source]

Bases: marshmallow.schema.Schema

Class defining the schema for the sample input interface

class Meta[source]

Bases: object

unknown = 'exclude'
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

api.interfaces.inputs.utilities module

class api.interfaces.inputs.utilities.SamplesLabelsValidator[source]

Bases: object

Class implementing validator for the sample labels

classmethod validate(labels, values)[source]

Validates the sample labels.

Parameters

  • labels (Any) – labels to be validated

  • values (Any) – values to be referenced

Returns

validated values

Return type

Any

class api.interfaces.inputs.utilities.SamplesValuesValidator[source]

Bases: object

Class implementing validator for the sample values

classmethod validate(values)[source]

Validates the sample values.

Parameters

values (Any) – values to be validated

Returns

validated values

Return type

Any

Module contents