Reorganize the document

docs/api/api.rst

@@ -1,5 +1,5 @@
-Getting Started
-===============
+Installation
+===========================
 
 The library API is used in your own scripts if you want
 more fine grained control over the training/prediction process.
@@ -13,9 +13,6 @@ The library API is composed of a `linear classifier module <linear.html>`_ and a
 
 Both of which can be used independently.
 
-Installation
-^^^^^^^^^^^^
-
 We provide two installation types to install LibMultiLabel:
 
 * Install both neural network module and linear classifier module. ::
@@ -26,32 +23,9 @@ We provide two installation types to install LibMultiLabel:
 
     pip3 install libmultilabel[linear]
 
-Quickstart
-^^^^^^^^^^
-
-These tutorials show how the library API may be used in
-end-to-end examples. After these tutorials, more in-depth
-explanations can be found in the `user guides <https://www.csie.ntu.edu.tw/~cjlin/papers/libmultilabel/userguide.pdf>`__.
-
-* `Linear Model for Multi-label Classification <../auto_examples/plot_linear_quickstart.html>`_
-* `Bert Model for Multi-label  Classification <../auto_examples/plot_bert_quickstart.html>`_
-* `KimCNN Model for Multi-label Classification <../auto_examples/plot_KimCNN_quickstart.html>`_
-
-.. toctree::
-    :caption: Library
-    :maxdepth: 1
-    :hidden:
 
-    ../auto_examples/plot_linear_quickstart
-    ../auto_examples/plot_bert_quickstart
-    ../auto_examples/plot_KimCNN_quickstart
 
-Before we start, please download and decompress the data ``rcv1`` via the following commands::
 
-    mkdir -p data/rcv1
-    wget https://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/multilabel/rcv1_topics_train.txt.bz2 -O data/rcv1/train.txt.bz2
-    wget https://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/multilabel/rcv1_topics_test.txt.bz2 -O data/rcv1/test.txt.bz2
-    bzip2 -d data/rcv1/*.bz2
 
 
 

docs/api/quickstart.rst

@@ -0,0 +1,26 @@
+Quickstart
+^^^^^^^^^^^^^^^^^^^^
+
+These tutorials show how the library API may be used in
+end-to-end examples. After these tutorials, more in-depth
+explanations can be found in the `user guides <https://www.csie.ntu.edu.tw/~cjlin/papers/libmultilabel/userguide.pdf>`__.
+
+* `Linear Model for Multi-label Classification <../auto_examples/plot_linear_quickstart.html>`_
+* `Bert Model for Multi-label  Classification <../auto_examples/plot_bert_quickstart.html>`_
+* `KimCNN Model for Multi-label Classification <../auto_examples/plot_KimCNN_quickstart.html>`_
+
+.. toctree::
+    :caption: Library
+    :maxdepth: 1
+    :hidden:
+
+    ../auto_examples/plot_linear_quickstart
+    ../auto_examples/plot_bert_quickstart
+    ../auto_examples/plot_KimCNN_quickstart
+
+Before we start, please download and decompress the data ``rcv1`` via the following commands::
+
+    mkdir -p data/rcv1
+    wget https://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/multilabel/rcv1_topics_train.txt.bz2 -O data/rcv1/train.txt.bz2
+    wget https://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/multilabel/rcv1_topics_test.txt.bz2 -O data/rcv1/test.txt.bz2
+    bzip2 -d data/rcv1/*.bz2

docs/cli/ov_data_format.rst

@@ -1,5 +1,5 @@
-Installation, Dataset Formats, and Modules
-==========================================
+Installation and Dataset Formats
+=============================================
 
 To work with the command line interface, firstly
 
@@ -116,3 +116,4 @@ Some sample lines are as follows::
 
     1,3,5 1:0.1 9:0.2 13:0.3
     2,4,6 2:0.4 10:0.5 14:0.4
+

docs/cli/quickstart.rst

@@ -0,0 +1,12 @@
+Quickstart
+^^^^^^^^^^
+* `Training and Prediction for Linear Classifiers <linear.html>`_
+* `Training, Prediction, and Hyper-parameter Search for Neural Networks <nn.html>`_
+
+.. toctree::
+    :caption: Quickstart
+    :hidden:
+    :maxdepth: 1
+
+    linear
+    nn

docs/cli_index.rst

@@ -0,0 +1,16 @@
+Command Line Interface
+^^^^^^^^^^^^^^^^^^^^^^
+
+* `Installation and Dataset Formats <cli/ov_data_format.html>`_
+* `Quickstart <cli/quickstart.html>`_
+* `Command Line Options <cli/flags.html>`_
+* `User Guide <https://www.csie.ntu.edu.tw/~cjlin/papers/libmultilabel/userguide.pdf>`_
+
+.. toctree::
+    :hidden:
+    :maxdepth: 1
+
+    cli/ov_data_format
+    cli/quickstart
+    cli/flags
+    User Guide <https://www.csie.ntu.edu.tw/~cjlin/papers/libmultilabel/userguide.pdf>

docs/index.rst

@@ -12,31 +12,13 @@ For installation of LibMultiLabel, you can visit the `Command Line Interface <cl
 For practical tips, please see the `User Guide <https://www.csie.ntu.edu.tw/~cjlin/papers/libmultilabel/userguide.pdf>`_.
 
 .. toctree::
-    :caption: Command Line Interface
-    :maxdepth: 1
-    :hidden:
-
-    cli/ov_data_format
-    cli/linear
-    cli/nn
-    cli/flags
-    User Guide <https://www.csie.ntu.edu.tw/~cjlin/papers/libmultilabel/userguide.pdf>
-
-.. toctree::
-   :caption: Library
-   :maxdepth: 1
-   :hidden:
-
-   api/api
-   api/linear
-   api/nn
-
-.. toctree::
-   :caption: Tutorial
    :maxdepth: 1
    :hidden:
 
-   auto_examples/plot_linear_gridsearch_tutorial
+   cli_index
+   library_index
+   tutorial
+
 
 ..
    Indices and tables

docs/library_index.rst

@@ -0,0 +1,16 @@
+API Library
+^^^^^^^^^^^
+
+* `Installation <api/api.html>`_
+* `Quickstart <api/quickstart.html>`_
+* `Linear Classifier API <api/linear.html>`_
+* `Neural Network API <api/nn.html>`_
+
+.. toctree::
+    :maxdepth: 1
+    :hidden:
+
+    api/api
+    api/quickstart
+    api/linear
+    api/nn

docs/tutorial.rst

@@ -0,0 +1,11 @@
+Tutorial
+^^^^^^^^
+
+* `An Example of Using Data Stored in Different Forms. <../auto_examples/plot_dataset_tutorial/api.html>`_
+* `Feature Generation and Parameter Selection for Linear Methods <../auto_examples/plot_linear_gridsearch_tutorial.html>`_
+
+.. toctree::
+    :maxdepth: 1
+    :hidden:
+
+    ../auto_examples/plot_linear_gridsearch_tutorial