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

validmind/tests/model_validation/ToxicityScore.py

@@ -13,31 +13,40 @@ from validmind import tags, tasks
 @tasks("text_classification", "text_summarization")
 def ToxicityScore(dataset, model):
     """
-    Computes and visualizes the toxicity score for input text, true text, and predicted text, assessing content quality and potential risk.
+    Assesses the toxicity levels of texts generated by NLP models to identify and mitigate harmful or offensive content.
 
-    **Purpose:**
-    The ToxicityScore metric is designed to evaluate the toxicity levels of texts generated by models. This is crucial for
-    identifying and mitigating harmful or offensive content in machine-generated texts.
+    ### Purpose
 
-    **Test Mechanism:**
-    The function starts by extracting the input, true, and predicted values from the provided dataset and model. The toxicity score is
-    computed for each text using a preloaded `toxicity` evaluation tool. The scores are compiled into dataframes, and histograms
-    and bar charts are generated to visualize the distribution of toxicity scores. Additionally, a table of descriptive statistics
-    (mean, median, standard deviation, minimum, and maximum) is compiled for the toxicity scores, providing a comprehensive
-    summary of the model's performance.
+    The ToxicityScore metric is designed to evaluate the toxicity levels of texts generated by models. This is crucial
+    for identifying and mitigating harmful or offensive content in machine-generated texts.
+
+    ### Test Mechanism
+
+    The function starts by extracting the input, true, and predicted values from the provided dataset and model. The
+    toxicity score is computed for each text using a preloaded `toxicity` evaluation tool. The scores are compiled into
+    dataframes, and histograms and bar charts are generated to visualize the distribution of toxicity scores.
+    Additionally, a table of descriptive statistics (mean, median, standard deviation, minimum, and maximum) is
+    compiled for the toxicity scores, providing a comprehensive summary of the model's performance.
+
+    ### Signs of High Risk
 
-    **Signs of High Risk:**
     - Drastic spikes in toxicity scores indicate potentially toxic content within the associated text segment.
-    - Persistent high toxicity scores across multiple texts may suggest systemic issues in the model's text generation process.
+    - Persistent high toxicity scores across multiple texts may suggest systemic issues in the model's text generation
+    process.
 
-    **Strengths:**
-    - Provides a clear evaluation of toxicity levels in generated texts, helping to ensure content safety and appropriateness.
-    - Visual representations (histograms and bar charts) make it easier to interpret the distribution and trends of toxicity scores.
+    ### Strengths
+
+    - Provides a clear evaluation of toxicity levels in generated texts, helping to ensure content safety and
+    appropriateness.
+    - Visual representations (histograms and bar charts) make it easier to interpret the distribution and trends of
+    toxicity scores.
     - Descriptive statistics offer a concise summary of the model's performance in generating non-toxic texts.
 
-    **Limitations:**
+    ### Limitations
+
     - The accuracy of the toxicity scores is contingent upon the underlying `toxicity` tool.
-    - The scores provide a broad overview but do not specify which portions or tokens of the text are responsible for high toxicity.
+    - The scores provide a broad overview but do not specify which portions or tokens of the text are responsible for
+    high toxicity.
     - Supplementary, in-depth analysis might be needed for granular insights.
     """
 

validmind/tests/model_validation/embeddings/ClusterDistribution.py

