validmind 2.7.6__py3-none-any.whl → 2.7.8__py3-none-any.whl

validmind/tests/model_validation/ModelPredictionResiduals.py

@@ -6,7 +6,7 @@ import pandas as pd
 import plotly.graph_objects as go
 from scipy.stats import kstest
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 
 
 @tags("regression")
@@ -102,4 +102,4 @@ def ModelPredictionResiduals(
     # Create a summary DataFrame for the KS normality test results
     summary_df = pd.DataFrame([summary])
 
-    return (summary_df, *figures)
+    return (summary_df, *figures, RawData(residuals=residuals))

validmind/tests/model_validation/RegardScore.py

@@ -6,7 +6,7 @@ import evaluate
 import pandas as pd
 import plotly.graph_objects as go
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 from validmind.tests.utils import validate_prediction
 
 
@@ -142,4 +142,8 @@ def RegardScore(dataset, model):
         ]
     ]
 
-    return (result_df, *tuple(figures))
+    return (
+        result_df,
+        *figures,
+        RawData(true_regard=true_df, pred_regard=pred_df),
+    )

validmind/tests/model_validation/RegressionResidualsPlot.py

@@ -6,7 +6,7 @@ import numpy as np
 import plotly.figure_factory as ff
 import plotly.graph_objects as go
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 from validmind.vm_models import VMDataset, VMModel
 
 
@@ -60,8 +60,9 @@ def RegressionResidualsPlot(model: VMModel, dataset: VMDataset, bin_size: float
     figures = []
 
     # Residuals plot
+    residuals = y_true.flatten() - y_pred.flatten()
     fig = ff.create_distplot(
-        hist_data=[y_true.flatten() - y_pred.flatten()],
+        hist_data=[residuals],
         group_labels=["Residuals"],
         bin_size=[bin_size],
         show_hist=True,
@@ -104,4 +105,4 @@ def RegressionResidualsPlot(model: VMModel, dataset: VMDataset, bin_size: float
         )
     )
 
-    return tuple(figures)
+    return (*figures, RawData(residuals=residuals, y_true=y_true, y_pred=y_pred))

validmind/tests/model_validation/RougeScore.py

@@ -6,7 +6,7 @@ import pandas as pd
 import plotly.graph_objects as go
 from rouge import Rouge
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 
 
 @tags("nlp", "text_data", "visualization")
@@ -118,7 +118,8 @@ def RougeScore(dataset, model, metric="rouge-1"):
         {"p": "Precision", "r": "Recall", "f": "F1 Score"}
     )
 
-    # Create a DataFrame from all collected statistics
-    result_df = pd.DataFrame(stats_df).reset_index().rename(columns={"index": "Metric"})
-
-    return (result_df, *tuple(figures))
+    return (
+        pd.DataFrame(stats_df).reset_index().rename(columns={"index": "Metric"}),
+        *figures,
+        RawData(rouge_scores_df=df_scores),
+    )

validmind/tests/model_validation/TimeSeriesPredictionWithCI.py

@@ -7,7 +7,7 @@ import pandas as pd
 import plotly.graph_objects as go
 from scipy.stats import norm
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 
 
 @tags("model_predictions", "visualization")
@@ -144,4 +144,13 @@ def TimeSeriesPredictionWithCI(dataset, model, confidence=0.95):
         template="plotly_white",
     )
 
-    return fig, breaches_df
+    return (
+        fig,
+        breaches_df,
+        RawData(
+            errors=errors,
+            z_score=z_score,
+            lower_confidence=lower_conf,
+            upper_confidence=upper_conf,
+        ),
+    )

validmind/tests/model_validation/TokenDisparity.py

@@ -5,7 +5,7 @@
 import pandas as pd
 import plotly.graph_objects as go
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 
 
 @tags("nlp", "text_data", "visualization")
@@ -108,4 +108,4 @@ def TokenDisparity(dataset, model):
     # Create a DataFrame from all collected statistics
     result_df = pd.DataFrame(stats_df).reset_index().rename(columns={"index": "Metric"})
 
-    return (result_df, *tuple(figures))
+    return (result_df, *figures, RawData(token_counts_df=df))

validmind/tests/model_validation/ToxicityScore.py

@@ -6,7 +6,7 @@ import evaluate
 import pandas as pd
 import plotly.graph_objects as go
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 
 
 @tags("nlp", "text_data", "visualization")
