Change the md to rst

Author: Guillaume Lemaitre

README.md

@@ -0,0 +1,145 @@
+.. -*- mode: rst -*-
+
+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.
+
+|Landscape|_ |Travis|_ |Coveralls|_ |CircleCI|_ |Gitter|_
+
+.. |Landscape| image:: https://landscape.io/github/glemaitre/UnbalancedDataset/master/landscape.svg?style=flat
+.. _Landscape: https://landscape.io/github/glemaitre/UnbalancedDataset/master
+
+.. |Travis| image:: https://travis-ci.org/glemaitre/UnbalancedDataset.svg?branch=master
+.. _Travis: https://travis-ci.org/glemaitre/UnbalancedDataset
+
+.. |Coveralls| image:: https://coveralls.io/repos/github/glemaitre/UnbalancedDataset/badge.svg?branch=master
+.. _Coveralls: https://coveralls.io/github/glemaitre/UnbalancedDataset?branch=master
+
+.. |CircleCI| image:: https://circleci.com/gh/glemaitre/UnbalancedDataset.svg?style=shield&circle-token=:circle-token
+.. _CircleCI: https://circleci.com/gh/glemaitre/UnbalancedDataset/tree/master
+
+.. |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
+
+Documentation
+=============
+
+Installation documentation, API documentation, and examples can be found on the documentation_.
+
+.. _documentation: http://glemaitre.github.io/UnbalancedDataset
+
+Installation
+============
+
+### 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
+
+imbalanced-learn is not currently available on the PyPi's reporitories, 
+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:
+
+    git clone https://github.com/fmfn/UnbalancedDataset.git
+    cd UnbalancedDataset
+    python setup.py install
+
+### Testing
+
+After installation, you can use `nose` to run the test suite:
+
+```
+make coverage
+```
+
+About
+=====
+
+Most classification algorithms will only perform optimally when the number of samples of each class is roughly the same. Highly skewed datasets, where the minority is heavily outnumbered by one or more classes, have proven to be a challenge while at the same time becoming more and more common.
+
+One way of addresing this issue is by re-sampling the dataset as to offset this imbalance with the hope of arriving at a more robust and fair decision boundary than you would otherwise.
+
+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.
+    
+Below is a list of the methods currently implemented in this module.
+
+* Under-sampling
+    1. Random majority under-sampling with replacement
+    2. Extraction of majority-minority Tomek links [1]_
+    3. Under-sampling with Cluster Centroids
+    4. NearMiss-(1 & 2 & 3) [2]_
+    5. Condensend Nearest Neighbour [3]_
+    6. One-Sided Selection [4]_
+    7. Neighboorhood Cleaning Rule [5]_
+    8. Edited Nearest Neighbours [6]_
+    9. Instance Hardness Threshold [7]_
+    10. Repeated Edited Nearest Neighbours [14]_
+
+* Over-sampling
+    1. Random minority over-sampling with replacement
+    2. SMOTE - Synthetic Minority Over-sampling Technique [8]_
+    3. bSMOTE(1 & 2) - Borderline SMOTE of types 1 and 2 [9]_
+    4. SVM SMOTE - Support Vectors SMOTE [10]_
+    5. ADASYN - Adaptive synthetic sampling approach for imbalanced learning [15]_
+
+* Over-sampling followed by under-sampling
+    1. SMOTE + Tomek links [12]_
+    2. SMOTE + ENN [11]_
+
+* Ensemble sampling
+    1. EasyEnsemble [13]_
+    2. BalanceCascade [13]_
+
+The different algorithms are presented in the following notebook_.
+
+.. _notebook: https://github.com/fmfn/UnbalancedDataset/blob/master/examples/plot_unbalanced_dataset.ipynb
+
+This is a work in progress. Any comments, suggestions or corrections are welcome.
+
+References:
+-----------
+
+.. [1] : I. Tomek, “Two modifications of CNN,” In Systems, Man, and Cybernetics, IEEE Transactions on, vol. 6, pp 769-772, 2010.
+
+.. [2] : I. Mani, I. Zhang. “kNN approach to unbalanced data distributions: a case study involving information extraction,” In Proceedings of workshop on learning from imbalanced datasets, 2003.
+
+.. [3] : P. Hart, “The condensed nearest neighbor rule,” In Information Theory, IEEE Transactions on, vol. 14(3), pp. 515-516, 1968.
+
+.. [4] : M. Kubat, S. Matwin, “Addressing the curse of imbalanced training sets: one-sided selection,” In ICML, vol. 97, pp. 179-186, 1997.
+
+.. [5] : J. Laurikkala, “Improving identification of difficult small classes by balancing class distribution,” Springer Berlin Heidelberg, 2001.
+
+.. [6] : D. Wilson, “Asymptotic Properties of Nearest Neighbor Rules Using Edited Data,” In IEEE Transactions on Systems, Man, and Cybernetrics, vol. 2 (3), pp. 408-421, 1972.
+
+.. [7] : D. Smith, Michael R., Tony Martinez, and Christophe Giraud-Carrier. “An instance level analysis of data complexity.” Machine learning 95.2 (2014): 225-256.
+
+.. [8] : N. V. Chawla, K. W. Bowyer, L. O.Hall, W. P. Kegelmeyer, “SMOTE: synthetic minority over-sampling technique,” Journal of artificial intelligence research, 321-357, 2002.
+
+.. [9] : H. Han, W. Wen-Yuan, M. Bing-Huan, “Borderline-SMOTE: a new over-sampling method in imbalanced data sets learning,” Advances in intelligent computing, 878-887, 2005.
+
+.. [10] : H. M. Nguyen, E. W. Cooper, K. Kamei, “Borderline over-sampling for imbalanced data classification,” International Journal of Knowledge Engineering and Soft Data Paradigms, 3(1), pp.4-21, 2001.
+
+.. [11] : G. Batista, R. C. Prati, M. C. Monard. “A study of the behavior of several methods for balancing machine learning training data,” ACM Sigkdd Explorations Newsletter 6 (1), 20-29, 2004.
+
+.. [12] : G. Batista, B. Bazzan, M. Monard, [“Balancing Training Data for Automated Annotation of Keywords: a Case Study,” In WOB, 10-18, 2003.
+
+.. [13] : X. Y. Liu, J. Wu and Z. H. Zhou, “Exploratory Undersampling for Class-Imbalance Learning,” in IEEE Transactions on Systems, Man, and Cybernetics, Part B (Cybernetics), vol. 39, no. 2, pp. 539-550, April 2009.
+
+.. [14] : I. Tomek, “An Experiment with the Edited Nearest-Neighbor Rule,” IEEE Transactions on Systems, Man, and Cybernetics, vol. 6(6), pp. 448-452, June 1976.
+
+.. [15] : He, Haibo, Yang Bai, Edwardo A. Garcia, and Shutao Li. “ADASYN: Adaptive synthetic sampling approach for imbalanced learning,” In IEEE International Joint Conference on Neural Networks (IEEE World Congress on Computational Intelligence), pp. 1322-1328, 2008.

README.rst

@@ -36,7 +36,8 @@ def is_installing():
 _VERSION_GLOBALS = load_version()
 DISTNAME = 'imbalanced-learn'
 DESCRIPTION = 'Toolbox for imbalanced dataset in machine learning.'
-LONG_DESCRIPTION = descr
+with open('README.rst') as f:
+    LONG_DESCRIPTION = f.read()
 MAINTAINER = 'G. Lemaitre, F. Nogueira, D. Oliveira, C. Aridas'
 MAINTAINER_EMAIL = '[email protected], [email protected], [email protected], [email protected]'
 URL = 'https://github.com/fmfn/UnbalancedDataset'
@@ -84,4 +85,6 @@ def is_installing():
               'Programming Language :: Python :: 3.4',
           ],
           packages=find_packages(),
-          install_requires=install_requires,)
+          install_requires=['scipy>=0.17.0',
+                            'numpy>=1.10.4',
+                            'scikit-learn>=0.17.1'])