@@ -12,38 +12,42 @@ class ClusterDistribution(Metric):
     """
     Assesses the distribution of text embeddings across clusters produced by a model using KMeans clustering.
 
-    **Purpose:** The purpose of this metric is to analyze the distribution of the clusters produced by a text embedding
-    model. By dividing the text embeddings into different clusters, we can understand how the model is grouping or
-    categorizing the text data. This aids in visualizing the organization and segregation of the data and thus gives an
+    ### Purpose
+
+    The purpose of this metric is to analyze the distribution of the clusters produced by a text embedding model. By
+    dividing the text embeddings into different clusters, we can understand how the model is grouping or categorizing
+    the text data. This aids in visualizing the organization and segregation of the data, thereby giving an
     understanding of how the model is processing the data.
 
-    **Test Mechanism:** The metric applies the KMeans clustering algorithm on the predictions made by the model on the
-    testing dataset and divides the text embeddings into a pre-defined number of clusters. By default, this number is
-    set to 5 but can be customized as per requirements. The output of this test is a histogram plot that shows the
-    distribution of embeddings across these clusters.
+    ### Test Mechanism
+
+    The metric applies the KMeans clustering algorithm on the predictions made by the model on the testing dataset and
+    divides the text embeddings into a pre-defined number of clusters. By default, this number is set to 5 but can be
+    customized as per requirements. The output of this test is a histogram plot that shows the distribution of
+    embeddings across these clusters.
 
-    **Signs of High Risk:**
+    ### Signs of High Risk
 
-    - If the embeddings are skewed towards one or two clusters, that would indicate that the model is not effectively
+    - If the embeddings are skewed towards one or two clusters, it indicates that the model is not effectively
     differentiating the various categories in the text data.
     - Uniform distribution of the embeddings across the clusters might show a lack of proper categorization.
 
-    **Strengths:**
+    ### Strengths
 
-    - Great tool to visualize the text data categorization by the model. It provides a way to assess if the model is
-    distinguishing the categories effectively or not.
-    - It is flexible with the number of clusters (classes), so can be used on various types of data regardless of the
-    number of categories.
+    - Great tool to visualize the text data categorization by the model.
+    - Provides a way to assess if the model is distinguishing the categories effectively or not.
+    - Flexible with the number of clusters, so it can be used on various types of data regardless of the number of
+    categories.
 
-    **Limitations:**
+    ### Limitations
 
-    - The success or failure of this test is based on visual interpretation, which might not be enough for making solid
+    - Success or failure of this test is based on visual interpretation, which might not be enough for making solid
     conclusions or determining the exact points of failure.
-    - It assumes that the division of text embeddings across clusters should ideally be homogeneous, which might not
+    - Assumes that the division of text embeddings across clusters should ideally be homogeneous, which might not
     always be the case depending on the nature of the text data.
-    - It only applies to text embedding models, reducing its utility across various ML models.
-    - This test uses the KMeans clustering algorithm, which assumes that clusters are convex and isotropic. Thus, this
-    test may not work as intended if the true clusters in the data are not of this shape.
+    - Only applies to text embedding models, reducing its utility across various ML models.
+    - Uses the KMeans clustering algorithm, which assumes that clusters are convex and isotropic, and may not work as
+    intended if the true clusters in the data are not of this shape.
     """
 
     name = "Text Embeddings Cluster Distribution"

validmind/tests/model_validation/embeddings/CosineSimilarityComparison.py

