Metadata-Version: 2.1
Name: drcomp
Version: 0.0.1a0
Summary: Dimensionality Reduction Comparison
Home-page: https://github.com/MoritzM00/drcomp
License: MIT
Author: Moritz Mistol
Author-email: moritz.mistol@gmail.com
Requires-Python: >=3.8,<3.12
Classifier: Development Status :: 1 - Planning
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: numpy (>=1.23.2)
Requires-Dist: scikit-learn (>=1.1.2)
Project-URL: Changelog, https://github.com/MoritzM00/drcomp/releases
Project-URL: Documentation, https://drcomp.readthedocs.io
Project-URL: Repository, https://github.com/MoritzM00/drcomp
Description-Content-Type: text/markdown

# Dimensionality Reduction Comparison (drcomp)

[![PyPI](https://img.shields.io/pypi/v/drcomp.svg)][pypi_]
[![Status](https://img.shields.io/pypi/status/drcomp.svg)][status]
[![Python Version](https://img.shields.io/pypi/pyversions/drcomp)][python version]
[![License](https://img.shields.io/pypi/l/drcomp)][license]

[![Read the documentation at https://drcomp.readthedocs.io/](https://img.shields.io/readthedocs/drcomp/latest.svg?label=Read%20the%20Docs)][read the docs]
[![Tests](https://github.com/MoritzM00/drcomp/workflows/Tests/badge.svg)][tests]
[![Codecov](https://codecov.io/gh/MoritzM00/drcomp/branch/main/graph/badge.svg)][codecov]

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]

[pypi_]: https://pypi.org/project/drcomp/
[status]: https://pypi.org/project/drcomp/
[python version]: https://pypi.org/project/drcomp
[read the docs]: https://drcomp.readthedocs.io/
[tests]: https://github.com/MoritzM00/drcomp/actions?workflow=Tests
[codecov]: https://app.codecov.io/gh/MoritzM00/drcomp
[pre-commit]: https://github.com/pre-commit/pre-commit
[black]: https://github.com/psf/black

## Features

- TODO

## Requirements

- TODO

## Installation

You can install _drcomp_ via [pip] from [PyPI]:

```console
pip install drcomp
```

## License

Distributed under the terms of the [MIT license][license],
_drcomp_ is free and open source software.

## Issues

If you encounter any problems,
please [file an issue] along with a detailed description.

## Credits

This project is based on [@cjolowicz]'s [Hypermodern Python Cookiecutter] template and
was modified better fit my needs and to remove some not needed features.

[@cjolowicz]: https://github.com/cjolowicz
[pypi]: https://pypi.org/
[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
[file an issue]: https://github.com/MoritzM00/drcomp/issues
[pip]: https://pip.pypa.io/

<!-- github-only -->

[license]: https://github.com/MoritzM00/drcomp/blob/main/LICENSE

