validmind 2.5.8__py3-none-any.whl → 2.5.18__py3-none-any.whl

validmind/datasets/regression/fred_timeseries.py

@@ -68,65 +68,56 @@ def convert_to_levels(diff_df, original_df, target_column):
     return levels_df
 
 
-def get_demo_test_config(test_suite=None):
+def get_demo_test_config():
 
     default_config = {}
 
     default_config["validmind.data_validation.TimeSeriesDescription"] = {
-        "inputs": {
-            "dataset": "raw_ds",
+        "input_grid": {
+            "dataset": [
+                "raw_ds",
+                "train_diff_ds",
+                "test_diff_ds",
+                "train_ds",
+                "test_ds",
+            ],
         }
     }
     default_config["validmind.data_validation.TimeSeriesLinePlot"] = {
-        "inputs": {
-            "dataset": "raw_ds",
+        "input_grid": {
+            "dataset": ["raw_ds"],
         }
     }
     default_config["validmind.data_validation.TimeSeriesMissingValues"] = {
-        "inputs": {
-            "dataset": "raw_ds",
+        "input_grid": {
+            "dataset": [
+                "raw_ds",
+                "train_diff_ds",
+                "test_diff_ds",
+                "train_ds",
+                "test_ds",
+            ],
         }
     }
     default_config["validmind.data_validation.SeasonalDecompose"] = {
-        "inputs": {
-            "dataset": "raw_ds",
+        "input_grid": {
+            "dataset": ["raw_ds"],
         }
     }
-    default_config[
-        "validmind.data_validation.TimeSeriesDescriptiveStatistics:train_diff_data"
-    ] = {
-        "inputs": {
-            "dataset": "train_diff_ds",
+    default_config["validmind.data_validation.TimeSeriesDescriptiveStatistics"] = {
+        "input_grid": {
+            "dataset": ["train_diff_ds", "test_diff_ds"],
         }
     }
-    default_config[
-        "validmind.data_validation.TimeSeriesDescriptiveStatistics:test_diff_data"
-    ] = {
-        "inputs": {
-            "dataset": "test_diff_ds",
-        }
-    }
-    default_config["validmind.data_validation.TimeSeriesOutliers:train_diff_data"] = {
-        "inputs": {
-            "dataset": "train_diff_ds",
+    default_config["validmind.data_validation.TimeSeriesOutliers"] = {
+        "input_grid": {
+            "dataset": ["train_diff_ds", "test_diff_ds"],
         },
         "params": {"zscore_threshold": 4},
     }
-    default_config["validmind.data_validation.TimeSeriesOutliers:test_diff_data"] = {
-        "inputs": {
-            "dataset": "test_diff_ds",
-        },
-        "params": {"zscore_threshold": 4},
-    }
-    default_config["validmind.data_validation.TimeSeriesHistogram:train_diff_data"] = {
-        "inputs": {
-            "dataset": "train_diff_ds",
-        },
-        "params": {"nbins": 100},
-    }
-    default_config["validmind.data_validation.TimeSeriesHistogram:test_diff_data"] = {
-        "inputs": {
-            "dataset": "test_diff_ds",
+    default_config["validmind.data_validation.TimeSeriesHistogram"] = {
+        "input_grid": {
+            "dataset": ["train_diff_ds", "test_diff_ds"],
         },
         "params": {"nbins": 100},
     }
@@ -135,57 +126,37 @@ def get_demo_test_config(test_suite=None):
             "datasets": ["train_diff_ds", "test_diff_ds"],
         }
     }
-    default_config["validmind.model_validation.ModelMetadataComparison"] = {
-        "inputs": {
-            "models": ["random_forests_model", "gradient_boosting_model"],
-        }
-    }
-    default_config[
-        "validmind.model_validation.sklearn.RegressionErrorsComparison:train_data"
-    ] = {
-        "inputs": {
-            "datasets": ["train_ds", "train_ds"],
-            "models": ["random_forests_model", "gradient_boosting_model"],
+    default_config["validmind.model_validation.ModelMetadata"] = {
+        "input_grid": {
+            "model": ["random_forests_model", "gradient_boosting_model"],
         }
     }
-    default_config[
-        "validmind.model_validation.sklearn.RegressionErrorsComparison:test_data"
-    ] = {
-        "inputs": {
-            "datasets": ["test_ds", "test_ds"],
-            "models": ["random_forests_model", "gradient_boosting_model"],
+    default_config["validmind.model_validation.sklearn.RegressionErrors"] = {
+        "input_grid": {
+            "dataset": ["train_ds", "test_ds"],
+            "model": ["random_forests_model", "gradient_boosting_model"],
         }
     }
-    default_config[
-        "validmind.model_validation.sklearn.RegressionR2SquareComparison:train_data"
-    ] = {
-        "inputs": {
-            "datasets": ["train_ds", "train_ds"],
-            "models": ["random_forests_model", "gradient_boosting_model"],
-        }
-    }
-    default_config[
-        "validmind.model_validation.sklearn.RegressionR2SquareComparison:test_data"
-    ] = {
-        "inputs": {
-            "datasets": ["test_ds", "test_ds"],
-            "models": ["random_forests_model", "gradient_boosting_model"],
+    default_config["validmind.model_validation.sklearn.RegressionR2Square"] = {
+        "input_grid": {
+            "dataset": ["train_ds", "test_ds"],
+            "model": ["random_forests_model", "gradient_boosting_model"],
         }
     }
     default_config[
         "validmind.model_validation.TimeSeriesR2SquareBySegments:train_data"
     ] = {
-        "inputs": {
-            "datasets": ["train_ds", "train_ds"],
-            "models": ["random_forests_model", "gradient_boosting_model"],
+        "input_grid": {
+            "dataset": ["train_ds"],
+            "model": ["random_forests_model", "gradient_boosting_model"],
         }
     }
     default_config[
         "validmind.model_validation.TimeSeriesR2SquareBySegments:test_data"
     ] = {
-        "inputs": {
-            "datasets": ["test_ds", "test_ds"],
-            "models": ["random_forests_model", "gradient_boosting_model"],
+        "input_grid": {
+            "dataset": ["test_ds"],
+            "model": ["random_forests_model", "gradient_boosting_model"],
         },
         "params": {
             "segments": {
@@ -194,78 +165,36 @@ def get_demo_test_config(test_suite=None):
             }
         },
     }
-    default_config[
-        "validmind.model_validation.TimeSeriesPredictionsPlot:train_data"
-    ] = {
-        "inputs": {
-            "datasets": ["train_ds", "train_ds"],
-            "models": ["random_forests_model", "gradient_boosting_model"],
-        }
-    }
-    default_config["validmind.model_validation.TimeSeriesPredictionsPlot:test_data"] = {
-        "inputs": {
-            "datasets": ["test_ds", "test_ds"],
-            "models": ["random_forests_model", "gradient_boosting_model"],
-        }
-    }
-    default_config[
-        "validmind.model_validation.TimeSeriesPredictionWithCI:random_forests_model"
-    ] = {
-        "inputs": {
-            "dataset": "test_ds",
-            "model": "random_forests_model",
-        }
-    }
-    default_config[
-        "validmind.model_validation.TimeSeriesPredictionWithCI:gradient_boosting_model"
-    ] = {
-        "inputs": {
-            "dataset": "test_ds",
-            "model": "gradient_boosting_model",
-        }
-    }
-    default_config["validmind.model_validation.ModelPredictionResiduals:train_data"] = {
-        "inputs": {
-            "datasets": ["train_ds", "train_ds"],
-            "models": ["random_forests_model", "gradient_boosting_model"],
+    default_config["validmind.model_validation.TimeSeriesPredictionsPlot"] = {
+        "input_grid": {
+            "dataset": ["train_ds", "test_ds"],
+            "model": ["random_forests_model", "gradient_boosting_model"],
         }
     }
-    default_config["validmind.model_validation.ModelPredictionResiduals:test_data"] = {
-        "inputs": {
-            "datasets": ["test_ds", "test_ds"],
-            "models": ["random_forests_model", "gradient_boosting_model"],
-        }
-    }
-    default_config[
-        "validmind.model_validation.sklearn.FeatureImportanceComparison:train_data"
-    ] = {
-        "inputs": {
-            "datasets": ["train_ds", "train_ds"],
-            "models": ["random_forests_model", "gradient_boosting_model"],
+    default_config["validmind.model_validation.TimeSeriesPredictionWithCI"] = {
+        "input_grid": {
+            "dataset": ["train_ds", "test_ds"],
+            "model": ["random_forests_model", "gradient_boosting_model"],
         }
     }
-    default_config[
-        "validmind.model_validation.sklearn.FeatureImportanceComparison:test_data"
-    ] = {
-        "inputs": {
-            "datasets": ["test_ds", "test_ds"],
-            "models": ["random_forests_model", "gradient_boosting_model"],
+    default_config["validmind.model_validation.ModelPredictionResiduals"] = {
+        "input_grid": {
+            "dataset": ["train_ds", "test_ds"],
+            "model": ["random_forests_model", "gradient_boosting_model"],
         }
     }
-    default_config[
-        "validmind.model_validation.sklearn.PermutationFeatureImportance:random_forests_model"
-    ] = {
-        "inputs": {
-            "dataset": "test_ds",
-            "model": "random_forests_model",
+    default_config["validmind.model_validation.sklearn.FeatureImportance"] = {
+        "input_grid": {
+            "dataset": ["train_ds", "test_ds"],
+            "model": ["random_forests_model", "gradient_boosting_model"],
         }
     }
     default_config[
-        "validmind.model_validation.sklearn.PermutationFeatureImportance:gradient_boosting_model"
+        "validmind.model_validation.sklearn.PermutationFeatureImportance"
     ] = {
-        "inputs": {
-            "dataset": "test_ds",
-            "model": "gradient_boosting_model",
+        "input_grid": {
+            "dataset": ["train_ds", "test_ds"],
+            "model": ["random_forests_model", "gradient_boosting_model"],
         }
     }
 

validmind/template.py

@@ -18,6 +18,7 @@ logger = get_logger(__name__)
 CONTENT_TYPE_MAP = {
     "test": "Threshold Test",
     "metric": "Metric",
+    "unit_metric": "Unit Metric",
     "metadata_text": "Metadata Text",
     "dynamic": "Dynamic Content",
     "text": "Text",

validmind/test_suites/__init__.py

@@ -42,7 +42,6 @@ from .time_series import (
     TimeSeriesDataset,
     TimeSeriesModelValidation,
     TimeSeriesMultivariate,
-    TimeSeriesSensitivity,
     TimeSeriesUnivariate,
 )
 
@@ -78,7 +77,6 @@ core_test_suites = {
     TimeSeriesDataset.suite_id: TimeSeriesDataset,
     TimeSeriesModelValidation.suite_id: TimeSeriesModelValidation,
     TimeSeriesMultivariate.suite_id: TimeSeriesMultivariate,
-    TimeSeriesSensitivity.suite_id: TimeSeriesSensitivity,
     TimeSeriesUnivariate.suite_id: TimeSeriesUnivariate,
 }
 

validmind/test_suites/statsmodels_timeseries.py

@@ -28,6 +28,6 @@ class RegressionModelsEvaluation(TestSuite):
 
     suite_id = "regression_models_evaluation"
     tests = [
-        "validmind.model_validation.statsmodels.RegressionModelsCoeffs",
+        "validmind.model_validation.statsmodels.RegressionModelCoeffs",
         "validmind.model_validation.sklearn.RegressionModelsPerformanceComparison",
     ]

validmind/test_suites/summarization.py

@@ -16,7 +16,6 @@ class SummarizationMetrics(TestSuite):
 
     suite_id = "summarization_metrics"
     tests = [
-        "validmind.model_validation.RougeMetrics",
         "validmind.model_validation.TokenDisparity",
         "validmind.model_validation.BleuScore",
         "validmind.model_validation.BertScore",

validmind/test_suites/time_series.py

@@ -77,39 +77,6 @@ class TimeSeriesMultivariate(TestSuite):
     ]
 
 
-class TimeSeriesForecast(TestSuite):
-    """
-    This test suite computes predictions from statsmodels OLS linear regression models
-    against a list of models and plots the historical data alongside the forecasted data.
-    The purpose of this test suite is to evaluate the performance of each model in predicting
-    future values of a time series based on historical data. By comparing the historical
-    values with the forecasted values, users can visually assess the accuracy of each model
-    and determine which one best fits the data. In addition, this test suite can help users
-    identify any discrepancies between the models and the actual data, allowing for potential
-    improvements in model selection and parameter tuning.
-    """
-
-    suite_id = "time_series_forecast"
-    tests = ["validmind.model_validation.statsmodels.RegressionModelForecastPlotLevels"]
-
-
-class TimeSeriesSensitivity(TestSuite):
-    """
-    This test suite performs sensitivity analysis on a statsmodels OLS linear regression model
-    by applying distinct shocks to each input variable individually and then computing the
-    model's predictions. The aim of this test suite is to investigate the model's responsiveness
-    to variations in its inputs. By juxtaposing the model's predictions under baseline and shocked
-    conditions, users can visually evaluate the sensitivity of the model to changes in each
-    variable. This kind of analysis can also shed light on potential model limitations, including
-    over-reliance on specific variables or insufficient responsiveness to changes in inputs. As a
-    result, this test suite can provide insights that may be beneficial for refining the model
-    structure, improving its robustness, and ensuring a more reliable prediction performance.
-    """
-
-    suite_id = "time_series_sensitivity"
-    tests = ["validmind.model_validation.statsmodels.RegressionModelSensitivityPlot"]
-
-
 class TimeSeriesDataset(TestSuite):
     """
     Test suite for time series datasets.
@@ -152,14 +119,4 @@ class TimeSeriesModelValidation(TestSuite):
             "section_description": RegressionModelsEvaluation.__doc__,
             "section_tests": RegressionModelsEvaluation.tests,
         },
-        {
-            "section_id": TimeSeriesForecast.suite_id,
-            "section_description": TimeSeriesForecast.__doc__,
-            "section_tests": TimeSeriesForecast.tests,
-        },
-        {
-            "section_id": TimeSeriesSensitivity.suite_id,
-            "section_description": TimeSeriesSensitivity.__doc__,
-            "section_tests": TimeSeriesSensitivity.tests,
-        },
     ]

validmind/tests/__types__.py

@@ -33,7 +33,6 @@ TestID = Literal[
     "validmind.model_validation.ClusterSizeDistribution",
     "validmind.model_validation.TokenDisparity",
     "validmind.model_validation.ToxicityScore",
-    "validmind.model_validation.ModelMetadataComparison",
     "validmind.model_validation.TimeSeriesR2SquareBySegments",
     "validmind.model_validation.embeddings.CosineSimilarityComparison",
     "validmind.model_validation.embeddings.EmbeddingsVisualization2D",
@@ -53,12 +52,13 @@ TestID = Literal[
     "validmind.model_validation.ragas.ContextEntityRecall",
     "validmind.model_validation.ragas.Faithfulness",
     "validmind.model_validation.ragas.AspectCritique",
+    "validmind.model_validation.ragas.NoiseSensitivity",
     "validmind.model_validation.ragas.AnswerSimilarity",
     "validmind.model_validation.ragas.AnswerCorrectness",
     "validmind.model_validation.ragas.ContextRecall",
     "validmind.model_validation.ragas.ContextPrecision",
     "validmind.model_validation.ragas.AnswerRelevance",
-    "validmind.model_validation.sklearn.RegressionModelsPerformanceComparison",
+    "validmind.model_validation.ragas.ContextUtilization",
     "validmind.model_validation.sklearn.AdjustedMutualInformation",
     "validmind.model_validation.sklearn.SilhouettePlot",
     "validmind.model_validation.sklearn.RobustnessDiagnosis",
@@ -77,13 +77,14 @@ TestID = Literal[
     "validmind.model_validation.sklearn.ClassifierPerformance",
     "validmind.model_validation.sklearn.VMeasure",
     "validmind.model_validation.sklearn.MinimumF1Score",
+    "validmind.model_validation.sklearn.RegressionPerformance",
     "validmind.model_validation.sklearn.ROCCurve",
     "validmind.model_validation.sklearn.RegressionR2Square",
     "validmind.model_validation.sklearn.RegressionErrors",
     "validmind.model_validation.sklearn.ClusterPerformance",
-    "validmind.model_validation.sklearn.FeatureImportanceComparison",
     "validmind.model_validation.sklearn.TrainingTestDegradation",
     "validmind.model_validation.sklearn.RegressionErrorsComparison",
+    "validmind.model_validation.sklearn.FeatureImportance",
     "validmind.model_validation.sklearn.HyperParametersTuning",
     "validmind.model_validation.sklearn.KMeansClustersOptimization",
     "validmind.model_validation.sklearn.ModelsPerformanceComparison",
@@ -91,21 +92,15 @@ TestID = Literal[
     "validmind.model_validation.sklearn.RegressionR2SquareComparison",
     "validmind.model_validation.sklearn.PopulationStabilityIndex",
     "validmind.model_validation.sklearn.MinimumAccuracy",
-    "validmind.model_validation.statsmodels.RegressionModelsCoeffs",
-    "validmind.model_validation.statsmodels.BoxPierce",
-    "validmind.model_validation.statsmodels.RegressionCoeffsPlot",
     "validmind.model_validation.statsmodels.RegressionModelSensitivityPlot",
     "validmind.model_validation.statsmodels.RegressionModelForecastPlotLevels",
     "validmind.model_validation.statsmodels.ScorecardHistogram",
-    "validmind.model_validation.statsmodels.LJungBox",
-    "validmind.model_validation.statsmodels.JarqueBera",
     "validmind.model_validation.statsmodels.KolmogorovSmirnov",
-    "validmind.model_validation.statsmodels.ShapiroWilk",
     "validmind.model_validation.statsmodels.CumulativePredictionProbabilities",
     "validmind.model_validation.statsmodels.RegressionFeatureSignificance",
     "validmind.model_validation.statsmodels.RegressionModelSummary",
+    "validmind.model_validation.statsmodels.RegressionCoeffs",
     "validmind.model_validation.statsmodels.Lilliefors",
-    "validmind.model_validation.statsmodels.RunsTest",
     "validmind.model_validation.statsmodels.RegressionPermutationFeatureImportance",
     "validmind.model_validation.statsmodels.PredictionProbabilitiesHistogram",
     "validmind.model_validation.statsmodels.AutoARIMA",
@@ -116,13 +111,13 @@ TestID = Literal[
     "validmind.ongoing_monitoring.PredictionAcrossEachFeature",
     "validmind.ongoing_monitoring.FeatureDrift",
     "validmind.ongoing_monitoring.TargetPredictionDistributionPlot",
-    "validmind.data_validation.MissingValuesRisk",
     "validmind.data_validation.IQROutliersTable",
-    "validmind.data_validation.BivariateFeaturesBarPlots",
     "validmind.data_validation.Skewness",
+    "validmind.data_validation.BoxPierce",
     "validmind.data_validation.Duplicates",
     "validmind.data_validation.MissingValuesBarPlot",
     "validmind.data_validation.DatasetDescription",
+    "validmind.data_validation.ProtectedClassesCombination",
     "validmind.data_validation.ZivotAndrewsArch",
     "validmind.data_validation.ScatterPlot",
     "validmind.data_validation.TimeSeriesOutliers",
@@ -130,8 +125,9 @@ TestID = Literal[
     "validmind.data_validation.AutoStationarity",
     "validmind.data_validation.DescriptiveStatistics",
     "validmind.data_validation.TimeSeriesDescription",
-    "validmind.data_validation.ANOVAOneWayTable",
+    "validmind.data_validation.LJungBox",
     "validmind.data_validation.TargetRateBarPlots",
+    "validmind.data_validation.JarqueBera",
     "validmind.data_validation.PearsonCorrelationMatrix",
     "validmind.data_validation.FeatureTargetCorrelationPlot",
     "validmind.data_validation.TabularNumericalHistograms",
@@ -141,25 +137,27 @@ TestID = Literal[
     "validmind.data_validation.MissingValues",
     "validmind.data_validation.PhillipsPerronArch",
     "validmind.data_validation.RollingStatsPlot",
+    "validmind.data_validation.ProtectedClassesDisparity",
     "validmind.data_validation.TabularDescriptionTables",
     "validmind.data_validation.AutoMA",
     "validmind.data_validation.UniqueRows",
+    "validmind.data_validation.ShapiroWilk",
     "validmind.data_validation.TooManyZeroValues",
     "validmind.data_validation.HighPearsonCorrelation",
     "validmind.data_validation.ACFandPACFPlot",
-    "validmind.data_validation.BivariateHistograms",
     "validmind.data_validation.WOEBinTable",
-    "validmind.data_validation.HeatmapFeatureCorrelations",
     "validmind.data_validation.TimeSeriesFrequency",
     "validmind.data_validation.DatasetSplit",
     "validmind.data_validation.SpreadPlot",
     "validmind.data_validation.TimeSeriesLinePlot",
     "validmind.data_validation.KPSS",
     "validmind.data_validation.AutoSeasonality",
+    "validmind.data_validation.ProtectedClassesDescription",
     "validmind.data_validation.BivariateScatterPlots",
     "validmind.data_validation.EngleGrangerCoint",
     "validmind.data_validation.TimeSeriesMissingValues",
     "validmind.data_validation.TimeSeriesHistogram",
+    "validmind.data_validation.RunsTest",
     "validmind.data_validation.LaggedCorrelationHeatmap",
     "validmind.data_validation.SeasonalDecompose",
     "validmind.data_validation.WOEBinPlots",
@@ -169,6 +167,7 @@ TestID = Literal[
     "validmind.data_validation.TimeSeriesDescriptiveStatistics",
     "validmind.data_validation.AutoAR",
     "validmind.data_validation.TabularDateTimeHistograms",
+    "validmind.data_validation.ProtectedClassesThresholdOptimizer",
     "validmind.data_validation.ADF",
     "validmind.data_validation.nlp.Toxicity",
     "validmind.data_validation.nlp.PolarityAndSubjectivity",

validmind/tests/data_validation/ACFandPACFPlot.py

@@ -14,25 +14,27 @@ class ACFandPACFPlot(Metric):
     Analyzes time series data using Autocorrelation Function (ACF) and Partial Autocorrelation Function (PACF) plots to
     reveal trends and correlations.
 
-    **Purpose**: The ACF (Autocorrelation Function) and PACF (Partial Autocorrelation Function) plot test is employed
-    to analyze time series data in machine learning models. It illuminates the correlation of the data over time by
-    plotting the correlation of the series with its own lags (ACF), and the correlations after removing effects already
-    accounted for by earlier lags (PACF). This information can identify trends, such as seasonality, degrees of
-    autocorrelation, and inform the selection of order parameters for AutoRegressive Integrated Moving Average (ARIMA)
-    models.
+    ### Purpose
 
-    **Test Mechanism**: The `ACFandPACFPlot` test accepts a dataset with a time-based index. It first confirms the
-    index is of a datetime type, then handles any NaN values. The test subsequently generates ACF and PACF plots for
-    each column in the dataset, producing a subplot for each. If the dataset doesn't include key columns, an error is
-    returned.
+    The ACF (Autocorrelation Function) and PACF (Partial Autocorrelation Function) plot test is employed to analyze
+    time series data in machine learning models. It illuminates the correlation of the data over time by plotting the
+    correlation of the series with its own lags (ACF), and the correlations after removing effects already accounted
+    for by earlier lags (PACF). This information can identify trends, such as seasonality, degrees of autocorrelation,
+    and inform the selection of order parameters for AutoRegressive Integrated Moving Average (ARIMA) models.
 
-    **Signs of High Risk**:
+    ### Test Mechanism
+
+    The `ACFandPACFPlot` test accepts a dataset with a time-based index. It first confirms the index is of a datetime
+    type, then handles any NaN values. The test subsequently generates ACF and PACF plots for each column in the
+    dataset, producing a subplot for each. If the dataset doesn't include key columns, an error is returned.
+
+    ### Signs of High Risk
 
     - Sudden drops in the correlation at a specific lag might signal a model at high risk.
     - Consistent high correlation across multiple lags could also indicate non-stationarity in the data, which may
     suggest that a model estimated on this data won't generalize well to future, unknown data.
 
-    **Strengths**:
+    ### Strengths
 
     - ACF and PACF plots offer clear graphical representations of the correlations in time series data.
     - These plots are effective at revealing important data characteristics such as seasonality, trends, and
@@ -40,7 +42,7 @@ class ACFandPACFPlot(Metric):
     - The insights from these plots aid in better model configuration, particularly in the selection of ARIMA model
     parameters.
 
-    **Limitations**:
+    ### Limitations
 
     - ACF and PACF plots are exclusively for time series data and hence, can't be applied to all ML models.
     - These plots require large, consistent datasets as gaps could lead to misleading results.

validmind/tests/data_validation/ADF.py

@@ -18,31 +18,38 @@ class ADF(Metric):
     """
     Assesses the stationarity of a time series dataset using the Augmented Dickey-Fuller (ADF) test.
 
-    **Purpose**: The Augmented Dickey-Fuller (ADF) test metric is used here to determine the order of integration,
-    i.e., the stationarity of a given time series data. The stationary property of data is pivotal in many machine
-    learning models as it impacts the reliability and effectiveness of predictions and forecasts.
-
-    **Test Mechanism**: The ADF test starts by executing the ADF function from the statsmodels library on every feature
-    of the dataset. Multiple outputs are generated for each run, including the ADF test statistic and p-value, count of
-    lags used, the number of observations factored into the test, critical values at various confidence levels, and the
-    maximized information criterion. These results are stored for each feature for subsequent analysis.
-
-    **Signs of High Risk**:
-    - An inflated ADF statistic and high p-value (generally above 0.05) insinuate a high risk to the model's
-    performance due to the presence of a unit root indicating non-stationarity.
-    - Such non-stationarity might result in untrustworthy or insufficient forecasts.
-
-    **Strengths**:
-    - The ADF test is robust to more sophisticated correlation within the data, which empowers it to be deployed in
-    settings where data might display complex stochastic behavior.
-    - The ADF test provides explicit outputs like test statistics, critical values, and information criterion, thereby
-    enhancing our understanding and transparency of the model validation process.
-
-    **Limitations**:
+    ### Purpose
+
+    The Augmented Dickey-Fuller (ADF) test metric is used to determine the order of integration, i.e., the stationarity
+    of a given time series dataset. The stationary property of data is pivotal in many machine learning models as it
+    impacts the reliability and effectiveness of predictions and forecasts.
+
+    ### Test Mechanism
+
+    The ADF test is executed using the `adfuller` function from the `statsmodels` library on each feature of the
+    dataset. Multiple outputs are generated for each run, including the ADF test statistic and p-value, count of lags
+    used, the number of observations considered in the test, critical values at various confidence levels, and the
+    information criterion. These results are stored for each feature for subsequent analysis.
+
+    ### Signs of High Risk
+
+    - An inflated ADF statistic and high p-value (generally above 0.05) indicate a high risk to the model's performance
+    due to the presence of a unit root indicating non-stationarity.
+    - Non-stationarity might result in untrustworthy or insufficient forecasts.
+
+    ### Strengths
+
+    - The ADF test is robust to sophisticated correlations within the data, making it suitable for settings where data
+    displays complex stochastic behavior.
+    - It provides explicit outputs like test statistics, critical values, and information criterion, enhancing
+    understanding and transparency in the model validation process.
+
+    ### Limitations
+
     - The ADF test might demonstrate low statistical power, making it challenging to differentiate between a unit root
-    and near-unit-root processes causing false negatives.
-    - The test assumes the data follows an autoregressive process, which might not be the case all the time.
-    - The ADF test finds it demanding to manage time series data with structural breaks.
+    and near-unit-root processes, potentially causing false negatives.
+    - It assumes the data follows an autoregressive process, which might not always be the case.
+    - The test struggles with time series data that have structural breaks.
     """
 
     name = "adf"