whylogs.core.feature_weights#

Module Contents#

Classes#

FeatureWeights

Helper class that provides a standard way to create an ABC using

FeatureWeightWriter

Helper class that provides a standard way to create an ABC using
class whylogs.core.feature_weights.FeatureWeights(weights: Dict[str, float], segment: whylogs.api.writer.writer.Optional[whylogs.core.Segment] = None, metadata: whylogs.api.writer.writer.Optional[Dict] = None)#

Bases: whylogs.api.writer.writer.Writable

Helper class that provides a standard way to create an ABC using inheritance.

Parameters

  • weights (Dict[str, float]) –

  • segment (whylogs.api.writer.writer.Optional[whylogs.core.Segment]) –

  • metadata (whylogs.api.writer.writer.Optional[Dict]) –

writer(name: str = 'local') → FeatureWeightWriter#
Parameters

name (str) –

Return type

FeatureWeightWriter

get_default_path() → str#
Return type

str

write(path: whylogs.api.writer.writer.Optional[str] = None, **kwargs: Any) → Tuple[bool, str]#
Parameters

  • path (whylogs.api.writer.writer.Optional[str]) –

  • kwargs (Any) –

Return type

Tuple[bool, str]

to_json() → str#
Return type

str

to_dict() → Dict[str, Union[whylogs.api.writer.writer.Optional[whylogs.core.Segment], whylogs.api.writer.writer.Optional[float]]]#
Return type

Dict[str, Union[whylogs.api.writer.writer.Optional[whylogs.core.Segment], whylogs.api.writer.writer.Optional[float]]]

class whylogs.core.feature_weights.FeatureWeightWriter(feature_weight, writer: whylogs.api.writer.writer.Writer)#

Bases: whylogs.api.writer.writer.Writer

Helper class that provides a standard way to create an ABC using inheritance.

Parameters

writer (whylogs.api.writer.writer.Writer) –

option(**kwargs) → FeatureWeightWriter#
Return type

FeatureWeightWriter

write(**kwargs: Any) → Tuple[bool, str]#

Put feature weights for the specified dataset.

Returns

Tuple with a boolean (1-success, 0-fail) and string with the PUT request’s status code.

Return type

Tuple[bool, str]

Parameters

kwargs (Any) –

get_feature_weights(**kwargs: Any) → whylogs.api.writer.writer.Optional[FeatureWeights]#

Get latest version for the feature weights for the specified dataset

Returns

Response of the GET request, with segmentWeights and metadata.

Return type

FeatureWeightResponse

Parameters

kwargs (Any) –

check_interval(interval_seconds: int) → None#

Validate an interval configuration for a given writer.

Some writers only accepts certain interval configuration. Raise BadConfigError for an unacceptable interval.

Parameters

interval_seconds (int) –

Return type

None