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

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,7 @@ TestID = Literal[
     "validmind.model_validation.ClusterSizeDistribution",
     "validmind.model_validation.TokenDisparity",
     "validmind.model_validation.ToxicityScore",
-    "validmind.model_validation.ModelMetadataComparison",
+    "validmind.model_validation.ModelMetadata",
     "validmind.model_validation.TimeSeriesR2SquareBySegments",
     "validmind.model_validation.embeddings.CosineSimilarityComparison",
     "validmind.model_validation.embeddings.EmbeddingsVisualization2D",
@@ -81,21 +81,17 @@ TestID = Literal[
     "validmind.model_validation.sklearn.RegressionR2Square",
     "validmind.model_validation.sklearn.RegressionErrors",
     "validmind.model_validation.sklearn.ClusterPerformance",
-    "validmind.model_validation.sklearn.FeatureImportanceComparison",
+    "validmind.model_validation.sklearn.FeatureImportance",
     "validmind.model_validation.sklearn.TrainingTestDegradation",
-    "validmind.model_validation.sklearn.RegressionErrorsComparison",
     "validmind.model_validation.sklearn.HyperParametersTuning",
     "validmind.model_validation.sklearn.KMeansClustersOptimization",
     "validmind.model_validation.sklearn.ModelsPerformanceComparison",
     "validmind.model_validation.sklearn.WeakspotsDiagnosis",
-    "validmind.model_validation.sklearn.RegressionR2SquareComparison",
     "validmind.model_validation.sklearn.PopulationStabilityIndex",
     "validmind.model_validation.sklearn.MinimumAccuracy",
-    "validmind.model_validation.statsmodels.RegressionModelsCoeffs",
+    "validmind.model_validation.statsmodels.RegressionModelCoeffs",
     "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",
@@ -110,15 +106,12 @@ TestID = Literal[
     "validmind.model_validation.statsmodels.PredictionProbabilitiesHistogram",
     "validmind.model_validation.statsmodels.AutoARIMA",
     "validmind.model_validation.statsmodels.GINITable",
-    "validmind.model_validation.statsmodels.RegressionModelForecastPlot",
     "validmind.model_validation.statsmodels.DurbinWatsonTest",
     "validmind.ongoing_monitoring.PredictionCorrelation",
     "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.Duplicates",
     "validmind.data_validation.MissingValuesBarPlot",
@@ -130,7 +123,6 @@ TestID = Literal[
     "validmind.data_validation.AutoStationarity",
     "validmind.data_validation.DescriptiveStatistics",
     "validmind.data_validation.TimeSeriesDescription",
-    "validmind.data_validation.ANOVAOneWayTable",
     "validmind.data_validation.TargetRateBarPlots",
     "validmind.data_validation.PearsonCorrelationMatrix",
     "validmind.data_validation.FeatureTargetCorrelationPlot",
@@ -147,9 +139,7 @@ TestID = Literal[
     "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/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"

validmind/tests/data_validation/AutoAR.py

@@ -16,7 +16,7 @@ class AutoAR(Metric):
     """
     Automatically identifies the optimal Autoregressive (AR) order for a time series using BIC and AIC criteria.
 
-    **Purpose**:
+    ### Purpose
 
     The AutoAR test is intended to automatically identify the Autoregressive (AR) order of a time series by utilizing
     the Bayesian Information Criterion (BIC) and Akaike Information Criterion (AIC). AR order is crucial in forecasting
@@ -24,30 +24,30 @@ class AutoAR(Metric):
     objective is to select the most fitting AR model that encapsulates the trend and seasonality in the time series
     data.
 
-    **Test Mechanism**:
+    ### Test Mechanism
 
     The test mechanism operates by iterating through a possible range of AR orders up to a defined maximum. An AR model
     is fitted for each order, and the corresponding BIC and AIC are computed. BIC and AIC statistical measures are
     designed to penalize models for complexity, preferring simpler models that fit the data proficiently. To verify the
-    stationarity of the time series, the Augmented Dickey-Fuller test is executed. The AR order, BIC, and AIC findings,
+    stationarity of the time series, the Augmented Dickey-Fuller test is executed. The AR order, BIC, and AIC findings
     are compiled into a dataframe for effortless comparison. Then, the AR order with the smallest BIC is established as
     the desirable order for each variable.
 
-    **Signs of High Risk**:
+    ### Signs of High Risk
 
     - An augmented Dickey Fuller test p-value > 0.05, indicating the time series isn't stationary, may lead to
     inaccurate results.
     - Problems with the model fitting procedure, such as computational or convergence issues.
-    - Continuous selection of the maximum specified AR order may suggest insufficient set limit.
+    - Continuous selection of the maximum specified AR order may suggest an insufficient set limit.
 
-    **Strengths**:
+    ### Strengths
 
     - The test independently pinpoints the optimal AR order, thereby reducing potential human bias.
     - It strikes a balance between model simplicity and goodness-of-fit to avoid overfitting.
-    - Has the capability to account for stationarity in a time series, an essential aspect for dependable AR modelling.
-    - The results are aggregated into an comprehensive table, enabling an easy interpretation.
+    - Has the capability to account for stationarity in a time series, an essential aspect for dependable AR modeling.
+    - The results are aggregated into a comprehensive table, enabling an easy interpretation.
 
-    **Limitations**:
+    ### Limitations
 
     - The tests need a stationary time series input.
     - They presume a linear relationship between the series and its lags.

validmind/tests/data_validation/AutoMA.py

@@ -17,32 +17,39 @@ class AutoMA(Metric):
     Automatically selects the optimal Moving Average (MA) order for each variable in a time series dataset based on
     minimal BIC and AIC values.
 
-    **Purpose**: The `AutoMA` metric serves an essential role of automated decision-making for selecting the optimal
-    Moving Average (MA) order for every variable in a given time series dataset. The selection is dependent on the
-    minimalization of BIC (Bayesian Information Criterion) and AIC (Akaike Information Criterion); these are
-    established statistical tools used for model selection. Furthermore, prior to the commencement of the model fitting
-    process, the algorithm conducts a stationarity test (Augmented Dickey-Fuller test) on each series.
-
-    **Test Mechanism**: Starting off, the `AutoMA` algorithm checks whether the `max_ma_order` parameter has been
-    provided. It consequently loops through all variables in the dataset, carrying out the Dickey-Fuller test for
-    stationarity. For each stationary variable, it fits an ARIMA model for orders running from 0 to `max_ma_order`. The
-    result is a list showcasing the BIC and AIC values of the ARIMA models based on different orders. The MA order,
-    which yields the smallest BIC, is chosen as the 'best MA order' for every single variable. The final results
-    include a table summarizing the auto MA analysis and another table listing the best MA order for each variable.
-
-    **Signs of High Risk**:
+    ### Purpose
+
+    The `AutoMA` metric serves an essential role of automated decision-making for selecting the optimal Moving Average
+    (MA) order for every variable in a given time series dataset. The selection is dependent on the minimalization of
+    BIC (Bayesian Information Criterion) and AIC (Akaike Information Criterion); these are established statistical
+    tools used for model selection. Furthermore, prior to the commencement of the model fitting process, the algorithm
+    conducts a stationarity test (Augmented Dickey-Fuller test) on each series.
+
+    ### Test Mechanism
+
+    Starting off, the `AutoMA` algorithm checks whether the `max_ma_order` parameter has been provided. It consequently
+    loops through all variables in the dataset, carrying out the Dickey-Fuller test for stationarity. For each
+    stationary variable, it fits an ARIMA model for orders running from 0 to `max_ma_order`. The result is a list
+    showcasing the BIC and AIC values of the ARIMA models based on different orders. The MA order, which yields the
+    smallest BIC, is chosen as the 'best MA order' for every single variable. The final results include a table
+    summarizing the auto MA analysis and another table listing the best MA order for each variable.
+
+    ### Signs of High Risk
+
     - When a series is non-stationary (p-value>0.05 in the Dickey-Fuller test), the produced result could be inaccurate.
     - Any error that arises in the process of fitting the ARIMA models, especially with a higher MA order, can
     potentially indicate risks and might need further investigation.
 
-    **Strengths**:
+    ### Strengths
+
     - The metric facilitates automation in the process of selecting the MA order for time series forecasting. This
     significantly saves time and reduces efforts conventionally necessary for manual hyperparameter tuning.
     - The use of both BIC and AIC enhances the likelihood of selecting the most suitable model.
     - The metric ascertains the stationarity of the series prior to model fitting, thus ensuring that the underlying
     assumptions of the MA model are fulfilled.
 
-    **Limitations**:
+    ### Limitations
+
     - If the time series fails to be stationary, the metric may yield inaccurate results. Consequently, it necessitates
     pre-processing steps to stabilize the series before fitting the ARIMA model.
     - The metric adopts a rudimentary model selection process based on BIC and doesn't consider other potential model

validmind/tests/data_validation/AutoSeasonality.py

@@ -17,28 +17,30 @@ class AutoSeasonality(Metric):
     Automatically identifies and quantifies optimal seasonality in time series data to improve forecasting model
     performance.
 
-    **Purpose:**
-    The AutoSeasonality metric's purpose is to automatically detect and identify the best seasonal order or period for
-    each variable in a time series dataset. This detection helps to quantify periodic patterns and seasonality that
-    reoccur at fixed intervals of time in the data. This is especially significant for forecasting-based models, where
-    understanding the seasonality component can drastically improve prediction accuracy.
-
-    **Test Mechanism:**
-    This metric uses the seasonal decomposition method from the Statsmodels Python library. The function takes the
+    ### Purpose
+
+    The AutoSeasonality test aims to automatically detect and identify the best seasonal order or period for each
+    variable in a time series dataset. This detection helps to quantify periodic patterns and seasonality that reoccur
+    at fixed intervals in the data. Understanding the seasonality component can drastically improve prediction
+    accuracy, which is especially significant for forecasting-based models.
+
+    ### Test Mechanism
+
+    This test uses the seasonal decomposition method from the Statsmodels Python library. The function takes the
     'additive' model type for each variable and applies it within the prescribed range of 'min_period' and
-    'max_period'. The function decomposes the seasonality for each period in the range and calculates the mean residual
-    error for each period. The seasonal period that results in the minimum residuals is marked as the 'Best Period'.
-    The test results include the 'Best Period', the calculated residual errors, and a determination of 'Seasonality' or
-    'No Seasonality'.
+    'max_period'. It decomposes the seasonality for each period in the range and calculates the mean residual error for
+    each period. The seasonal period that results in the minimum residuals is marked as the 'Best Period'. The test
+    results include the 'Best Period', the calculated residual errors, and a determination of 'Seasonality' or 'No
+    Seasonality'.
 
-    **Signs of High Risk:**
+    ### Signs of High Risk
 
     - If the optimal seasonal period (or 'Best Period') is consistently at the maximum or minimum limit of the offered
     range for a majority of variables, it may suggest that the range set does not adequately capture the true seasonal
     pattern in the series.
     - A high average 'Residual Error' for the selected 'Best Period' could indicate issues with the model's performance.
 
-    **Strengths:**
+    ### Strengths
 
     - The metric offers an automatic approach to identifying and quantifying the optimal seasonality, providing a
     robust method for analyzing time series datasets.
@@ -46,9 +48,9 @@ class AutoSeasonality(Metric):
     seasonality.
     - The use of concrete and measurable statistical methods improves the objectivity and reproducibility of the model.
 
-    **Limitations:**
+    ### Limitations
 
-    - This AutoSeasonality metric may not be suitable if the time series data exhibits random walk behaviour or lacks
+    - This AutoSeasonality metric may not be suitable if the time series data exhibits random walk behavior or lacks
     clear seasonality, as the seasonal decomposition model may not be appropriate.
     - The defined range for the seasonal period (min_period and max_period) can influence the outcomes. If the actual
     seasonality period lies outside this range, this method will not be able to identify the true seasonal order.

validmind/tests/data_validation/AutoStationarity.py

@@ -13,26 +13,30 @@ class AutoStationarity(Metric):
     """
     Automates Augmented Dickey-Fuller test to assess stationarity across multiple time series in a DataFrame.
 
-    **Purpose**: The AutoStationarity metric is intended to automatically detect and evaluate the stationary nature of
-    each time series in a DataFrame. It incorporates the Augmented Dickey-Fuller (ADF) test, a statistical approach
-    used to assess stationarity. Stationarity is a fundamental property suggesting that statistic features like mean
-    and variance remain unchanged over time. This is necessary for many time-series models.
-
-    **Test Mechanism**: The mechanism for the AutoStationarity test involves applying the Augmented Dicky-Fuller test
-    to each time series within the given dataframe to assess if they are stationary. Every series in the dataframe is
-    looped, using the ADF test up to a defined maximum order (configurable and by default set to 5). The p-value
-    resulting from the ADF test is compared against a predetermined threshold (also configurable and by default set to
-    0.05). The time series is deemed stationary at its current differencing order if the p-value is less than the
-    threshold.
-
-    **Signs of High Risk**:
+    ### Purpose
+
+    The AutoStationarity metric is intended to automatically detect and evaluate the stationary nature of each time
+    series in a DataFrame. It incorporates the Augmented Dickey-Fuller (ADF) test, a statistical approach used to
+    assess stationarity. Stationarity is a fundamental property suggesting that statistic features like mean and
+    variance remain unchanged over time. This is necessary for many time-series models.
+
+    ### Test Mechanism
+
+    The mechanism for the AutoStationarity test involves applying the Augmented Dicky-Fuller test to each time series
+    within the given dataframe to assess if they are stationary. Every series in the dataframe is looped, using the ADF
+    test up to a defined maximum order (configurable and by default set to 5). The p-value resulting from the ADF test
+    is compared against a predetermined threshold (also configurable and by default set to 0.05). The time series is
+    deemed stationary at its current differencing order if the p-value is less than the threshold.
+
+    ### Signs of High Risk
+
     - A significant number of series not achieving stationarity even at the maximum order of differencing can indicate
     high risk or potential failure in the model.
     - This could suggest the series may not be appropriately modeled by a stationary process, hence other modeling
     approaches might be required.
 
+    ### Strengths
 
-    **Strengths**:
     - The key strength in this metric lies in the automation of the ADF test, enabling mass stationarity analysis
     across various time series and boosting the efficiency and credibility of the analysis.
     - The utilization of the ADF test, a widely accepted method for testing stationarity, lends authenticity to the
@@ -40,8 +44,9 @@ class AutoStationarity(Metric):
     - The introduction of the max order and threshold parameters give users the autonomy to determine their preferred
     levels of stringency in the tests.
 
-    **Limitations**:
-    - The Augumented Dicky-Fuller test and the stationarity test are not without their limitations. These tests are
+    ### Limitations
+
+    - The Augmented Dickey-Fuller test and the stationarity test are not without their limitations. These tests are
     premised on the assumption that the series can be modeled by an autoregressive process, which may not always hold
     true.
     - The stationarity check is highly sensitive to the choice of threshold for the significance level; an extremely