Skip to content

Commit 4fb8821

Browse files
committed
[DOC] Update README.rst
1 parent 64202a6 commit 4fb8821

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

README.rst

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
Deep Forest
2+
===========
3+
4+
**Deep Forest** is a general ensemble framework that uses tree-based ensemble algorithms such as Random Forest. It is designed to have the following advantages:
5+
6+
- **Powerful**: Better accuracy than existing tree-based ensemble methods.
7+
- **Easy to Use**: Less efforts on tunning parameters.
8+
- **Efficient**: Fast training speed and high efficiency.
9+
- **Scalable**: Capable of handling large-scale data.
10+
11+
For a quick start, please refer to `How to Get Started <http://www.lamda.nju.edu.cn/deep-forest/how_to_get_started.html>`__. For a detailed guidance on parameter tunning, please refer to `Parameters Tunning <http://www.lamda.nju.edu.cn/deep-forest/parameters_tunning.html>`__.
12+
13+
Installation
14+
------------
15+
16+
The package is available via PyPI using:
17+
18+
.. code-block:: bash
19+
20+
pip install deep-forest
21+
22+
Quickstart
23+
----------
24+
25+
.. code-block:: python
26+
27+
from sklearn.datasets import load_digits
28+
from sklearn.model_selection import train_test_split
29+
from sklearn.metrics import accuracy_score
30+
31+
from deepforest import CascadeForestClassifier
32+
33+
X, y = load_digits(return_X_y=True)
34+
X_train, X_test, y_train, y_test = train_test_split(X, y, random_state=1)
35+
model = CascadeForestClassifier(random_state=1)
36+
model.fit(X_train, y_train)
37+
y_pred = model.predict(X_test)
38+
acc = accuracy_score(y_test, y_pred) * 100
39+
print("\nTesting Accuracy: {:.3f} %".format(acc))
40+
>>> Testing Accuracy: 98.667 %
41+
42+
Resources
43+
---------
44+
45+
* `Documentation <http://www.lamda.nju.edu.cn/deep-forest>`__
46+
* Deep Forest: `[Paper] <https://arxiv.org/pdf/1702.08835.pdf>`__
47+
* Keynote at AISTATS 2019: `[Slides] <https://aistats.org/aistats2019/0-AISTATS2019-slides-zhi-hua_zhou.pdf>`__
48+
49+
Reference
50+
---------
51+
52+
.. code-block:: latex
53+
54+
@inproceedings{zhou2017deep,
55+
Author = {Zhi-Hua Zhou and Ji Feng},
56+
Booktitle = {IJCAI},
57+
Pages = {3553-3559},
58+
Title = {{Deep Forest:} Towards an alternative to deep neural networks},
59+
Year = {2017}}

0 commit comments

Comments
 (0)