Metadata-Version: 2.4
Name: tno.quantum.ml.datasets
Version: 2.1.1
Summary: Machine learning datasets package
Author-email: TNO Quantum Code Lab <tnoquantum@tno.nl>
Maintainer-email: TNO Quantum Code Lab <tnoquantum@tno.nl>
License: Apache License, Version 2.0
Project-URL: Homepage, https://github.com/TNO-Quantum/
Project-URL: Documentation, https://tno-quantum.github.io/documentation/
Project-URL: Source, https://github.com/TNO-Quantum/ml.datasets
Keywords: TNO,Quantum,Datasets,Machine Learning
Platform: any
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib
Requires-Dist: scikit-learn>=1.0.2
Requires-Dist: numpy>=1.21.6
Requires-Dist: tno.quantum.utils~=5.1
Provides-Extra: tests
Requires-Dist: pytest>=8.1.1; extra == "tests"
Requires-Dist: pytest-cov>=4.1.0; extra == "tests"
Requires-Dist: tomlkit; extra == "tests"
Dynamic: license-file

# 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/documentation/).


## 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()
```