@@ -16,45 +16,48 @@ from validmind import tags, tasks
 @tasks("text_qa", "text_generation", "text_summarization")
 def CosineSimilarityComparison(dataset, models):
     """
-    Computes pairwise cosine similarities between model embeddings and visualizes the results through bar charts,
-    alongside compiling a comprehensive table of descriptive statistics for each model pair.
+    Assesses the similarity between embeddings generated by different models using Cosine Similarity, providing both
+    statistical and visual insights.
 
-    **Purpose:**
-    This function is designed to analyze and compare the embeddings produced by different models using Cosine Similarity.
-    Cosine Similarity, a measure calculating the cosine of the angle between two vectors, is widely used to determine
-    the alignment or similarity between vectors in high-dimensional spaces, such as text embeddings. This analysis helps
-    to understand how similar or different the models' predictions are in terms of embedding generation.
+    ### Purpose
 
-    **Test Mechanism:**
-    The function begins by computing the embeddings for each model using the provided dataset. It then calculates the
-    cosine similarity for every possible pair of models, generating a similarity matrix. Each element of this matrix
-    represents the cosine similarity between two model embeddings. The function flattens this matrix and uses it to
-    create a bar chart for each model pair, visualizing their similarity distribution. Additionally, it compiles a table
-    with descriptive statistics (mean, median, standard deviation, minimum, and maximum) for the similarities of each
-    pair, including a reference to the compared models.
+    The Cosine Similarity Comparison test aims to analyze and compare the embeddings produced by different models using
+    Cosine Similarity. Cosine Similarity is a measure that calculates the cosine of the angle between two vectors,
+    widely used to determine the alignment or similarity between high-dimensional vectors, such as text embeddings.
+    This analysis helps understand how similar or different the models' predictions are in terms of embedding
+    generation.
 
-    **Signs of High Risk:**
+    ### Test Mechanism
+
+    The function starts by computing the embeddings for each model using the provided dataset. It then calculates the
+    cosine similarity for every possible pair of models, generating a similarity matrix wherein each element represents
+    the cosine similarity between two model embeddings. This matrix is flattened to create a bar chart for each model
+    pair, visualizing their similarity distribution. Additionally, a table with descriptive statistics (mean, median,
+    standard deviation, minimum, and maximum) for the similarities of each pair is compiled, referencing the compared
+    models.
+
+    ### Signs of High Risk
 
     - A high concentration of cosine similarity values close to 1 could suggest that the models are producing very
-      similar embeddings, which could be a sign of redundancy or lack of diversity in model training or design.
-    - Conversely, very low similarity values near -1 indicate strong dissimilarity, potentially highlighting models
-      that are too divergent, possibly focusing on very different features of the data.
+    similar embeddings, indicating redundancy or lack of diversity in model training or design.
+    - Very low similarity values near -1 highlight strong dissimilarity, suggesting models that are too divergent and
+    possibly focusing on very different features of the data.
 
-    **Strengths:**
+    ### Strengths
 
     - Enables detailed comparisons between multiple models' embedding strategies through visual and statistical means.
-    - Helps identify which models produce similar or dissimilar embeddings, useful for tasks requiring model diversity.
+    - Identifies models producing similar or dissimilar embeddings, useful for tasks requiring model diversity.
     - Provides quantitative and visual feedback on the degree of similarity, enhancing interpretability of model
-      behavior in embedding spaces.
+    behavior in embedding spaces.
 
-    **Limitations:**
+    ### Limitations
 
-    - The analysis is confined to the comparison of embeddings and does not assess the overall performance of the models
-      in terms of their primary tasks (e.g., classification, regression).
+    - The analysis is confined to the comparison of embeddings and does not assess the overall performance of the
+    models in terms of their primary tasks (e.g., classification, regression).
     - Assumes that the models are suitable for generating comparable embeddings, which might not always be the case,
-      especially across different types of models.
-    - Interpretation of results is heavily dependent on the understanding of Cosine Similarity and the nature of high-dimensional
-      embedding spaces.
+    especially across different types of models.
+    - Interpretation of results is heavily dependent on the understanding of Cosine Similarity and the nature of
+    high-dimensional embedding spaces.
     """
 
     figures = []

validmind/tests/model_validation/embeddings/CosineSimilarityDistribution.py

@@ -13,32 +13,34 @@ class CosineSimilarityDistribution(Metric):
     Assesses the similarity between predicted text embeddings from a model using a Cosine Similarity distribution
     histogram.
 
-    **Purpose:**
+    ### Purpose
+
     This metric is used to assess the degree of similarity between the embeddings produced by a text embedding model
     using Cosine Similarity. Cosine Similarity is a measure that calculates the cosine of the angle between two
     vectors. This metric is predominantly used in text analysis — in this case, to determine how closely the predicted
     text embeddings align with one another.
 
-    **Test Mechanism:**
+    ### Test Mechanism
+
     The implementation starts by computing the cosine similarity between the predicted values of the model's test
     dataset. These cosine similarity scores are then plotted on a histogram with 100 bins to visualize the distribution
     of the scores. The x-axis of the histogram represents the computed Cosine Similarity.
 
-    **Signs of High Risk:**
+    ### Signs of High Risk
 
     - If the cosine similarity scores cluster close to 1 or -1, it may indicate overfitting, as the model's predictions
     are almost perfectly aligned. This could suggest that the model is not generalizable.
     - A broad spread of cosine similarity scores across the histogram may indicate a potential issue with the model's
     ability to generate consistent embeddings.
 
