Better Documentation

[xuyxu]

Thanks to the contributors, many new features have been developed. As a result, the current version of documentation could be ambiguous, and requires more explanation or demonstration.

This issue collects suggestions on the documentation. Any one is welcomed to improve the readability of the documentation. For contributors unfamiliar with our workflow on building the documentation, please refer to the instructions below.

Build the documentation locally

• Clone the repo and install package dependencies:

git clone https://github.com/LAMDA-NJU/Deep-Forest.git
cd Deep-Forest/docs
pip install -r requirements.txt

• Make modifications to the corresponding .rst file. (Wiki of rst)
• Build the documentation:

make html

The generated html files are available in the directory _build/html/, and the homepage is index.html.

Build the documentation via pull request

Readthedocs has been integrated into our CI, and you can also view the documentation after creating your PR, available in the last row of GitHub Checks on your PR page.

All contributors

Full list available at Contributors.

• @dwaipayan05: Minor Changes to README.rst #31

[dwaipayan05]

I've added a Pull Request #31 , can you link the PR to this issue and review the changes.

[xuyxu]

I've added a Pull Request #31 , can you link the PR to this issue and review the changes.

Done.

[Alex-Medium]

I think it would be much better to have a page with following things:

• a tutorial on DF21 model
• roles of different parameters in DF21 model

[xuyxu]

Sorry for my late response @Alex-Medium, I am not aware of your comment.

That would be great, we are going to set up another page under the section Advanced Topics that illustrates the model architecture and the meaning of different parameters.