Metadata-Version: 2.1
Name: kolena
Version: 0.75.0
Summary: Client for Kolena's machine learning (ML) testing and debugging platform.
Home-page: https://kolena.io
License: Apache-2.0
Keywords: Kolena,ML,testing
Author: Kolena Engineering
Author-email: eng@kolena.io
Requires-Python: >=3.7.1,<3.12
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Classifier: Typing :: Typed
Provides-Extra: metrics
Requires-Dist: Pillow (>=9.1.1,<10.0.0)
Requires-Dist: Shapely (>=1.8.5,<2.0.0)
Requires-Dist: click (>=8.1.3,<9.0.0)
Requires-Dist: dacite (>=1.6)
Requires-Dist: deprecation (>=2.1.0,<3.0.0)
Requires-Dist: importlib-metadata (<5.0) ; python_version < "3.8"
Requires-Dist: numpy (>=1.19) ; python_version >= "3.7" and python_version < "3.11"
Requires-Dist: numpy (>=1.23) ; python_version >= "3.11"
Requires-Dist: pandas (>=1.1,<1.6) ; python_version >= "3.7" and python_version < "3.11"
Requires-Dist: pandas (>=1.5,<1.6) ; python_version >= "3.11"
Requires-Dist: pandera (>=0.9.0)
Requires-Dist: pyarrow (>=8)
Requires-Dist: pydantic (>=1.8)
Requires-Dist: requests (>=2.20,<2.30)
Requires-Dist: requests-toolbelt
Requires-Dist: retrying (>=1.3.3,<2.0.0)
Requires-Dist: scikit-learn (>=1.0,<1.0.3) ; (python_full_version >= "3.7.1" and python_version < "3.8") and (extra == "metrics")
Requires-Dist: scikit-learn (>=1.2) ; (python_version >= "3.8") and (extra == "metrics")
Requires-Dist: termcolor (>=1.1.0,<2.0.0)
Requires-Dist: tqdm (>=4,<5)
Requires-Dist: typing-extensions (>=4.5.0,<5.0.0) ; python_version < "3.8"
Project-URL: Documentation, https://docs.kolena.io
Description-Content-Type: text/markdown

<p align="center">
  <img src="https://docs.kolena.io/assets/images/wordmark-violet.svg" width="400" alt="Kolena" />
</p>

<p align='center'>
  <a href="https://pypi.python.org/pypi/kolena"><img src="https://img.shields.io/pypi/v/kolena" /></a>
  <a href="https://www.apache.org/licenses/LICENSE-2.0"><img src="https://img.shields.io/pypi/l/kolena" /></a>
  <a href="https://github.com/kolenaIO/kolena/actions"><img src="https://img.shields.io/github/checks-status/kolenaIO/kolena/trunk" /></a>
  <a href="https://codecov.io/gh/kolenaIO/kolena" ><img src="https://codecov.io/gh/kolenaIO/kolena/branch/trunk/graph/badge.svg?token=8WOY5I8SF1"/></a>
  <a href="https://docs.kolena.io"><img src="https://img.shields.io/badge/resource-docs-6434c1" /></a>
</p>

---

[Kolena](https://www.kolena.io) is a comprehensive machine learning testing and debugging platform to surface hidden
model behaviors and take the mystery out of model development. Kolena helps you:

- Perform high-resolution model evaluation
- Understand and track behavioral improvements and regressions
- Meaningfully communicate model capabilities
- Automate model testing and deployment workflows

This `kolena` package contains the Python client library for programmatic interaction with the Kolena ML testing
platform.

## Setup

Client builds can be installed directly from PyPI using any Python package manager such as pip:

```zsh
pip install kolena
```

Advanced use cases (eg. metrics computation) may require extra dependencies which can be installed by running:
```zsh
pip install kolena[metrics]
```

<details>
<summary>Installing with <a href="https://python-poetry.org/">Poetry</a></summary>
<br>
Install project dependencies by running

```zsh
poetry update && poetry install
```

Extra dependencies such as [Scikit-learn](https://scikit-learn.org/stable/) can be included by running
```zsh
poetry install --all-extras
```
</details>

For more information, see the [installation documentation](https://docs.kolena.io/testing-with-kolena/using-kolena-client#installation).

## Documentation

Visit [docs.kolena.io](https://docs.kolena.io/) for tutorial and usage documentation and the
[API Reference](https://app.kolena.io/api/developer/docs/html/index.html) for detailed `kolena` typing and
function documentation.

