validmind 2.8.10__py3-none-any.whl → 2.8.20__py3-none-any.whl

validmind/vm_models/test_suite/test.py

@@ -16,7 +16,7 @@ logger = get_logger(__name__)
 
 class TestSuiteTest:
     """
-    Wraps a 'Test' in a Test Suite and handles logic and state for that test
+    Wraps a 'Test' in a Test Suite and handles logic and state for that test.
     """
 
     test_id: str
@@ -28,10 +28,10 @@ class TestSuiteTest:
     _load_failed: bool = False
 
     def __init__(self, test_id_or_obj):
-        """Load the test class from the test id
+        """Load the test class from the test ID.
 
         Args:
-            test_id_or_obj (str): The test id or a dict with test id and other options
+            test_id_or_obj (str): The test ID or a dict with test ID and other options.
         """
         if isinstance(test_id_or_obj, str):
             self.test_id = test_id_or_obj
@@ -42,7 +42,7 @@ class TestSuiteTest:
         self.name = test_id_to_name(self.test_id)
 
     def get_default_config(self):
-        """Returns the default configuration for the test"""
+        """Returns the default configuration for the test."""
         try:
             test_func = load_test(self.test_id)
         except LoadTestError as e:
@@ -66,7 +66,7 @@ class TestSuiteTest:
         return config
 
     def run(self, fail_fast: bool = False, config: dict = None):
-        """Run the test"""
+        """Run the test."""
         if self._load_failed:
             return
 
@@ -110,7 +110,7 @@ class TestSuiteTest:
             )
 
     async def log_async(self):
-        """Log the result for this test to ValidMind"""
+        """Log the result for this test to ValidMind."""
         if not self.result:
             raise ValueError("Cannot log test result before running the test")
 

validmind/vm_models/test_suite/test_suite.py

@@ -21,7 +21,7 @@ TOP_LEVEL_SECTION_ID = "__top_level__"
 @dataclass
 class TestSuiteSection:
     """
-    Represents a section in a test suite - Internal use only
+    Represents a section in a test suite - Internal use only.
 
     In a test suite definition, tests can be grouped into sections by using a dict
     instead of a string (Test ID). The dict must have a 'section_id' key and a
@@ -49,7 +49,7 @@ class TestSuiteSection:
     description: Optional[str] = None
 
     def get_default_config(self):
-        """Returns the default configuration for the test suite section"""
+        """Returns the default configuration for the test suite section."""
         # TODO: configuration across sections/tests needs more work
         section_default_config = {}
 
@@ -69,7 +69,7 @@ class TestSuite:
     can be run as a suite against datasets and models. Test Suites can be defined by
     inheriting from this base class and defining the list of tests as a class variable.
 
-    Tests can be a flat list of strings or may be nested into sections by using a dict
+    Tests can be a flat list of strings or may be nested into sections by using a dict.
     """
 
     suite_id: ClassVar[str]
@@ -79,14 +79,14 @@ class TestSuite:
 
     def __post_init__(self):
         """
-        Post init hook (runs after dataclass init)
+        Post init hook (runs after dataclass init).
         """
         self.sections = []
         self._build_sections()
 
     def _build_sections(self):
         """
-        Builds the sections for the test suite
+        Builds the sections for the test suite.
         """
         if not self.tests:
             raise ValueError("No tests found in test suite")
@@ -130,7 +130,7 @@ class TestSuite:
         return self.suite_id.title().replace("_", " ")
 
     def get_tests(self) -> List[str]:
-        """Get all test suite test objects from all sections"""
+        """Get all test suite test objects from all sections."""
         tests = []
 
         for section in self.sections:
@@ -139,21 +139,21 @@ class TestSuite:
         return tests
 
     def num_tests(self) -> int:
-        """Returns the total number of tests in the test suite"""
+        """Returns the total number of tests in the test suite."""
         return len(self.get_tests())
 
     def get_default_config(self) -> dict:
-        """Returns the default configuration for the test suite
+        """Returns the default configuration for the test suite.
 
         Each test in a test suite can accept parameters and those parameters can have
         default values. Both the parameters and their defaults are set in the test
         class and a config object can be passed to the test suite's run method to
         override the defaults. This function returns a dictionary containing the
         parameters and their default values for every test to allow users to view
-        and set values
+        and set values.
 
         Returns:
-            dict: A dictionary of test names and their default parameters
+            dict: A dictionary of test names and their default parameters.
         """
         default_config = {}
 

{validmind-2.8.10.dist-info → validmind-2.8.20.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: validmind
-Version: 2.8.10
+Version: 2.8.20
 Summary: ValidMind Library
 License: Commercial License
 Author: Andres Rodriguez
@@ -35,12 +35,12 @@ Requires-Dist: numba (<0.59.0)
 Requires-Dist: numpy
 Requires-Dist: openai (>=1)
 Requires-Dist: pandas (>=1.1,<=2.0.3)
-Requires-Dist: plotly
+Requires-Dist: plotly (<6.0.0)
 Requires-Dist: plotly-express
 Requires-Dist: polars
 Requires-Dist: pycocoevalcap (>=1.2,<2.0) ; extra == "all" or extra == "llm"
 Requires-Dist: python-dotenv
-Requires-Dist: ragas (>=0.2.3) ; extra == "all" or extra == "llm"
+Requires-Dist: ragas (>=0.2.3,<=0.2.7) ; extra == "all" or extra == "llm"
 Requires-Dist: rouge (>=1)
 Requires-Dist: scikit-learn (<1.6.0)
 Requires-Dist: scipy
@@ -57,7 +57,6 @@ Requires-Dist: torch (>=1.10.0) ; extra == "all" or extra == "llm" or extra == "
 Requires-Dist: tqdm
 Requires-Dist: transformers (>=4.32.0,<5.0.0) ; extra == "all" or extra == "huggingface" or extra == "llm"
 Requires-Dist: xgboost (>=1.5.2,<3)
-Requires-Dist: ydata-profiling
 Requires-Dist: yfinance (>=0.2.48,<0.3.0)
 Description-Content-Type: text/markdown
 
@@ -84,7 +83,7 @@ ValidMind helps developers, data scientists and risk and compliance stakeholders
 >
 > Signing up is FREE — **[Register with ValidMind](https://docs.validmind.ai/guide/configuration/register-with-validmind.html)**
 
-That's right — you can run tests and log documentation even if you don't have a model available, so go ahead and [**Get started with the ValidMind Library**](https://docs.validmind.ai/developer/get-started-validmind-library.html)!
+That's right — you can run tests and log documentation even if you don't have a model available, so go ahead and get started with the [**ValidMind Library**](https://docs.validmind.ai/developer/validmind-library.html)!
 
 ### How do I do more with the ValidMind Library?