Skip to content

Commit 5113e7f

Browse files
committed
[DOC] Update the documentation
1 parent b39c852 commit 5113e7f

File tree

2 files changed

+36
-14
lines changed

2 files changed

+36
-14
lines changed

README.rst

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,10 @@ Deep Forest
1515
.. |pypi| image:: https://img.shields.io/pypi/v/deep-forest?color=blue
1616
.. _pypi: https://pypi.org/project/deep-forest/
1717

18-
**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:
18+
Deep Forest (DF) 21
19+
===================
20+
21+
**DF21** is an implementation of Deep Forest 2021.2.1. It is designed to have the following advantages:
1922

2023
- **Powerful**: Better accuracy than existing tree-based ensemble methods.
2124
- **Easy to Use**: Less efforts on tunning parameters.
@@ -65,9 +68,23 @@ Reference
6568

6669
.. code-block:: latex
6770

71+
@article{zhou2019deep,
72+
title={Deep forest},
73+
author={Zhi-Hua Zhou and Ji Feng},
74+
journal={National Science Review},
75+
volume={6},
76+
number={1},
77+
pages={74--86},
78+
year={2019}}
79+
6880
@inproceedings{zhou2017deep,
6981
Author = {Zhi-Hua Zhou and Ji Feng},
7082
Booktitle = {IJCAI},
7183
Pages = {3553-3559},
7284
Title = {{Deep Forest:} Towards an alternative to deep neural networks},
7385
Year = {2017}}
86+
87+
Acknowledgement
88+
---------------
89+
90+
The lead developer and maintainer of DF21 is Mr. `Yi-Xuan Xu <https://github.com/xuyxu>`__. Before the release, it has been used internally in the LAMDA Group, Nanjing University, China.

docs/index.rst

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
Deep Forest Documentation
2-
=========================
1+
DF21 Documentation
2+
==================
33

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:
4+
**DF21** is an implementation of Deep Forest 2021.2.1. It is designed to have the following advantages:
55

66
- **Powerful**: Better accuracy than existing tree-based ensemble methods.
77
- **Easy to Use**: Less efforts on tunning parameters.
88
- **Efficient**: Fast training speed and high efficiency.
99
- **Scalable**: Capable of handling large-scale data.
1010

11-
The package is actively being developed. The goal is to provide users from the industrial and academic community with a third option on tree-based ensemble methods apart from Random Forest and Gradient Boosting Decision Tree. To achieve this, any help would be welcomed. Please check the homepage on `Gitee <https://gitee.com/lamda-nju/deep-forest>`__ or `Github <https://github.com/LAMDA-NJU/Deep-Forest>`__ for details.
11+
The package is actively being developed. The goal is to provide users from the industrial and academic community with **a third option on tree-based ensemble methods apart from Random Forest and Gradient Boosting Decision Tree**. To achieve this, any help would be welcomed. Please check the homepage on `Gitee <https://gitee.com/lamda-nju/deep-forest>`__ or `Github <https://github.com/LAMDA-NJU/Deep-Forest>`__ for details.
1212

1313
Guidepost
1414
---------
1515
* For a quick start, please refer to `How to Get Started <./how_to_get_started.html>`__.
16-
* For a guidance on parameter tunning, please refer to `Parameters Tunning <./parameters_tunning.html>`__.
17-
* For a comparison between deep forest and other tree-based ensemble methods, please refer to `Experiments <./experiments.html>`__.
16+
* For a guidance on tunning parameters for DF21, please refer to `Parameters Tunning <./parameters_tunning.html>`__.
17+
* For a comparison between DF21 and other tree-based ensemble methods, please refer to `Experiments <./experiments.html>`__.
1818

1919
Installation
2020
------------
@@ -65,13 +65,6 @@ Reference
6565

6666
.. code-block:: latex
6767

68-
@inproceedings{zhou2017deep,
69-
Author = {Zhi-Hua Zhou and Ji Feng},
70-
Booktitle = {IJCAI},
71-
Pages = {3553-3559},
72-
Title = {{Deep Forest:} Towards an alternative to deep neural networks},
73-
Year = {2017}}
74-
7568
@article{zhou2019deep,
7669
title={Deep forest},
7770
author={Zhi-Hua Zhou and Ji Feng},
@@ -81,6 +74,13 @@ Reference
8174
pages={74--86},
8275
year={2019}}
8376

77+
@inproceedings{zhou2017deep,
78+
Author = {Zhi-Hua Zhou and Ji Feng},
79+
Booktitle = {IJCAI},
80+
Pages = {3553-3559},
81+
Title = {{Deep Forest:} Towards an alternative to deep neural networks},
82+
Year = {2017}}
83+
8484
.. toctree::
8585
:maxdepth: 1
8686
:caption: For Users
@@ -103,3 +103,8 @@ Reference
103103

104104
About Us <http://www.lamda.nju.edu.cn/MainPage.ashx>
105105
Related Software <related_software>
106+
107+
Acknowledgement
108+
---------------
109+
110+
The lead developer and maintainer of DF21 is Mr. `Yi-Xuan Xu <https://github.com/xuyxu>`__. Before the release, it has been used internally in the LAMDA Group, Nanjing University, China.

0 commit comments

Comments
 (0)