-    **Strengths:**
+    ### Strengths
 
     - Provides a visual representation of the model's performance which is easily interpretable.
     - Can help identify patterns, trends, and outliers in the model's alignment of predicted text embeddings.
     - Useful in measuring the similarity between vectors in multi-dimensional space, important in the case of text
     embeddings.
 
-    **Limitations:**
+    ### Limitations
 
     - Only evaluates the similarity between outputs. It does not provide insight into the model's ability to correctly
     classify or predict.

validmind/tests/model_validation/embeddings/CosineSimilarityHeatmap.py

@@ -23,33 +23,42 @@ def CosineSimilarityHeatmap(
     """
     Generates an interactive heatmap to visualize the cosine similarities among embeddings derived from a given model.
 
-    **Purpose:**
-    This function is designed to visually analyze the cosine similarities of embeddings from a specific model.
-    Cosine similarity, a measure of the cosine of the angle between two vectors, aids in understanding the
-    orientation and similarity of vectors in multi-dimensional space. This is particularly valuable for exploring
-    text embeddings and their relative similarities among documents, words, or phrases.
-
-    **Test Mechanism:**
-    The function operates through a sequence of steps to visualize cosine similarities. Initially,
-    embeddings are extracted for each dataset entry using the designated model. Following this,
-    the function computes the pairwise cosine similarities among these embeddings. The computed similarities
-    are then displayed in an interactive heatmap.
-
-    **Signs of High Risk:**
-    - High similarity values (close to 1) across the heatmap might not always be indicative of a risk;
-    however, in contexts where diverse perspectives or features are desired, this could suggest a lack of
-    diversity in the model's learning process or potential redundancy.
+    ### Purpose
+
+    This function is designed to visually analyze the cosine similarities of embeddings from a specific model. Cosine
+    similarity, a measure of the cosine of the angle between two vectors, aids in understanding the orientation and
+    similarity of vectors in multi-dimensional space. This is particularly valuable for exploring text embeddings and
+    their relative similarities among documents, words, or phrases.
+
+    ### Test Mechanism
+
+    The function operates through a sequence of steps to visualize cosine similarities. Initially, embeddings are
+    extracted for each dataset entry using the designated model. Following this, the function computes the pairwise
+    cosine similarities among these embeddings. The computed similarities are then displayed in an interactive heatmap.
+
+    ### Signs of High Risk
+
+    - High similarity values (close to 1) across the heatmap might not always be indicative of a risk; however, in
+    contexts where diverse perspectives or features are desired, this could suggest a lack of diversity in the model's
+    learning process or potential redundancy.
     - Similarly, low similarity values (close to -1) indicate strong dissimilarity, which could be beneficial in
     scenarios demanding diverse outputs. However, in cases where consistency is needed, these low values might
-    highlight that the model is unable to capture a coherent set of features from the data, potentially leading to poor performance on related tasks.
+    highlight that the model is unable to capture a coherent set of features from the data, potentially leading to poor
+    performance on related tasks.
+
+    ### Strengths
+
+    - Provides an interactive and intuitive visual representation of embedding similarities, facilitating easy
+    exploration and analysis.
+    - Allows customization of visual elements such as title, axis labels, and color scale to suit specific analytical
+    needs and preferences.
 
-    **Strengths:**
-    - Provides an interactive and intuitive visual representation of embedding similarities, facilitating easy exploration and analysis.
-    - Allows customization of visual elements such as title, axis labels, and color scale to suit specific analytical needs and preferences.
+    ### Limitations
 
-    **Limitations:**
-    - As the number of embeddings increases, the effectiveness of the heatmap might diminish due to overcrowding, making it hard to discern detailed similarities.
-    - The interpretation of the heatmap heavily relies on the appropriate setting of the color scale, as incorrect settings can lead to misleading visual interpretations.
+    - As the number of embeddings increases, the effectiveness of the heatmap might diminish due to overcrowding,
+    making it hard to discern detailed similarities.
+    - The interpretation of the heatmap heavily relies on the appropriate setting of the color scale, as incorrect
+    settings can lead to misleading visual interpretations.
     """
 
     embeddings = np.stack(dataset.y_pred(model))

validmind/tests/model_validation/embeddings/DescriptiveAnalytics.py

@@ -13,26 +13,28 @@ class DescriptiveAnalytics(Metric):
     Evaluates statistical properties of text embeddings in an ML model via mean, median, and standard deviation
     histograms.
 
-    **1. Purpose:**
+    ### Purpose
+
     This metric, Descriptive Analytics for Text Embeddings Models, is employed to comprehend the fundamental properties
     and statistical characteristics of the embeddings in a Machine Learning model. It measures the dimensionality as
     well as the statistical distributions of embedding values including the mean, median, and standard deviation.
 
-    **2. Test Mechanism:**
+    ### Test Mechanism
+
     The test mechanism involves using the 'DescriptiveAnalytics' class provided in the code which includes the 'run'
     function. This function computes three statistical measures - mean, median, and standard deviation of the test
     predictions from the model. It generates and caches three separate histograms showing the distribution of these
     measures. Each histogram visualizes the measure's distribution across the embedding values. Therefore, the method
     does not utilize a grading scale or threshold; it is fundamentally a visual exploration and data exploration tool.
 
-    **3. Signs of High Risk:**
+    ### Signs of High Risk
 
     - Abnormal patterns or values in the distributions of the statistical measures. This may include skewed
     distributions or a significant amount of outliers.
     - Very high standard deviation values which indicate a high degree of variability in the data.
     - The mean and median values are vastly different, suggesting skewed data.
 
-    **4. Strengths:**
+    ### Strengths
 
     - Provides a visual and quantifiable understanding of the embeddings' statistical characteristics, allowing for a
     comprehensive evaluation.
@@ -41,7 +43,7 @@ class DescriptiveAnalytics(Metric):
     - It considers three key statistical measures (mean, median, and standard deviation), offering a more well-rounded
     understanding of the data.
 
-    **5. Limitations:**
+    ### Limitations
 
     - The method does not offer an explicit measure of model performance or accuracy, as it mainly focuses on
     understanding data properties.

validmind/tests/model_validation/embeddings/EmbeddingsVisualization2D.py

@@ -12,24 +12,28 @@ class EmbeddingsVisualization2D(Metric):
     """
     Visualizes 2D representation of text embeddings generated by a model using t-SNE technique.
 
-    **1. Purpose:** The objective of this metric is to provide a visual 2D representation of the embeddings created by
-    a text embedding machine learning model. By doing so, it aids in analyzing the embedding space created by the model
-    and helps in understanding how the learned embeddings are distributed and how they relate to each other.
+    ### Purpose
 
-    **2. Test Mechanism:** This metric uses the t-Distributed Stochastic Neighbor Embedding (t-SNE) technique, which is
-    a tool for visualizing high-dimensional data by reducing the dimensionality to 2. The perplexity parameter for
-    t-SNE is set to the value provided by the user. If the input perplexity value is greater than the number of
-    samples, the perplexity is adjusted to be one less than the number of samples. Following the reduction of
-    dimensionality, a scatter plot is produced depicting each embedding as a data point in the visualized 2D plane.
+    The objective of this metric is to provide a visual 2D representation of the embeddings created by a text embedding
+    machine learning model. By doing so, it aids in analyzing the embedding space created by the model and helps in
+    understanding how the learned embeddings are distributed and how they relate to each other.
 
-    **3. Signs of High Risk:**
+    ### Test Mechanism
+
+    This metric uses the t-Distributed Stochastic Neighbor Embedding (t-SNE) technique, which is a tool for visualizing
+    high-dimensional data by reducing the dimensionality to 2. The perplexity parameter for t-SNE is set to the value
+    provided by the user. If the input perplexity value is greater than the number of samples, the perplexity is
+    adjusted to be one less than the number of samples. Following the reduction of dimensionality, a scatter plot is
+    produced depicting each embedding as a data point in the visualized 2D plane.
+
+    ### Signs of High Risk
 
     - If the embeddings are highly concentrated in a specific region of the plane, it might indicate that the model is
     not learning diverse representations of the text.
     - Wide gaps or partitions in the visualization could suggest that the model is over-segmenting in the embedding
     space and may lead to poor generalization.
 
-    **4. Strengths:**
+    ### Strengths
 
     - Offers a powerful visual tool that can assist in understanding and interpreting high-dimensional embeddings,
     which could otherwise be difficult to visualize.
@@ -37,7 +41,7 @@ class EmbeddingsVisualization2D(Metric):
     - t-SNE visualization helps in focusing on local structures and preserves the proximity of points that are close
     together in the original high-dimensional space.
 
-    **5. Limitations:**
+    ### Limitations
 
     - The reduction of high-dimensional data to 2D can result in loss of some information, which may lead to
     misinterpretation.

validmind/tests/model_validation/embeddings/EuclideanDistanceComparison.py

@@ -16,41 +16,41 @@ from validmind import tags, tasks
 @tasks("text_qa", "text_generation", "text_summarization")
 def EuclideanDistanceComparison(dataset, models):
     """
-    Computes pairwise Euclidean distances between model embeddings and visualizes the results through bar charts,
-    alongside compiling a comprehensive table of descriptive statistics for each model pair.
-
-    **Purpose:**
-    This function is designed to analyze and compare the embeddings produced by different models using Euclidean Distance.
-    Euclidean Distance measures the "ordinary" straight-line distance between two points in Euclidean space, providing a
-    straightforward metric to assess the absolute differences between vectors. This analysis helps in understanding the
-    magnitude of dissimilarity between the embeddings generated by different models, which is crucial for tasks that require
-    distinctive model responses or feature separations.
-
-    **Test Mechanism:**
-    The function begins by computing the embeddings for each model using the provided dataset. It then calculates the
-    Euclidean distance for every possible pair of models, generating a distance matrix. Each element of this matrix
-    represents the Euclidean distance between two model embeddings. The function flattens this matrix and uses it to
-    create a bar chart for each model pair, visualizing their distance distribution. Additionally, it compiles a table
-    with descriptive statistics (mean, median, standard deviation, minimum, and maximum) for the distances of each
-    pair, including a reference to the compared models.
-
-    **Signs of High Risk:**
-
-    - Very high distance values could suggest that the models are focusing on completely different features or aspects
-      of the data, which might be undesirable for ensemble methods or similar applications where some degree of
-      consensus is expected.
-    - Extremely low distances across different models might indicate redundancy, suggesting that the models are not
-      providing diverse enough perspectives on the data.
-
-    **Strengths:**
+    Assesses and visualizes the dissimilarity between model embeddings using Euclidean distance, providing insights
+    into model behavior and potential redundancy or diversity.
+
+    ### Purpose
+
+    The Euclidean Distance Comparison test aims to analyze and compare the embeddings produced by different models. By
+    measuring the Euclidean distance between vectors in Euclidean space, it provides a metric to assess the magnitude
+    of dissimilarity between embeddings created by different models. This is crucial for tasks that require models to
+    produce distinct responses or feature separations.
+
+    ### Test Mechanism
+
+    The test computes the embeddings for each model using the provided dataset and calculates the Euclidean distance
+    for every possible pair of models. It generates a distance matrix where each element represents the Euclidean
+    distance between two model embeddings. This matrix is then visualized through bar charts, showing the distance
+    distribution for each model pair. Additionally, it compiles a table with descriptive statistics such as mean,
+    median, standard deviation, minimum, and maximum distances for each model pair, including references to the
+    compared models.
+
+    ### Signs of High Risk
+
+    - Very high distance values could suggest that models are focusing on entirely different features or aspects of the
+    data, which might be undesirable for ensemble methods or when a consensus is required.
+    - Extremely low distances across different models might indicate redundancy, suggesting that models are not
+    providing diverse enough perspectives on the data.
+
+    ### Strengths
 
     - Provides a clear and quantifiable measure of how different the embeddings from various models are.
     - Useful for identifying outlier models or those that behave significantly differently from others in a group.
 
-    **Limitations:**
+    ### Limitations
 
     - Euclidean distance can be sensitive to the scale of the data, meaning that preprocessing steps like normalization
-      might be necessary to ensure meaningful comparisons.
+    might be necessary to ensure meaningful comparisons.
     - Does not consider the orientation or angle between vectors, focusing purely on magnitude differences.
     """
 

validmind/tests/model_validation/embeddings/EuclideanDistanceHeatmap.py

@@ -23,31 +23,40 @@ def EuclideanDistanceHeatmap(
     """
     Generates an interactive heatmap to visualize the Euclidean distances among embeddings derived from a given model.
 
-    **Purpose:**
-    This function visualizes the Euclidean distances between embeddings generated by a model, offering insights into the
-    absolute differences between data points. Euclidean distance, a fundamental metric in data analysis, measures the
-    straight-line distance between two points in Euclidean space. It is particularly useful for understanding spatial
-    relationships and clustering tendencies in high-dimensional data.
-
-    **Test Mechanism:**
-    The function operates through a streamlined process: firstly, embeddings are extracted for each dataset entry using the specified model.
-    Subsequently, it computes the pairwise Euclidean distances among these embeddings. The results are then visualized in an interactive heatmap format,
-    where each cell's color intensity correlates with the distance magnitude between pairs of embeddings, providing a visual assessment of these distances.
-
-    **Signs of High Risk:**
-    - Uniform Distances: Uniformly low distances across the heatmap might suggest a lack of variability in the data or
-    model overfitting, where the model fails to distinguish between distinct data points effectively.
-    - High Variability: Conversely, excessive variability in distances could indicate inconsistent data representation,
-    potentially leading to unreliable model predictions.
-
-    **Strengths:**
-    - Provides a direct, intuitive visual representation of distances between embeddings, aiding in the detection of patterns or anomalies.
-    - Allows customization of visual aspects such as the heatmap's title, axis labels, and color scale, adapting to various analytical needs.
-
-    **Limitations:**
-    - The interpretation of distances can be sensitive to the scale of data; normalization might be necessary for meaningful analysis.
-    - Large datasets may lead to dense, cluttered heatmaps, making it difficult to discern individual distances, potentially requiring
-    techniques like data sampling or dimensionality reduction for clearer visualization.
+    ### Purpose
+
+    This function visualizes the Euclidean distances between embeddings generated by a model, offering insights into
+    the absolute differences between data points. Euclidean distance, a fundamental metric in data analysis, measures
+    the straight-line distance between two points in Euclidean space. It is particularly useful for understanding
+    spatial relationships and clustering tendencies in high-dimensional data.
+
+    ### Test Mechanism
+
+    The function operates through a streamlined process: firstly, embeddings are extracted for each dataset entry using
+    the specified model. Subsequently, it computes the pairwise Euclidean distances among these embeddings. The results
+    are then visualized in an interactive heatmap format, where each cell's color intensity correlates with the
+    distance magnitude between pairs of embeddings, providing a visual assessment of these distances.
+
+    ### Signs of High Risk
+
+    - Uniformly low distances across the heatmap might suggest a lack of variability in the data or model overfitting,
+    where the model fails to distinguish between distinct data points effectively.
+    - Excessive variability in distances could indicate inconsistent data representation, potentially leading to
+    unreliable model predictions.
+
+    ### Strengths
+
+    - Provides a direct, intuitive visual representation of distances between embeddings, aiding in the detection of
+    patterns or anomalies.
+    - Allows customization of visual aspects such as the heatmap's title, axis labels, and color scale, adapting to
+    various analytical needs.
+
+    ### Limitations
+
+    - The interpretation of distances can be sensitive to the scale of data; normalization might be necessary for
+    meaningful analysis.
+    - Large datasets may lead to dense, cluttered heatmaps, making it difficult to discern individual distances,
+    potentially requiring techniques like data sampling or dimensionality reduction for clearer visualization.
     """
 
     embeddings = np.stack(dataset.y_pred(model))