validmind 2.5.19__tar.gz → 2.5.24__tar.gz

{validmind-2.5.19 → validmind-2.5.24}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: validmind
-Version: 2.5.19
-Summary: ValidMind Developer Framework
+Version: 2.5.24
+Summary: ValidMind Library
 License: Commercial License
 Author: Andres Rodriguez
 Author-email: andres@validmind.ai
@@ -61,28 +61,28 @@ Requires-Dist: xgboost (>=1.5.2,<3)
 Requires-Dist: ydata-profiling
 Description-Content-Type: text/markdown
 
-# ValidMind Developer Framework
+# ValidMind Library
 
-ValidMind’s Python Developer Framework is a library of developer tools and methods designed to automate
+ValidMind’s Python Library contains a suite of developer tools and methods designed to automate
 the documentation and validation of your models.
 
-The Developer Framework is designed to be model agnostic. If your model is built in Python, ValidMind's
+The Library is designed to be model agnostic. If your model is built in Python, ValidMind's
 Python library will provide all the standard functionality without requiring your developers to rewrite any functions.
 
-The Developer Framework provides a rich suite of documentation tools and test suites, from documenting
+The Library provides a rich suite of documentation tools and test suites, from documenting
 descriptions of your dataset to testing your models for weak spots and overfit areas. The Developer
 Framework helps you automate the generation of model documentation by feeding the ValidMind platform with
 documentation artifacts and test results to the ValidMind platform.
 
 ## Installation
 
-To install the ValidMind Developer Framework and all optional dependencies, run:
+To install the ValidMind Library and all optional dependencies, run:
 
 ```bash
 pip install validmind[all]
 ```
 
-To install the Developer Framework without optional dependencies (core functionality only), run:
+To install the Library without optional dependencies (core functionality only), run:
 
 ```bash
 pip install validmind
@@ -90,7 +90,7 @@ pip install validmind
 
 ### Extra dependencies
 
-The Developer Framework has optional dependencies that can be installed separately to support additional model types and tests.
+The Library has optional dependencies that can be installed separately to support additional model types and tests.
 
 - **LLM Support**: To be able to run tests for Large Language Models (LLMs), install the `llm` extra:
 
@@ -98,19 +98,19 @@ The Developer Framework has optional dependencies that can be installed separate
     pip install validmind[llm]
     ```
 
-- **PyTorch Models**: To use pytorch models with the Developer Framework, install the `torch` extra:
+- **PyTorch Models**: To use pytorch models with the Library, install the `torch` extra:
 
     ```bash
     pip install validmind[torch]
     ```
 
-- **Hugging Face Transformers**: To use Hugging Face Transformers models with the Developer Framework, install the `transformers` extra:
+- **Hugging Face Transformers**: To use Hugging Face Transformers models with the Library, install the `transformers` extra:
 
     ```bash
     pip install validmind[transformers]
     ```
 
-- **R Models**: To use R models with the Developer Framework, install the `r` extra:
+- **R Models**: To use R models with the Library, install the `r` extra:
 
     ```bash
     pip install validmind[r-support]

{validmind-2.5.19 → validmind-2.5.24}/README.pypi.md

@@ -1,25 +1,25 @@
-# ValidMind Developer Framework
+# ValidMind Library
 
-ValidMind’s Python Developer Framework is a library of developer tools and methods designed to automate
+ValidMind’s Python Library contains a suite of developer tools and methods designed to automate
 the documentation and validation of your models.
 
-The Developer Framework is designed to be model agnostic. If your model is built in Python, ValidMind's
+The Library is designed to be model agnostic. If your model is built in Python, ValidMind's
 Python library will provide all the standard functionality without requiring your developers to rewrite any functions.
 
-The Developer Framework provides a rich suite of documentation tools and test suites, from documenting
+The Library provides a rich suite of documentation tools and test suites, from documenting
 descriptions of your dataset to testing your models for weak spots and overfit areas. The Developer
 Framework helps you automate the generation of model documentation by feeding the ValidMind platform with
 documentation artifacts and test results to the ValidMind platform.
 
 ## Installation
 
-To install the ValidMind Developer Framework and all optional dependencies, run:
+To install the ValidMind Library and all optional dependencies, run:
 
 ```bash
 pip install validmind[all]
 ```
 
-To install the Developer Framework without optional dependencies (core functionality only), run:
+To install the Library without optional dependencies (core functionality only), run:
 
 ```bash
 pip install validmind
@@ -27,7 +27,7 @@ pip install validmind
 
 ### Extra dependencies
 
-The Developer Framework has optional dependencies that can be installed separately to support additional model types and tests.
+The Library has optional dependencies that can be installed separately to support additional model types and tests.
 
 - **LLM Support**: To be able to run tests for Large Language Models (LLMs), install the `llm` extra:
 
