Skip to content

Commit

Permalink
Update the setup and README
Browse files Browse the repository at this point in the history
  • Loading branch information
Guillaume Lemaitre committed Jul 6, 2016
1 parent 342c36c commit 47dd145
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 19 deletions.
4 changes: 2 additions & 2 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
recursive-include doc *
recursive-include examples *
include AUTHORS.rst
include CONTRIBUTING.rst
include CONTRIBUTING.ms
include LICENSE.md
include README.md
include README.rst
40 changes: 27 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,13 @@ imbalanced-learn
================

imbalanced-learn is a python package offering a number of re-sampling techniques commonly used in datasets showing strong between-class imbalance.
It is compatible with [scikit-learn](http://scikit-learn.org/stable/) and has been submitted to be part of [scikit-learn-contrib](https://github.com/scikit-learn-contrib) projects.
It is compatible with scikit-learn_ and has been submitted to be part of scikit-learn-contrib_ projects.

|Landscape|_ |Travis|_ |Coveralls|_ |CircleCI|_ |Gitter|_
.. _scikit-learn: http://scikit-learn.org/stable/

.. _scikit-learn-contrib: https://github.com/scikit-learn-contrib

|Landscape|_ |Travis|_ |Coveralls|_ |CircleCI|_ |Python27|_ |Python35|_ |Pypi|_ |Gitter|_

.. |Landscape| image:: https://landscape.io/github/glemaitre/UnbalancedDataset/master/landscape.svg?style=flat
.. _Landscape: https://landscape.io/github/glemaitre/UnbalancedDataset/master
Expand All @@ -20,6 +24,15 @@ It is compatible with [scikit-learn](http://scikit-learn.org/stable/) and has be
.. |CircleCI| image:: https://circleci.com/gh/glemaitre/UnbalancedDataset.svg?style=shield&circle-token=:circle-token
.. _CircleCI: https://circleci.com/gh/glemaitre/UnbalancedDataset/tree/master

.. |Python27| image:: https://img.shields.io/badge/python-2.7-blue.svg
.. _Python27: https://badge.fury.io/py/scikit-learn

.. |Python35| image:: https://img.shields.io/badge/python-3.5-blue.svg
.. _Python35: https://badge.fury.io/py/scikit-learn

.. |Pypi| image:: https://badge.fury.io/py/imbalanced-learn.svg
.. _Pypi: https://badge.fury.io/py/imbalanced-learn

.. |Gitter| image:: https://badges.gitter.im/glemaitre/UnbalancedDataset.svg
.. _Gitter: https://gitter.im/glemaitre/UnbalancedDataset?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

Expand All @@ -33,35 +46,36 @@ Installation documentation, API documentation, and examples can be found on the
Installation
============

### Dependencies
Dependencies
------------

imbalanced-learn is tested to work under Python 2.7 and Python 3.5.

* scipy(>=0.17.0)
* numpy(>=1.10.4)
* scikit-learn(>=0.17.1)

### Installation
Installation
------------

imbalanced-learn is not currently available on the PyPi's reporitories,
however you can install it via `pip`:
however you can install it via `pip`::

pip install git+https://github.com/fmfn/UnbalancedDataset

If you prefer, you can clone it and run the setup.py file. Use the following commands to get a
copy from Github and install all dependencies:
copy from Github and install all dependencies::

git clone https://github.com/fmfn/UnbalancedDataset.git
cd UnbalancedDataset
python setup.py install

### Testing
Testing
-------

After installation, you can use `nose` to run the test suite:
After installation, you can use `nose` to run the test suite::

```
make coverage
```
make coverage

About
=====
Expand All @@ -73,8 +87,8 @@ One way of addresing this issue is by re-sampling the dataset as to offset this
Re-sampling techniques are divided in two categories:
1. Under-sampling the majority class(es).
2. Over-sampling the minority class.
3. Combining over- and under-sampling.
4. Create ensemble balanced sets.
3. Combining over- and under-sampling.
4. Create ensemble balanced sets.

Below is a list of the methods currently implemented in this module.

Expand Down
5 changes: 1 addition & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,11 +78,8 @@ def is_installing():
'Operating System :: POSIX',
'Operating System :: Unix',
'Operating System :: MacOS',
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.6',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3.3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
],
packages=find_packages(),
install_requires=['scipy>=0.17.0',
Expand Down

0 comments on commit 47dd145

Please sign in to comment.