logml.feature_importance

Classes

FeatureImportanceOutputStructure(*args, **kwargs)

Defines output structure for Feature Importance endpoint.

Exceptions

FIExtractorException

Exception raised when there is an exception caught while using FIExtractor API.

class logml.feature_importance.FeatureImportanceOutputStructure(*args, **kwargs)

Bases: logml.common.OutputStructure

Defines output structure for Feature Importance endpoint.

FEATURE_IMPORTANCE: str = 'feature_importance'

INTERMEDIATE_ARTIFACTS = 'intermediate_artifacts'

AGGREGATED_ARTIFACTS = 'aggregated_results'

SUMMARY = 'summary'

GLOBAL_FEATURES_RANKING = 'global_features_ranking.csv'

FI_SUMMARY = 'rank_summary.csv'

FI_SUMMARY_JSON = 'rank_summary.json'

RANKED_FI_SUMMARY = 'global_ranked_feature_importance_summary.csv'

PICKLE_EXTENSION = '.pickle'

EXTRACTORS_DUMP_FOLDER = 'extractors'

get_extractor_dump_path(fi_extractor: str, dataset_hash: str) → pathlib.Path

For a FI extractor and a dataset returns a target file to place extractor dump.

get_intermediate_artifacts_path(fi_extractor: str, dataset_hash: str) → pathlib.Path

For a FI extractor and a dataset returns a target file to place intermediate artifacts into.

get_aggregated_artifacts_path(fi_extractor: str) → pathlib.Path

For a FI extractor returns a target file to place aggregated artifacts into.

list_aggregated_artifacts() → List[pathlib.Path]

Lists all artifacts within ‘aggregated artifacts’ folder.

list_intermediate_artifacts() → List[pathlib.Path]

Lists all artifacts within ‘aggregated artifacts’ folder.

artifacts_exist() → bool

Checks whether FI summary exists.

exception logml.feature_importance.FIExtractorException

Bases: Exception

Exception raised when there is an exception caught while using FIExtractor API.

Modules

logml.feature_importance.base
logml.feature_importance.extractors
logml.feature_importance.sfd	Statistical Features Detection.