@@ -139,4 +139,12 @@ def ToxicityScore(dataset, model):
         ]
     ]
 
-    return (result_df, *tuple(figures))
+    return (
+        result_df,
+        *tuple(figures),
+        RawData(
+            input_toxicity_df=input_df,
+            true_toxicity_df=true_df,
+            pred_toxicity_df=pred_df,
+        ),
+    )

validmind/tests/model_validation/embeddings/ClusterDistribution.py

@@ -5,7 +5,7 @@
 import plotly.express as px
 from sklearn.cluster import KMeans
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 from validmind.vm_models import VMDataset, VMModel
 
 
@@ -52,8 +52,14 @@ def ClusterDistribution(model: VMModel, dataset: VMDataset, num_clusters: int =
     - 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.
     """
-    return px.histogram(
-        KMeans(n_clusters=num_clusters).fit(dataset.y_pred(model)).labels_,
+    embeddings = dataset.y_pred(model)
+    kmeans = KMeans(n_clusters=num_clusters).fit(embeddings)
+    labels = kmeans.labels_
+
+    fig = px.histogram(
+        labels,
         nbins=num_clusters,
         title="Embeddings Cluster Distribution",
     )
+
+    return fig, RawData(labels=labels)

validmind/tests/model_validation/embeddings/CosineSimilarityComparison.py

@@ -9,7 +9,7 @@ import pandas as pd
 import plotly.express as px
 from sklearn.metrics.pairwise import cosine_similarity
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 
 
 @tags("visualization", "dimensionality_reduction", "embeddings")
@@ -63,6 +63,7 @@ def CosineSimilarityComparison(dataset, models):
     figures = []
     # Initialize a list to store data for the DataFrame
     all_stats = []
+    similarity_matrices = []
 
     # Generate all pairs of models for comparison
     for model_A, model_B in combinations(models, 2):
@@ -73,6 +74,15 @@ def CosineSimilarityComparison(dataset, models):
         similarity_matrix = cosine_similarity(embeddings_A, embeddings_B)
         similarities = similarity_matrix.flatten()
 
+        # store similarity matrix
+        similarity_matrices.append(
+            {
+                "model_A": model_A.input_id,
+                "model_B": model_B.input_id,
+                "similarity_matrix": similarity_matrix,
+            }
+        )
+
         # Generate statistics and add model combination as a column
         stats_data = {
             "Combination": f"{model_A.input_id} vs {model_B.input_id}",
@@ -100,4 +110,8 @@ def CosineSimilarityComparison(dataset, models):
     # Create a DataFrame from all collected statistics
     stats_df = pd.DataFrame(all_stats)
 
-    return (stats_df, *tuple(figures))
+    return (
+        *figures,
+        stats_df,
+        RawData(similarity_matrices=pd.DataFrame(similarity_matrices)),
+    )

validmind/tests/model_validation/embeddings/CosineSimilarityDistribution.py

@@ -5,7 +5,7 @@
 import plotly.express as px
 from sklearn.metrics.pairwise import cosine_similarity
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 from validmind.vm_models import VMDataset, VMModel
 
 
@@ -52,9 +52,11 @@ def CosineSimilarityDistribution(dataset: VMDataset, model: VMModel):
     - The output is sensitive to the choice of bin number for the histogram. Different bin numbers could give a
     slightly altered perspective on the distribution of cosine similarity.
     """
+    similarity_scores = cosine_similarity(dataset.y_pred(model)).flatten()
+
     return px.histogram(
-        x=cosine_similarity(dataset.y_pred(model)).flatten(),
+        x=similarity_scores,
         nbins=100,
         title="Cosine Similarity Distribution",
         labels={"x": "Cosine Similarity"},
-    )
+    ), RawData(similarity_scores=similarity_scores)

validmind/tests/model_validation/embeddings/CosineSimilarityHeatmap.py

@@ -6,7 +6,7 @@ import numpy as np
 import plotly.express as px
 from sklearn.metrics.pairwise import cosine_similarity
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 
 
 @tags("visualization", "dimensionality_reduction", "embeddings")
@@ -81,4 +81,4 @@ def CosineSimilarityHeatmap(
         yaxis_title=yaxis_title,
     )
 
-    return fig
+    return fig, RawData(similarity_matrix=similarity_matrix)

validmind/tests/model_validation/embeddings/DescriptiveAnalytics.py

