modeva.DataSet.summary#

DataSet.summary(dataset: str = 'main')#

Generates comprehensive descriptive statistics and analysis of the dataset.

This function performs a detailed analysis of the dataset, computing various statistical measures and summaries for different types of features (numerical, categorical, and mixed). It analyzes the overall dataset structure and provides detailed statistics for each feature based on its type.

Parameters:

dataset ({"main", "train", "test"}, default="main") – Specifies which dataset partition to analyze. Use “main” for the complete dataset, “train” for training data, or “test” for test data.

Returns:

A container object with the following components:

  • key: “data_summary”

  • data: Name of the analyzed dataset

  • inputs: Input parameters used for the analysis

  • table: Dictionary containing DataFrames with:

    • ”summary”: Overall dataset statistics

    • ”numerical”: Statistics for numerical features

    • ”categorical”: Statistics for categorical features

    • ”mixed”: Statistics for mixed-type features

  • value: Dictionary containing raw analysis results:

    • ”features”: Detailed statistics for each feature

    • ”summary”: Overall dataset metrics

Return type:

ValidationResult

Examples

Exploratory Data Analysis

Exploratory Data Analysis