From e25b2c4968af06f46f5acf414ce72ac3fd740eaa Mon Sep 17 00:00:00 2001 From: "Yuan (Terry) Tang" Date: Sun, 6 Dec 2015 11:05:44 -0500 Subject: [PATCH 1/3] Remove redundant README --- python-package/README.md | 31 ------------------------------- 1 file changed, 31 deletions(-) delete mode 100644 python-package/README.md diff --git a/python-package/README.md b/python-package/README.md deleted file mode 100644 index 16a36d9fd..000000000 --- a/python-package/README.md +++ /dev/null @@ -1,31 +0,0 @@ -XGBoost Python Package -====================== -[![PyPI version](https://badge.fury.io/py/xgboost.svg)](http://badge.fury.io/py/xgboost) -[![PyPI downloads](https://img.shields.io/pypi/dm/xgboost.svg)](https://pypi.python.org/pypi/xgboost/) - -Installation ------------- -We are on [PyPI](https://pypi.python.org/pypi/xgboost) now. For stable version, please install using pip: - -* ```pip install xgboost``` -* Note for windows users: this pip installation may not work on some windows environment, and it may cause unexpected errors. pip installation on windows is currently disabled for further invesigation, please install from github. - -For up-to-date version, please install from github. - -* To make the python module, type ```./build.sh``` in the root directory of project -* Make sure you have [setuptools](https://pypi.python.org/pypi/setuptools) -* Install with `python setup.py install` from this directory. -* For windows users, please use the Visual Studio project file under [windows folder](../windows/). See also the [installation tutorial](https://www.kaggle.com/c/otto-group-product-classification-challenge/forums/t/13043/run-xgboost-from-windows-and-python) from Kaggle Otto Forum. - -Examples ------- - -* Refer also to the walk through example in [demo folder](../demo/guide-python) -* See also the [example scripts](../demo/kaggle-higgs) for Kaggle Higgs Challenge, including [speedtest script](../demo/kaggle-higgs/speedtest.py) on this dataset. - -Note ------ - -* If you want to build xgboost on Mac OS X with multiprocessing support where clang in XCode by default doesn't support, please install gcc 4.9 or higher using [homebrew](http://brew.sh/) ```brew tap homebrew/versions; brew install gcc49``` -* If you want to run XGBoost process in parallel using the fork backend for joblib/multiprocessing, you must build XGBoost without support for OpenMP by `make no_omp=1`. Otherwise, use the forkserver (in Python 3.4) or spawn backend. See the [sklearn_parallel.py](../demo/guide-python/sklearn_parallel.py) demo. - From ea883b30a51b46de0ccc9905c35130d75039ba5c Mon Sep 17 00:00:00 2001 From: Derek Damron Date: Sun, 6 Dec 2015 14:38:59 -0800 Subject: [PATCH 2/3] Update index.md Fixing a couple of spelling and grammatical errors. --- doc/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/index.md b/doc/index.md index 40b7c5192..2329c9677 100644 --- a/doc/index.md +++ b/doc/index.md @@ -11,7 +11,7 @@ This document is hosted at http://xgboost.readthedocs.org/. You can also browse How to Get Started ------------------ The best way to get started to learn xgboost is by the examples. There are three types of examples you can find in xgboost. -* [Tutorials](#tutorials) are self-conatained tutorials on a complete data science tasks. +* [Tutorials](#tutorials) are self-contained tutorials on complete data science tasks. * [XGBoost Code Examples](../demo/) are collections of code and benchmarks of xgboost. - There is a walkthrough section in this to walk you through specific API features. * [Highlight Solutions](#highlight-solutions) are presentations using xgboost to solve real world problems. From 162e91c5ca50898482def7a643036d8e244ca305 Mon Sep 17 00:00:00 2001 From: "Yuan (Terry) Tang" Date: Sun, 6 Dec 2015 20:25:53 -0600 Subject: [PATCH 3/3] change .md to .rst --- python-package/setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python-package/setup.py b/python-package/setup.py index f266e7fb2..4b05bc710 100644 --- a/python-package/setup.py +++ b/python-package/setup.py @@ -23,7 +23,7 @@ LIB_PATH = libpath['find_lib_path']() setup(name='xgboost', version=open(os.path.join(CURRENT_DIR, 'xgboost/VERSION')).read().strip(), #version='0.4a23', - description=open(os.path.join(CURRENT_DIR, 'README.md')).read(), + description=open(os.path.join(CURRENT_DIR, 'README.rst')).read(), install_requires=[ 'numpy', 'scipy',