validmind 2.2.6__py3-none-any.whl → 2.3.3__py3-none-any.whl

validmind/utils.py

@@ -4,9 +4,9 @@
 
 import asyncio
 import difflib
+import inspect
 import json
 import math
-import os
 import re
 import sys
 from platform import python_version
@@ -26,11 +26,8 @@ from matplotlib.axes._axes import _log as matplotlib_axes_logger
 from numpy import ndarray
 from tabulate import tabulate
 
-from .ai import background_generate_description, is_configured
 from .html_templates.content_blocks import math_jax_snippet, python_syntax_highlighting
-
-AI_REVISION_NAME = "Generated by ValidMind AI"
-DEFAULT_REVISION_NAME = "Default Description"
+from .logging import get_logger
 
 DEFAULT_BIG_NUMBER_DECIMALS = 2
 DEFAULT_SMALL_NUMBER_DECIMALS = 4
@@ -53,6 +50,8 @@ params = {
 pylab.rcParams.update(params)
 #################################
 
+logger = get_logger(__name__)
+
 
 def is_notebook() -> bool:
     """
@@ -310,7 +309,7 @@ def run_async_check(func, *args, **kwargs):
             if task.get_name() == name:
                 return task
 
-        return run_async(func, name=name, *args, **kwargs)
+        return run_async(func, name=name, *args, **kwargs)  # noqa B026
 
     except RuntimeError:
         pass
@@ -462,58 +461,34 @@ def md_to_html(md: str, mathml=False) -> str:
     return html
 
 
-def get_description_metadata(
-    test_id,
-    default_description,
-    summary=None,
-    figures=None,
-    prefix="metric_description",
-):
-    """Get Metadata Dictionary for a Test or Metric Result
-
-    Generates an LLM interpretation of the test results or uses the default
-    description and returns a metadata object that can be logged with the test results.
-
-    By default, the description is generated by an LLM that will interpret the test
-    results and provide a human-readable description. If the summary or figures are
-    not provided, or the `VALIDMIND_LLM_DESCRIPTIONS_ENABLED` environment variable is
-    set to `0` or `false` or no LLM has been configured, the default description will
-    be used as the test result description.
-
-    Note: Either the summary or figures must be provided to generate the description.
+def inspect_obj(obj):
+    # Filtering only attributes
+    print(len("Attributes:") * "-")
+    print("Attributes:")
+    print(len("Attributes:") * "-")
 
-    Args:
-        test_id (str): The test ID
-        default_description (str): The default description for the test
-        summary (Any): The test summary or results to interpret
-        figures (List[Figure]): The figures to attach to the test suite result
-        prefix (str): The prefix to use for the content ID (Default: "metric_description")
-
-    Returns:
-        dict: The metadata object to be logged with the test results
-    """
-    env_disabled = os.getenv("VALIDMIND_LLM_DESCRIPTIONS_ENABLED", "1") in [
-        "0",
-        "false",
+    # Get only attributes (not methods)
+    attributes = [
+        attr
+        for attr in dir(obj)
+        if not callable(getattr(obj, attr)) and not attr.startswith("__")
     ]
-
-    if (summary or figures) and not env_disabled and is_configured():
-        revision_name = AI_REVISION_NAME
-
-        # get description future and set it as the description in the metadata
-        # this will lazily retrieved so it can run in the background in parallel
-        description = background_generate_description(
-            test_id=test_id,
-            test_description=default_description,
-            test_summary=summary,
-            figures=figures,
-        )
-
-    else:
-        revision_name = DEFAULT_REVISION_NAME
-        description = md_to_html(default_description, mathml=True)
-
-    return {
-        "content_id": f"{prefix}:{test_id}::{revision_name}",
-        "text": description,
-    }
+    for attr in attributes:
+        print(f"{attr}")
+
+    # Filtering only methods using inspect and displaying their parameters
+    print("\nMethods with Parameters:")
+
+    # Get only methods (functions) using inspect.ismethod
+    methods = inspect.getmembers(obj, predicate=inspect.ismethod)
+    print("Methods:")
+    for name, method in methods:
+        # Get the signature of the method
+        sig = inspect.signature(method)
+        print(len(f"{name}") * "-")
+        print(f"{name}")
+        print(len(f"{name}") * "-")
+        print("Parameters:")
+        # Loop through the parameters and print detailed information
+        for param_name, param in sig.parameters.items():
+            print(f"{param_name} - ({param.default})")

validmind/vm_models/dataset/dataset.py

@@ -195,7 +195,19 @@ class VMDataset:
         probability_column: str = None,
         probability_values: list = None,
         prediction_probabilities: list = None,  # DEPRECATED: use probability_values
+        **kwargs,
     ):
+        """Assign predictions and probabilities to the dataset.
+
+        Args:
+            model (VMModel): The model used to generate the predictions.
+            prediction_column (str, optional): The name of the column containing the predictions. Defaults to None.
+            prediction_values (list, optional): The values of the predictions. Defaults to None.
+            probability_column (str, optional): The name of the column containing the probabilities. Defaults to None.
+            probability_values (list, optional): The values of the probabilities. Defaults to None.
+            prediction_probabilities (list, optional): DEPRECATED: The values of the probabilities. Defaults to None.
+            kwargs: Additional keyword arguments that will get passed through to the model's `predict` method.
+        """
         if prediction_probabilities is not None:
             warnings.warn(
                 "The `prediction_probabilities` argument is deprecated. Use `probability_values` instead.",
@@ -226,7 +238,9 @@ class VMDataset:
 
         if prediction_values is None:
             X = self.df if isinstance(model, (FunctionModel, PipelineModel)) else self.x
-            probability_values, prediction_values = compute_predictions(model, X)
+            probability_values, prediction_values = compute_predictions(
+                model, X, **kwargs
+            )
 
         prediction_column = prediction_column or f"{model.input_id}_prediction"
         self._add_column(prediction_column, prediction_values)
@@ -356,8 +370,8 @@ class VMDataset:
         return as_df(self.df[self.probability_column(model)])
 
     def target_classes(self):
-        """Returns the unique number of target classes for the target (Y) variable"""
-        return [str(i) for i in np.unique(self.y)]
+        """Returns the target class labels or unique values of the target column."""
+        return self.target_class_labels or [str(i) for i in np.unique(self.y)]
 
     def __str__(self):
         return (

validmind/vm_models/dataset/utils.py

@@ -94,7 +94,7 @@ def _is_probabilties(output):
     return np.all((output >= 0) & (output <= 1)) and np.any((output > 0) & (output < 1))
 
 
-def compute_predictions(model, X) -> tuple:
+def compute_predictions(model, X, **kwargs) -> tuple:
     probability_values = None
 
     try:
@@ -108,7 +108,7 @@ def compute_predictions(model, X) -> tuple:
 
     try:
         logger.info("Running predict()... This may take a while")
-        prediction_values = model.predict(X)
+        prediction_values = model.predict(X, **kwargs)
         logger.info("Done running predict()")
     except MissingOrInvalidModelPredictFnError:
         raise MissingOrInvalidModelPredictFnError(

validmind/vm_models/model.py

@@ -114,7 +114,7 @@ class VMModel(ABC):
 
         self.__post_init__()
 
-    def __post_init__(self):
+    def __post_init__(self):  # noqa: B027
         """Allows child classes to add their own post-init logic"""
         pass
 

validmind/vm_models/test/metric.py

@@ -12,8 +12,8 @@ from typing import ClassVar, List, Optional, Union
 
 import pandas as pd
 
+from ...ai.test_descriptions import get_description_metadata
 from ...errors import MissingCacheResultsArgumentsError
-from ...utils import get_description_metadata
 from ..figure import Figure
 from .metric_result import MetricResult
 from .result_wrapper import MetricResultWrapper
@@ -36,13 +36,6 @@ class Metric(Test):
     # Instance Variables
     result: MetricResultWrapper = None  # populated by cache_results() method
 
-    @property
-    def key(self):
-        """
-        Keep the key for compatibility reasons
-        """
-        return self._key if hasattr(self, "_key") else self.name
-
     @abstractmethod
     def summary(self, metric_value: Optional[Union[dict, list, pd.DataFrame]] = None):
         """

validmind/vm_models/test/result_wrapper.py

@@ -15,10 +15,10 @@ import pandas as pd
 from ipywidgets import HTML, GridBox, Layout, VBox
 
 from ... import api_client
-from ...ai import DescriptionFuture
+from ...ai.test_descriptions import AI_REVISION_NAME, DescriptionFuture
 from ...input_registry import input_registry
 from ...logging import get_logger
-from ...utils import AI_REVISION_NAME, NumpyEncoder, display, run_async, test_id_to_name
+from ...utils import NumpyEncoder, display, run_async, test_id_to_name
 from ..dataset import VMDataset
 from ..figure import Figure
 from .metric_result import MetricResult

validmind/vm_models/test/test.py

@@ -52,6 +52,9 @@ class Test(TestUtils):
                 "test_id is missing. It must be passed when initializing the test"
             )
         self._ref_id = str(uuid4())
