diff --git a/docs/api/api.rst b/docs/api/api.rst index c8dc5b71..b61ccd0c 100644 --- a/docs/api/api.rst +++ b/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 `_ 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 `__. - -* `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 diff --git a/docs/api/quickstart.rst b/docs/api/quickstart.rst new file mode 100644 index 00000000..816d50a4 --- /dev/null +++ b/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 `__. + +* `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 diff --git a/docs/cli/ov_data_format.rst b/docs/cli/ov_data_format.rst index 6199c042..620c6b0b 100644 --- a/docs/cli/ov_data_format.rst +++ b/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 + diff --git a/docs/cli/quickstart.rst b/docs/cli/quickstart.rst new file mode 100644 index 00000000..e775348e --- /dev/null +++ b/docs/cli/quickstart.rst @@ -0,0 +1,12 @@ +Quickstart +^^^^^^^^^^ +* `Training and Prediction for Linear Classifiers `_ +* `Training, Prediction, and Hyper-parameter Search for Neural Networks `_ + +.. toctree:: + :caption: Quickstart + :hidden: + :maxdepth: 1 + + linear + nn diff --git a/docs/cli_index.rst b/docs/cli_index.rst new file mode 100644 index 00000000..fabce697 --- /dev/null +++ b/docs/cli_index.rst @@ -0,0 +1,16 @@ +Command Line Interface +^^^^^^^^^^^^^^^^^^^^^^ + +* `Installation and Dataset Formats `_ +* `Quickstart `_ +* `Command Line Options `_ +* `User Guide `_ + +.. toctree:: + :hidden: + :maxdepth: 1 + + cli/ov_data_format + cli/quickstart + cli/flags + User Guide \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index b2fd84ec..d21cdb65 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,31 +12,13 @@ For installation of LibMultiLabel, you can visit the `Command Line Interface `_. .. toctree:: - :caption: Command Line Interface - :maxdepth: 1 - :hidden: - - cli/ov_data_format - cli/linear - cli/nn - cli/flags - User Guide - -.. 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 diff --git a/docs/library_index.rst b/docs/library_index.rst new file mode 100644 index 00000000..c7f9adba --- /dev/null +++ b/docs/library_index.rst @@ -0,0 +1,16 @@ +API Library +^^^^^^^^^^^ + +* `Installation `_ +* `Quickstart `_ +* `Linear Classifier API `_ +* `Neural Network API `_ + +.. toctree:: + :maxdepth: 1 + :hidden: + + api/api + api/quickstart + api/linear + api/nn \ No newline at end of file diff --git a/docs/tutorial.rst b/docs/tutorial.rst new file mode 100644 index 00000000..c4e4a400 --- /dev/null +++ b/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 \ No newline at end of file