Metadata-Version: 2.1
Name: tno.quantum.ml.datasets
Version: 1.2.1
Summary: Machine Learning Datasets module
Home-page: https://tno.nl
Download-URL: https://pypi.org/project/tno.quantum.ml.datasets/#files
Author: TNO Quantum
Author-email: tnoquantum@tno.nl
Maintainer: TNO Quantum
Maintainer-email: tnoquantum@tno.nl
License: Apache License, Version 2.0
Project-URL: Documentation, https://tno-quantum.github.io/ml.datasets/
Project-URL: Source Code, https://github.com/TNO-Quantum/ml.datasets
Keywords: TNO,Quantum
Platform: any
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Typing :: Typed
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: scikit-learn (>=1.0.2)
Requires-Dist: numpy (>=1.21.6)
Provides-Extra: dev
Requires-Dist: black (~=22.10.0) ; extra == 'dev'
Requires-Dist: isort (~=5.10.1) ; extra == 'dev'
Requires-Dist: mypy (~=0.982) ; extra == 'dev'
Requires-Dist: pylint (~=2.15.5) ; extra == 'dev'
Requires-Dist: sphinx (~=5.3.0) ; extra == 'dev'
Requires-Dist: sphinx-autodoc-typehints (~=1.19.5) ; extra == 'dev'
Requires-Dist: sphinx-math-dollar (~=1.2.1) ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme (~=1.0) ; extra == 'dev'
Provides-Extra: tests
Requires-Dist: pytest (~=7.2.0) ; extra == 'tests'
Requires-Dist: pytest-cov (~=4.0.0) ; extra == 'tests'

# TNO Quantum: Datasets

TNO Quantum provides generic software components aimed at facilitating the development of quantum applications.

The ``tno.quantum.ml.datasets`` package wraps some of the functionality of the [sklearn.datasets](https://scikit-learn.org/stable/datasets.html).
This package is used for testing the ``tno.quantum.ml`` classifiers and clustering algorithms in an easy, reproducible and consistent way.

*Limitations in (end-)use: the content of this software package may solely be used for applications that comply with international export control laws.*

## Documentation

Documentation of the `tno.quantum.ml.datasets` package can be found [here](https://tno-quantum.github.io/ml.datasets/).


## Install

Easily install the `tno.quantum.ml.datasets` package using pip:

```console
$ python -m pip install tno.quantum.ml.datasets
```

If you wish to run the tests you can use:
```console
$ python -m pip install 'tno.quantum.ml.datasets[tests]'
```

## Usage

Here's an example of how the ``datasets`` package can be used to load an iris dataset.

```python
from tno.quantum.ml.datasets import get_iris_dataset
X_train, y_train, X_val, y_val = get_iris_dataset()
```