+        self.key = (
+            self.test_id
+        )  # for backwards compatibility - figures really should get keyed automatically
 
         # TODO: add validation for required inputs
         if self.default_params is None:

validmind/vm_models/test/threshold_test.py

@@ -11,7 +11,7 @@ avoid confusion with the "tests" in the general data science/modeling sense.
 from dataclasses import dataclass
 from typing import ClassVar, List, Optional
 
-from ...utils import get_description_metadata
+from ...ai.test_descriptions import get_description_metadata
 from ..figure import Figure
 from .result_summary import ResultSummary, ResultTable
 from .result_wrapper import ThresholdTestResultWrapper

validmind/vm_models/test_suite/runner.py

@@ -83,11 +83,14 @@ class TestSuiteRunner:
                     test_configs = test_configs.get("params", {})
                 else:
                     if (test_configs) and ("params" not in test_configs):
-                        """[DEPRECATED] Deprecated method for setting test parameters directly in the 'config' parameter"""
-                        logger.info(
-                            "Setting test parameters directly in the 'config' parameter of the run_documentation_tests() method is deprecated. "
-                            'Instead, use the new format of the config: config = {"test_id": {"params": {...}, "inputs": {...}}}'
+                        # [DEPRECATED] This is the old way of setting test parameters
+                        msg = (
+                            "Setting test parameters directly in the 'config' parameter"
+                            " of the run_documentation_tests() method is deprecated. "
+                            "Instead, use the new format of the config: "
+                            'config = {"test_id": {"params": {...}, "inputs": {...}}}'
                         )
+                        logger.warning(msg)
 
                 test.load(inputs=inputs, context=self.context, config=test_configs)
 

{validmind-2.2.6.dist-info → validmind-2.3.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: validmind
-Version: 2.2.6
+Version: 2.3.3
 Summary: ValidMind Developer Framework
 License: Commercial License
 Author: Andres Rodriguez