Skip to content

Commit 47dd145

Browse files
author
Guillaume Lemaitre
committed
Update the setup and README
1 parent 342c36c commit 47dd145

File tree

3 files changed

+30
-19
lines changed

3 files changed

+30
-19
lines changed

MANIFEST.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
recursive-include doc *
33
recursive-include examples *
44
include AUTHORS.rst
5-
include CONTRIBUTING.rst
5+
include CONTRIBUTING.ms
66
include LICENSE.md
7-
include README.md
7+
include README.rst

README.rst

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,13 @@ imbalanced-learn
44
================
55

66
imbalanced-learn is a python package offering a number of re-sampling techniques commonly used in datasets showing strong between-class imbalance.
7-
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.
7+
It is compatible with scikit-learn_ and has been submitted to be part of scikit-learn-contrib_ projects.
88

9-
|Landscape|_ |Travis|_ |Coveralls|_ |CircleCI|_ |Gitter|_
9+
.. _scikit-learn: http://scikit-learn.org/stable/
10+
11+
.. _scikit-learn-contrib: https://github.com/scikit-learn-contrib
12+
13+
|Landscape|_ |Travis|_ |Coveralls|_ |CircleCI|_ |Python27|_ |Python35|_ |Pypi|_ |Gitter|_
1014

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

27+
.. |Python27| image:: https://img.shields.io/badge/python-2.7-blue.svg
28+
.. _Python27: https://badge.fury.io/py/scikit-learn
29+
30+
.. |Python35| image:: https://img.shields.io/badge/python-3.5-blue.svg
31+
.. _Python35: https://badge.fury.io/py/scikit-learn
32+
33+
.. |Pypi| image:: https://badge.fury.io/py/imbalanced-learn.svg
34+
.. _Pypi: https://badge.fury.io/py/imbalanced-learn
35+
2336
.. |Gitter| image:: https://badges.gitter.im/glemaitre/UnbalancedDataset.svg
2437
.. _Gitter: https://gitter.im/glemaitre/UnbalancedDataset?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
2538

@@ -33,35 +46,36 @@ Installation documentation, API documentation, and examples can be found on the
3346
Installation
3447
============
3548

36-
### Dependencies
49+
Dependencies
50+
------------
3751

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

4054
* scipy(>=0.17.0)
4155
* numpy(>=1.10.4)
4256
* scikit-learn(>=0.17.1)
4357

44-
### Installation
58+
Installation
59+
------------
4560

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

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

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

5469
git clone https://github.com/fmfn/UnbalancedDataset.git
5570
cd UnbalancedDataset
5671
python setup.py install
5772

58-
### Testing
73+
Testing
74+
-------
5975

60-
After installation, you can use `nose` to run the test suite:
76+
After installation, you can use `nose` to run the test suite::
6177

62-
```
63-
make coverage
64-
```
78+
make coverage
6579

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

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

setup.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,11 +78,8 @@ def is_installing():
7878
'Operating System :: POSIX',
7979
'Operating System :: Unix',
8080
'Operating System :: MacOS',
81-
'Programming Language :: Python :: 2',
82-
'Programming Language :: Python :: 2.6',
8381
'Programming Language :: Python :: 2.7',
84-
'Programming Language :: Python :: 3.3',
85-
'Programming Language :: Python :: 3.4',
82+
'Programming Language :: Python :: 3.5',
8683
],
8784
packages=find_packages(),
8885
install_requires=['scipy>=0.17.0',

0 commit comments

Comments
 (0)