@@ -5,7 +5,7 @@
 import numpy as np
 import plotly.express as px
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 from validmind.vm_models import VMDataset, VMModel
 
 
@@ -55,17 +55,27 @@ def DescriptiveAnalytics(dataset: VMDataset, model: VMModel):
     - While it displays valuable information about the central tendency and spread of data, it does not provide
     information about correlations between different embedding dimensions.
     """
+    y_pred = dataset.y_pred(model)
+    embedding_means = np.mean(y_pred, axis=0)
+    embedding_medians = np.median(y_pred, axis=0)
+    embedding_stds = np.std(y_pred, axis=0)
+
     return (
         px.histogram(
-            x=np.mean(dataset.y_pred(model), axis=0),
+            x=embedding_means,
             title="Distribution of Embedding Means",
         ),
         px.histogram(
-            x=np.median(dataset.y_pred(model), axis=0),
+            x=embedding_medians,
             title="Distribution of Embedding Medians",
         ),
         px.histogram(
-            x=np.std(dataset.y_pred(model), axis=0),
+            x=embedding_stds,
             title="Distribution of Embedding Standard Deviations",
         ),
+        RawData(
+            embedding_means=embedding_means,
+            embedding_medians=embedding_medians,
+            embedding_stds=embedding_stds,
+        ),
     )

validmind/tests/model_validation/embeddings/EmbeddingsVisualization2D.py

@@ -7,7 +7,7 @@ from typing import Union
 import plotly.express as px
 from sklearn.manifold import TSNE
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 from validmind.logging import get_logger
 from validmind.vm_models import VMDataset, VMModel
 
@@ -89,4 +89,4 @@ def EmbeddingsVisualization2D(
     fig = px.scatter(**scatter_kwargs)
     fig.update_layout(width=500, height=500)
 
-    return fig
+    return fig, RawData(tsne_embeddings=reduced_embeddings)

validmind/tests/model_validation/embeddings/EuclideanDistanceComparison.py

@@ -9,7 +9,7 @@ import pandas as pd
 import plotly.express as px
 from sklearn.metrics.pairwise import euclidean_distances
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 
 
 @tags("visualization", "dimensionality_reduction", "embeddings")
@@ -57,6 +57,8 @@ def EuclideanDistanceComparison(dataset, models):
     figures = []
     all_stats = []
 
+    distance_matrices = {}
+
     # Generate all pairs of models for comparison
     for model_A, model_B in combinations(models, 2):
         embeddings_A = np.stack(dataset.y_pred(model_A))
@@ -66,6 +68,15 @@ def EuclideanDistanceComparison(dataset, models):
         distance_matrix = euclidean_distances(embeddings_A, embeddings_B)
         distances = distance_matrix.flatten()
 
+        # Store raw distance matrix for each pair-wise comparison
+        distance_matrices.append(
+            {
+                "model_A": model_A.input_id,
+                "model_B": model_B.input_id,
+                "distance_matrix": distance_matrix,
+            }
+        )
+
         # Generate statistics and add model combination as a column
         stats_data = {
             "Combination": f"{model_A.input_id} vs {model_B.input_id}",
@@ -93,4 +104,7 @@ def EuclideanDistanceComparison(dataset, models):
     # Create a DataFrame from all collected statistics
     stats_df = pd.DataFrame(all_stats)
 
-    return (stats_df, *tuple(figures))
+    # Add raw data to return
+    raw_data = RawData(distance_matrices=pd.DataFrame(distance_matrices))
+
+    return (stats_df, *figures, raw_data)

validmind/tests/model_validation/embeddings/EuclideanDistanceHeatmap.py

@@ -6,7 +6,7 @@ import numpy as np
 import plotly.express as px
 from sklearn.metrics.pairwise import euclidean_distances
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 
 
 @tags("visualization", "dimensionality_reduction", "embeddings")
@@ -79,4 +79,4 @@ def EuclideanDistanceHeatmap(
         yaxis_title=yaxis_title,
     )
 
-    return fig
+    return fig, RawData(distance_matrix=distance_matrix)

validmind/tests/model_validation/embeddings/PCAComponentsPairwisePlots.py

@@ -10,7 +10,7 @@ import plotly.express as px
 from sklearn.decomposition import PCA
 from sklearn.preprocessing import StandardScaler
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 
 
 @tags("visualization", "dimensionality_reduction", "embeddings")
@@ -74,7 +74,7 @@ def PCAComponentsPairwisePlots(dataset, model, n_components=3):
     )
 
     # List to store each plot
-    plots = []
+    figures = []
 
     # Create plots for each pair of principal components
     for pc1, pc2 in itertools.combinations(range(1, n_components + 1), 2):
@@ -88,7 +88,6 @@ def PCAComponentsPairwisePlots(dataset, model, n_components=3):
                 f"PC{pc2}": f"Principal Component {pc2}",
             },
         )
-        plots.append(fig)
+        figures.append(fig)
 
-    # Return the list of plots as a tuple
-    return tuple(plots)
+    return (*figures, RawData(pca_results=pca_df))

validmind/tests/model_validation/embeddings/StabilityAnalysisKeyword.py

@@ -5,7 +5,7 @@
 import re
 from typing import Dict
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 from validmind.vm_models import VMDataset, VMModel
 
 from .utils import create_stability_analysis_result
@@ -91,8 +91,10 @@ def StabilityAnalysisKeyword(
         perturb_data
     )
 
-    return create_stability_analysis_result(
+    raw_data, results = create_stability_analysis_result(
         dataset.y_pred(model),
         model.predict(perturbed_df),
         mean_similarity_threshold,
     )
+
+    return results, RawData(original_perturbed_similarity=raw_data)

validmind/tests/model_validation/embeddings/StabilityAnalysisRandomNoise.py

@@ -5,7 +5,7 @@
 import random
 import string
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 from validmind.vm_models import VMDataset, VMModel
 
 from .utils import create_stability_analysis_result
@@ -145,8 +145,10 @@ def StabilityAnalysisRandomNoise(
         perturb_data
     )
 
-    return create_stability_analysis_result(
+    raw_data, result = create_stability_analysis_result(
         dataset.y_pred(model),
         model.predict(perturbed_df),
         mean_similarity_threshold,
     )
+
+    return result, RawData(original_perturbed_similarity=raw_data)

validmind/tests/model_validation/embeddings/StabilityAnalysisSynonyms.py

@@ -7,7 +7,7 @@ import random
 import nltk
 from nltk.corpus import wordnet as wn
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 from validmind.vm_models import VMDataset, VMModel
 
 from .utils import create_stability_analysis_result
@@ -101,8 +101,10 @@ def StabilityAnalysisSynonyms(
         perturb_data
     )
 
-    return create_stability_analysis_result(
+    raw_data, result = create_stability_analysis_result(
         dataset.y_pred(model),
         model.predict(perturbed_df),
         mean_similarity_threshold,
     )
+
+    return result, RawData(original_perturbed_similarity=raw_data)

validmind/tests/model_validation/embeddings/StabilityAnalysisTranslation.py

@@ -4,7 +4,7 @@
 
 from transformers import MarianMTModel, MarianTokenizer
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 from validmind.logging import get_logger
 from validmind.vm_models import VMDataset, VMModel
 
@@ -128,8 +128,10 @@ def StabilityAnalysisTranslation(
         perturb_data
     )
 
-    return create_stability_analysis_result(
+    raw_data, result = create_stability_analysis_result(
         dataset.y_pred(model),
         model.predict(perturbed_df),
         mean_similarity_threshold,
     )
+
+    return result, RawData(original_perturbed_similarity=raw_data)

validmind/tests/model_validation/embeddings/TSNEComponentsPairwisePlots.py

@@ -10,7 +10,7 @@ import plotly.express as px
 from sklearn.manifold import TSNE
 from sklearn.preprocessing import StandardScaler
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 
 
 @tags("visualization", "dimensionality_reduction", "embeddings")
@@ -80,7 +80,7 @@ def TSNEComponentsPairwisePlots(
     )
 
     # List to store each plot
-    plots = []
+    figures = []
 
     # Create plots for each pair of t-SNE components (if n_components > 1)
     if n_components > 1:
@@ -95,7 +95,7 @@ def TSNEComponentsPairwisePlots(
                     f"Component {comp2}": f"Component {comp2}",
                 },
             )
-            plots.append(fig)
+            figures.append(fig)
     else:
         fig = px.scatter(
             tsne_df,
@@ -106,7 +106,9 @@ def TSNEComponentsPairwisePlots(
                 "Component 1": "Component 1",
             },
         )
-        plots.append(fig)
+        figures.append(fig)
 
-    # Return the list of plots as a tuple
-    return tuple(plots)
+    return (
+        *figures,
+        RawData(embeddings_scaled=embeddings_scaled, tsne_results=tsne_results),
+    )

validmind/tests/model_validation/embeddings/utils.py

@@ -3,6 +3,7 @@
 # SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial
 
 import numpy as np
+import pandas as pd
 import plotly.express as px
 from sklearn.metrics.pairwise import cosine_similarity
 
@@ -17,10 +18,19 @@ def create_stability_analysis_result(
         original_embeddings, perturbed_embeddings
     ).diagonal()
 
+    # create a raw dataframe of the original, perturbed and similarity
+    raw_data = pd.DataFrame(
+        {
+            "original": original_embeddings,
+            "perturbed": perturbed_embeddings,
+            "similarity": similarities,
+        }
+    )
+
     mean = np.mean(similarities)
     passed = mean > mean_similarity_threshold
 
-    return (
+    return raw_data, (
         [
             {
                 "Mean Similarity": mean,

validmind/tests/model_validation/ragas/AnswerCorrectness.py

@@ -7,7 +7,7 @@ import warnings
 import plotly.express as px
 from datasets import Dataset
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 from validmind.errors import MissingDependencyError
 
 from .utils import get_ragas_config, get_renamed_columns
@@ -144,4 +144,5 @@ def AnswerCorrectness(
         },
         fig_histogram,
         fig_box,
+        RawData(evaluation_results=result_df),
     )

validmind/tests/model_validation/ragas/AspectCritic.py

@@ -7,7 +7,7 @@ import warnings
 import plotly.express as px
 from datasets import Dataset
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 from validmind.errors import MissingDependencyError
 
 from .utils import get_ragas_config, get_renamed_columns
@@ -187,9 +187,13 @@ def AspectCritic(
         title="Aspect Critique Results",
     )
 
-    return {
-        "Aspect Scores": [
-            {"Aspect": aspect, "Score": result_df[aspect].mean()}
-            for aspect in aspects + [aspect.name for aspect in custom_aspects]
-        ]
-    }, fig
+    return (
+        {
+            "Aspect Scores": [
+                {"Aspect": aspect, "Score": result_df[aspect].mean()}
+                for aspect in aspects + [aspect.name for aspect in custom_aspects]
+            ]
+        },
+        fig,
+        RawData(evaluation_results=result_df),
+    )

validmind/tests/model_validation/ragas/ContextEntityRecall.py

@@ -7,7 +7,7 @@ import warnings
 import plotly.express as px
 from datasets import Dataset
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 from validmind.errors import MissingDependencyError
 
 from .utils import get_ragas_config, get_renamed_columns
@@ -143,4 +143,5 @@ def ContextEntityRecall(
         },
         fig_histogram,
         fig_box,
+        RawData(evaluation_results=result_df),
     )

validmind/tests/model_validation/ragas/ContextPrecision.py

@@ -7,7 +7,7 @@ import warnings
 import plotly.express as px
 from datasets import Dataset
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 from validmind.errors import MissingDependencyError
 
 from .utils import get_ragas_config, get_renamed_columns
@@ -135,4 +135,5 @@ def ContextPrecision(
         },
         fig_histogram,
         fig_box,
+        RawData(evaluation_results=result_df),
     )

validmind/tests/model_validation/ragas/ContextPrecisionWithoutReference.py

@@ -7,7 +7,7 @@ import warnings
 import plotly.express as px
 from datasets import Dataset
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 from validmind.errors import MissingDependencyError
 
 from .utils import get_ragas_config, get_renamed_columns
@@ -130,4 +130,5 @@ def ContextPrecisionWithoutReference(
         },
         fig_histogram,
         fig_box,
+        RawData(evaluation_results=result_df),
     )

validmind/tests/model_validation/ragas/ContextRecall.py

@@ -7,7 +7,7 @@ import warnings
 import plotly.express as px
 from datasets import Dataset
 
-from validmind import tags, tasks
+from validmind import RawData, tags, tasks
 from validmind.errors import MissingDependencyError
 
 from .utils import get_ragas_config, get_renamed_columns
@@ -135,4 +135,5 @@ def ContextRecall(
         },
         fig_histogram,
         fig_box,
+        RawData(evaluation_results=result_df),
     )