Metadata-Version: 2.1
Name: problexity
Version: 0.3.1
Summary: The problexity module is an open-source python library containing the implementation of measures describing the complexity of the classification problem.
Home-page: https://w4k2.github.io/problexity/
Maintainer: J. Komorniczak
Maintainer-email: joanna.komorniczak@vp.pl
License: GPL-3.0
Download-URL: https://github.com/w4k2/problexity
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
License-File: LICENSE

# problexity

[![w4k2](https://circleci.com/gh/w4k2/problexity.svg?style=shield)](https://circleci.com/gh/w4k2/problexity)
[![codecov](https://codecov.io/gh/w4k2/problexity/branch/master/graph/badge.svg?token=KxuYRg7J8B)](https://codecov.io/gh/w4k2/problexity)
[![Documentation Status](https://readthedocs.org/projects/problexity/badge/?version=latest)](http://problexity.readthedocs.io)
[![PyPI version](https://badge.fury.io/py/problexity.svg)](https://badge.fury.io/py/problexity)

The `problexity` module is an open-source python library containing the implementation of measures describing the complexity of the classification problem. The package contains a ComplexityCalculator model, allowing the calculation and visualization of problem complexity measures.

## Citation policy

If you use problexity in a scientific publication, I would appreciate citation to the following paper:

```
@article{komorniczak2022complexity,
  title={problexity--open-source Python library for measuring classification complexity},
  author={Komorniczak, Joanna and Wojciechowski, Szymon and Ksieniewicz, Pawel},
  journal={arXiv preprint arXiv:XXXX.YYYYY},
  year={2022}
}
```

## Quick start guide

### Installation

To use the `problexity` package, it will be absolutely useful to install it. Fortunately, it is available in the *PyPI* repository, so you may install it using `pip`:

```shell
pip3 install -U problexity
```

You can also install the module cloned from Github using the setup.py file if you have a strange, but perhaps legitimate need:

```shell
git clone https://github.com/w4k2/problexity.git
cd problexity
make install
```

### Usage

...


