Metadata-Version: 2.1
Name: validmind
Version: 2.5.24
Summary: ValidMind Library
License: Commercial License
Author: Andres Rodriguez
Author-email: andres@validmind.ai
Requires-Python: >=3.8.1,<3.12
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Provides-Extra: all
Provides-Extra: huggingface
Provides-Extra: llm
Provides-Extra: pytorch
Provides-Extra: r-support
Requires-Dist: aiohttp[speedups]
Requires-Dist: arch
Requires-Dist: bert-score (>=0.3.13)
Requires-Dist: catboost
Requires-Dist: datasets (>=2.10.0,<3.0.0)
Requires-Dist: evaluate
Requires-Dist: ipywidgets
Requires-Dist: kaleido (>=0.2.1,!=0.2.1.post1)
Requires-Dist: langchain-openai (>=0.1.8) ; extra == "all" or extra == "llm"
Requires-Dist: langdetect
Requires-Dist: latex2mathml (>=3.77.0)
Requires-Dist: llvmlite ; python_version >= "3.8" and python_full_version <= "3.11.0"
Requires-Dist: matplotlib
Requires-Dist: mistune (>=3.0.2,<4.0.0)
Requires-Dist: nest-asyncio (>=1.6.0,<2.0.0)
Requires-Dist: nltk (>=3.8.1,<4.0.0)
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-express
Requires-Dist: polars
Requires-Dist: pycocoevalcap (>=1.2,<2.0) ; extra == "all" or extra == "llm"
Requires-Dist: python-dotenv
Requires-Dist: ragas (>=0.1.19) ; extra == "all" or extra == "llm"
Requires-Dist: rouge (>=1)
Requires-Dist: rpy2 (>=3.5.10,<4.0.0) ; extra == "all" or extra == "r-support"
Requires-Dist: scikit-learn
Requires-Dist: scipy
Requires-Dist: scorecardpy (>=0.1.9.6,<0.2.0.0)
Requires-Dist: seaborn
Requires-Dist: sentencepiece (>=0.2.0,<0.3.0) ; extra == "all" or extra == "huggingface" or extra == "llm"
Requires-Dist: sentry-sdk (>=1.24.0,<2.0.0)
Requires-Dist: shap (==0.44.1)
Requires-Dist: statsmodels
Requires-Dist: tabulate (>=0.8.9,<0.9.0)
Requires-Dist: textblob (>=0.18.0.post0,<0.19.0)
Requires-Dist: torch (>=1.10.0) ; extra == "all" or extra == "llm" or extra == "pytorch"
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
Description-Content-Type: text/markdown

# ValidMind Library

ValidMind’s Python Library contains a suite of developer tools and methods designed to automate
the documentation and validation of your models.

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 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 Library and all optional dependencies, run:

```bash
pip install validmind[all]
```

To install the Library without optional dependencies (core functionality only), run:

```bash
pip install validmind
```

### Extra dependencies

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:

    ```bash
    pip install validmind[llm]
    ```

- **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 Library, install the `transformers` extra:

    ```bash
    pip install validmind[transformers]
    ```

- **R Models**: To use R models with the Library, install the `r` extra:

    ```bash
    pip install validmind[r-support]
    ```

