Skip to content

Commit a180128

Browse files
committed
[DOC] Polish up the documentation
1 parent bf56434 commit a180128

3 files changed

Lines changed: 33 additions & 10 deletions

File tree

docs/guide.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Guidance
2+
========
3+
4+
This page provides useful instructions on choosing the appropriate ensemble method.
5+
6+
Check Your Model
7+
----------------
8+
9+
Under-fit
10+
---------
11+
12+
Over-fit
13+
--------
14+
15+
Large Training Costs
16+
--------------------

docs/index.rst

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,23 @@
2222
Ensemble-PyTorch Documentation
2323
==============================
2424

25-
Ensemble-PyTorch implements a collection of ensemble methods in PyTorch. It provides:
25+
**Ensemble-PyTorch** implements a collection of ensemble methods in PyTorch. It provides:
2626

27-
* Easy ways to boost the performance of your deep learning models;
28-
* Easy-to-use APIs on training and evaluating;
29-
* High training efficiency.
30-
31-
To get started, please refer to `Quick Start <./quick_start.html>`__. To learn more about ensemble methods currently supported, please refer to `Introduction <./introduction.html>`__.
27+
* |:chart_with_upwards_trend:| Easy ways to boost the performance of your deep learning models;
28+
* |:baby:| Easy-to-use APIs on training and evaluating;
29+
* |:zap:| High training efficiency with parallelization.
3230

3331
This package is under active development. Please feel free to open an `issue <https://github.com/AaronX121/Ensemble-Pytorch/issues>`__ if your have any problem. In addition, any feature request or `pull request <https://github.com/AaronX121/Ensemble-Pytorch/pulls>`__ would be highly welcomed.
3432

35-
Example on How to Use
36-
---------------------
33+
|:triangular_flag_on_post:| Guidepost
34+
-------------------------------------
35+
36+
* To get started, please refer to `Quick Start <./quick_start.html>`__;
37+
* To learn more about ensemble methods supported, please refer to `Introduction <./introduction.html>`__;
38+
* If you are confused on which ensemble method to use, instructions in `Guidance <./guide.html>`__ may be helpful.
39+
40+
|:woman_teacher:| Example
41+
-------------------------
3742

3843
.. code:: python
3944
@@ -59,14 +64,15 @@ Example on How to Use
5964
# Evaluate
6065
accuracy = model.predict(test_loader)
6166
62-
Contents
63-
--------
67+
|:book:| Content
68+
----------------
6469

6570
.. toctree::
6671
:maxdepth: 2
6772

6873
Quick Start <quick_start>
6974
Introduction <introduction>
75+
Guidance <guide>
7076
Experiment <experiment>
7177
API Reference <parameters>
7278
Changelog <changelog>

docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
sphinx==3.2.*
22
sphinx-panels==0.5.*
3+
sphinxemoji==0.1.8
34
sphinx-copybutton
45
guzzle_sphinx_theme

0 commit comments

Comments
 (0)