@@ -35,19 +35,19 @@ The Developer Framework has optional dependencies that can be installed separate
     pip install validmind[llm]
     ```
 
-- **PyTorch Models**: To use pytorch models with the Developer Framework, install the `torch` extra:
+- **PyTorch Models**: To use pytorch models with the Library, install the `torch` extra:
 
     ```bash
     pip install validmind[torch]
     ```
 
-- **Hugging Face Transformers**: To use Hugging Face Transformers models with the Developer Framework, install the `transformers` extra:
+- **Hugging Face Transformers**: To use Hugging Face Transformers models with the Library, install the `transformers` extra:
 
     ```bash
     pip install validmind[transformers]
     ```
 
-- **R Models**: To use R models with the Developer Framework, install the `r` extra:
+- **R Models**: To use R models with the Library, install the `r` extra:
 
     ```bash
     pip install validmind[r-support]

{validmind-2.5.19 → validmind-2.5.24}/pyproject.toml

@@ -6,19 +6,19 @@ authors = [
   "Luis Pallares <luis@validmind.ai>",
   "John Halz <john@validmind.ai>",
 ]
-description = "ValidMind Developer Framework"
+description = "ValidMind Library"
 license = "Commercial License"
 name = "validmind"
 readme = "README.pypi.md"
-version = "2.5.19"
+version = "2.5.24"
 
 [tool.poetry.dependencies]
 aiohttp = {extras = ["speedups"], version = "*"}
 arch = "*"
 bert-score = ">=0.3.13"
 catboost = "*"
-evaluate = "*"
 datasets = "^2.10.0"
+evaluate = "*"
 ipywidgets = "*"
 kaleido = ">=0.2.1,!=0.2.1.post1"
 langchain-openai = {version = ">=0.1.8", optional = true}

{validmind-2.5.19 → validmind-2.5.24}/validmind/__init__.py

@@ -3,14 +3,14 @@
 # SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial
 
 """
-ValidMind’s Python Developer Framework is a library of developer tools and methods designed to automate
+ValidMind’s Python Library is a library of developer tools and methods designed to automate
 the documentation and validation of your models.
 
-The Developer Framework is designed to be model agnostic. If your model is built in Python, ValidMind's
+The Library is designed to be model agnostic. If your model is built in Python, ValidMind's
 Python library will provide all the standard functionality without requiring your developers to rewrite any functions.
 
-The Developer Framework provides a rich suite of documentation tools and test suites, from documenting
-descriptions of your dataset to testing your models for weak spots and overfit areas. The Developer Framework
+The Library provides a rich suite of documentation tools and test suites, from documenting
+descriptions of your dataset to testing your models for weak spots and overfit areas. The Library
 helps you automate the generation of model documentation by feeding the ValidMind platform with documentation
 artifacts and test results to the ValidMind platform.
 
@@ -35,7 +35,7 @@ vm.init(
 ```
 
 After you have pasted the code snippet into your development source code and executed the code, the Python client
-library will register with ValidMind. You can now use the Developer Framework to document and test your models,
+library will register with ValidMind. You can now use the Library to document and test your models,
 and to upload to the ValidMind Platform.
 """
 import warnings
@@ -47,10 +47,7 @@ warnings.simplefilter("ignore", category=NumbaDeprecationWarning)
 warnings.simplefilter("ignore", category=NumbaPendingDeprecationWarning)
 
 from .__version__ import __version__  # noqa: E402
-from .api_client import init
-from .api_client import log_figure as _log_figure_async
-from .api_client import log_metrics as _log_metrics_async
-from .api_client import log_test_results, reload
+from .api_client import init, log_metric, reload
 from .client import (  # noqa: E402
     get_test_suite,
     init_dataset,
@@ -61,39 +58,6 @@ from .client import (  # noqa: E402
     run_test_suite,
 )
 from .tests.decorator import metric, tags, tasks, test
-from .utils import run_async  # noqa: E402
-
-
-def log_metrics(metrics, inputs=None):
-    """Logs metrics to ValidMind API.
-
-    Args:
-        metrics (list): A list of Metric objects
-        inputs (list): A list of input names to associate with the metrics
-
-    Raises:
-        Exception: If the API call fails
-
-    Returns:
-        dict: The response from the API
-    """
-    run_async(_log_metrics_async, metrics, inputs)
-
-
-def log_figure(figure):
-    """Logs a figure
-
-    Args:
-        figure (Figure): The Figure object wrapper
-
-    Raises:
-        Exception: If the API call fails
-
-    Returns:
-        dict: The response from the API
-    """
-    run_async(_log_figure_async, figure)
-
 
 __all__ = [  # noqa
     "__version__",
@@ -117,8 +81,5 @@ __all__ = [  # noqa
     "test_suites",
     "vm_models",
     "unit_metrics",
-    # Framework Logging API
-    "log_figure",
-    "log_metrics",
-    "log_test_results",
+    "log_metric",
 ]

validmind-2.5.24/validmind/__version__.py

@@ -0,0 +1 @@
+__version__ = "2.5.24"

{validmind-2.5.19 → validmind-2.5.24}/validmind/ai/test_result_description/context.py

@@ -37,11 +37,11 @@ class Context:
         pass
 
     def load(self, input_data):
-        # this task can accept a dict or a test result object from the dev framework
+        # this task can accept a dict or a test result object from the library
         if isinstance(input_data, dict):
             return input_data
 
-        # we are likely running outside of the dev framework and need to convert
+        # we are likely running outside of the library and need to convert
         # the test result object to a dictionary
         test_result = input_data