logml.report.notebooks.eda

Classes

CategoricalSummaryNotebook(cfg, ...[, ...])	Notebook for displaying a summary for categoricals.
DimensionalityReductionNotebook(cfg, ...[, ...])	Notebook for displaying dimensionality reduction EDA artifacts.
DistributionsSummaryNotebook(cfg, ...[, ...])	Notebook for displaying distributions summary.
EDANotebooksSet(cfg, global_params, ...[, ...])	Set of notebooks for EDA artifacts displaying.
FacetsDiveNotebook(cfg, global_params, ...)	Notebook that displays an interactive tool for EDA.
InitializeDataNotebook(cfg, global_params, ...)	Notebook for displaying basic dataset's statistics.
MissingnessNotebook(cfg, global_params, ...)	Notebook for displaying dataset's missingness summary.
StatisticsSummaryNotebook(cfg, ...[, ...])	Notebook for displaying dataset statistics (numericals only).

class logml.report.notebooks.eda.InitializeDataNotebook(cfg: GlobalConfig, global_params: Dict, output_structure: logml.report.ReportOutputStructure, logger: logging.Logger = None, file_ext: str = '.ipynb')

Bases: logml.report.notebooks.base.BaseBKNotebook

Notebook for displaying basic dataset’s statistics.

ALIAS: str = 'initialize_data'

VIEWS: List[str] = ['dataset_overview']

SCOPE: List[logml.report.notebooks.base.BKNotebookScopes] = [<BKNotebookScopes.STRATA: 'strata'>]

class logml.report.notebooks.eda.MissingnessNotebook(cfg: GlobalConfig, global_params: Dict, output_structure: logml.report.ReportOutputStructure, logger: logging.Logger = None, file_ext: str = '.ipynb')

Bases: logml.report.notebooks.base.BaseBKNotebook

Notebook for displaying dataset’s missingness summary.

ALIAS: str = 'missingness_summary'

VIEWS: List[str] = ['missingness_summary']

SCOPE: List[logml.report.notebooks.base.BKNotebookScopes] = [<BKNotebookScopes.STRATA: 'strata'>]

class logml.report.notebooks.eda.StatisticsSummaryNotebook(cfg: GlobalConfig, global_params: Dict, output_structure: logml.report.ReportOutputStructure, logger: logging.Logger = None, file_ext: str = '.ipynb')

Bases: logml.report.notebooks.base.BaseBKNotebook

Notebook for displaying dataset statistics (numericals only).

ALIAS: str = 'statistics_summary'

VIEWS: List[str] = ['statistics_summary']

SCOPE: List[logml.report.notebooks.base.BKNotebookScopes] = [<BKNotebookScopes.STRATA: 'strata'>]

class logml.report.notebooks.eda.DistributionsSummaryNotebook(cfg: GlobalConfig, global_params: Dict, output_structure: logml.report.ReportOutputStructure, logger: logging.Logger = None, file_ext: str = '.ipynb')

Bases: logml.report.notebooks.base.BaseBKNotebook

Notebook for displaying distributions summary.

ALIAS: str = 'distributions_summary'

VIEWS: List[str] = ['distributions_summary']

SCOPE: List[logml.report.notebooks.base.BKNotebookScopes] = [<BKNotebookScopes.STRATA: 'strata'>]

class logml.report.notebooks.eda.DimensionalityReductionNotebook(cfg: GlobalConfig, global_params: Dict, output_structure: logml.report.ReportOutputStructure, logger: logging.Logger = None, file_ext: str = '.ipynb')

Bases: logml.report.notebooks.base.BaseBKNotebook

Notebook for displaying dimensionality reduction EDA artifacts.

ALIAS: str = 'dimensionality_reduction'

VIEWS: List[str] = ['dimensionality_reduction']

SCOPE: List[logml.report.notebooks.base.BKNotebookScopes] = [<BKNotebookScopes.STRATA: 'strata'>]

class logml.report.notebooks.eda.CategoricalSummaryNotebook(cfg: GlobalConfig, global_params: Dict, output_structure: logml.report.ReportOutputStructure, logger: logging.Logger = None, file_ext: str = '.ipynb')

Bases: logml.report.notebooks.base.BaseBKNotebook

Notebook for displaying a summary for categoricals.

ALIAS: str = 'categoricals_summary'

VIEWS: List[str] = ['categoricals_summary']

SCOPE: List[logml.report.notebooks.base.BKNotebookScopes] = [<BKNotebookScopes.STRATA: 'strata'>]

class logml.report.notebooks.eda.FacetsDiveNotebook(cfg: GlobalConfig, global_params: Dict, output_structure: logml.report.ReportOutputStructure, logger: logging.Logger = None, file_ext: str = '.ipynb')

Bases: logml.report.notebooks.base.BaseBKNotebook

Notebook that displays an interactive tool for EDA.

ALIAS: str = 'facets_dive'

VIEWS: List[str] = ['facets_dive']

SCOPE: List[logml.report.notebooks.base.BKNotebookScopes] = [<BKNotebookScopes.STRATA: 'strata'>]

class logml.report.notebooks.eda.EDANotebooksSet(cfg, global_params, output_structure, logger=None)

Bases: logml.report.notebooks.base.NotebooksSet

Set of notebooks for EDA artifacts displaying.

ALIAS: str = 'eda'

SCOPE: List[BKNotebookScopes] = [<BKNotebookScopes.STRATA: 'strata'>]

INNER_NOTEBOOKS: List[Type[logml.report.notebooks.base.BaseBKNotebook]] = [<class 'logml.report.notebooks.eda.InitializeDataNotebook'>, <class 'logml.report.notebooks.eda.MissingnessNotebook'>, <class 'logml.report.notebooks.eda.StatisticsSummaryNotebook'>, <class 'logml.report.notebooks.eda.DistributionsSummaryNotebook'>, <class 'logml.report.notebooks.eda.DimensionalityReductionNotebook'>, <class 'logml.report.notebooks.eda.CategoricalSummaryNotebook'>, <class 'logml.report.notebooks.eda.FacetsDiveNotebook'>]

generate_topic_content() → str

Generate content for the section page. Note: leave it empty if you generate file is some other page.