From b241cc389fe3cc2ace119b4dbdb1783af18e056a Mon Sep 17 00:00:00 2001 From: Tsukasa OMOTO Date: Thu, 3 Aug 2017 12:51:17 +0900 Subject: [PATCH] Update docs (#776) * docs: add Advanced-Topic TOC * docs: add title header to Advanced-Topic.md * docs: convert development.md to development.rst `pandoc --columns=200 -f markdown_github -t rst -o development.rst development.md` * docs: update index.rst --- docs/development.md | 61 ------------------------------- docs/development.rst | 86 ++++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 1 + 3 files changed, 87 insertions(+), 61 deletions(-) delete mode 100644 docs/development.md create mode 100644 docs/development.rst diff --git a/docs/development.md b/docs/development.md deleted file mode 100644 index 7abfdfd1ef16..000000000000 --- a/docs/development.md +++ /dev/null @@ -1,61 +0,0 @@ -Development Guide -================== - -Algorithms ----------- - -Refer to [Features](https://github.com/Microsoft/LightGBM/wiki/Features) to get important algorithms used in LightGBM. - -Classes And Code Structure --------------------------- - -### Important Classes - -| Class | description | -| ----- | --------- | -| `Application` | The entrance of application, including training and prediction logic | -| `Bin` | Data structure used for store feature discrete values(converted from float values) | -| `Boosting` | Boosting interface, current implementation is GBDT and DART | -| `Config` | Store parameters and configurations| -| `Dataset` | Store information of dataset | -| `DatasetLoader` | Used to construct dataset | -| `Feature` | Store One column feature | -| `Metric` | Evaluation metrics | -| `Network` | Newwork interfaces and communication algorithms | -| `ObjectiveFunction` | Objective function used to train | -| `Tree` | Store information of tree model | -| `TreeLearner` | Used to learn trees | - -### Code Structure - -| Path | description | -| ----- | --------- | -| ./include | header files | -| ./include/utils | some common functions | -| ./src/application | Implementations of training and prediction logic | -| ./src/boosting | Implementations of Boosting | -| ./src/io | Implementations of IO relatived classes, including `Bin`, `Config`, `Dataset`, `DatasetLoader`, `Feature` and `Tree`| -| ./src/metric | Implementations of metrics | -| ./src/network | Implementations of network functions | -| ./src/objective | Implementations of objective functions | -| ./src/treelearner | Implementations of tree learners | - -### API Documents - -LightGBM support use [doxygen](http://www.stack.nl/~dimitri/doxygen/) to generate documents for classes and functions. - -C API ------ -Refere to the comments in [c_api.h](https://github.com/Microsoft/LightGBM/blob/master/include/LightGBM/c_api.h). - -High level Language package ---------------------------- - -Follow the implementation of [python-package](https://github.com/Microsoft/LightGBM/tree/master/python-package/lightgbm). - -Ask Questions -------------- -Feel free to open [issues](https://github.com/Microsoft/LightGBM/issues) if you met problems. - - - diff --git a/docs/development.rst b/docs/development.rst new file mode 100644 index 000000000000..a2b70086bec2 --- /dev/null +++ b/docs/development.rst @@ -0,0 +1,86 @@ +Development Guide +================= + +Algorithms +---------- + +Refer to `Features `__ to get important algorithms used in LightGBM. + +Classes And Code Structure +-------------------------- + +Important Classes +~~~~~~~~~~~~~~~~~ + ++-------------------------+--------------------------------------------------------------------------------------+ +| Class | description | ++=========================+======================================================================================+ +| ``Application`` | The entrance of application, including training and prediction logic | ++-------------------------+--------------------------------------------------------------------------------------+ +| ``Bin`` | Data structure used for store feature discrete values(converted from float values) | ++-------------------------+--------------------------------------------------------------------------------------+ +| ``Boosting`` | Boosting interface, current implementation is GBDT and DART | ++-------------------------+--------------------------------------------------------------------------------------+ +| ``Config`` | Store parameters and configurations | ++-------------------------+--------------------------------------------------------------------------------------+ +| ``Dataset`` | Store information of dataset | ++-------------------------+--------------------------------------------------------------------------------------+ +| ``DatasetLoader`` | Used to construct dataset | ++-------------------------+--------------------------------------------------------------------------------------+ +| ``Feature`` | Store One column feature | ++-------------------------+--------------------------------------------------------------------------------------+ +| ``Metric`` | Evaluation metrics | ++-------------------------+--------------------------------------------------------------------------------------+ +| ``Network`` | Newwork interfaces and communication algorithms | ++-------------------------+--------------------------------------------------------------------------------------+ +| ``ObjectiveFunction`` | Objective function used to train | ++-------------------------+--------------------------------------------------------------------------------------+ +| ``Tree`` | Store information of tree model | ++-------------------------+--------------------------------------------------------------------------------------+ +| ``TreeLearner`` | Used to learn trees | ++-------------------------+--------------------------------------------------------------------------------------+ + +Code Structure +~~~~~~~~~~~~~~ + ++---------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| Path | description | ++=====================+====================================================================================================================================+ +| ./include | header files | ++---------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| ./include/utils | some common functions | ++---------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| ./src/application | Implementations of training and prediction logic | ++---------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| ./src/boosting | Implementations of Boosting | ++---------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| ./src/io | Implementations of IO relatived classes, including ``Bin``, ``Config``, ``Dataset``, ``DatasetLoader``, ``Feature`` and ``Tree`` | ++---------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| ./src/metric | Implementations of metrics | ++---------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| ./src/network | Implementations of network functions | ++---------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| ./src/objective | Implementations of objective functions | ++---------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| ./src/treelearner | Implementations of tree learners | ++---------------------+------------------------------------------------------------------------------------------------------------------------------------+ + +API Documents +~~~~~~~~~~~~~ + +LightGBM support use `doxygen `__ to generate documents for classes and functions. + +C API +----- + +Refere to the comments in `c\_api.h `__. + +High level Language package +--------------------------- + +Follow the implementation of `python-package `__. + +Ask Questions +------------- + +Feel free to open `issues `__ if you met problems. diff --git a/docs/index.rst b/docs/index.rst index e63757ee880b..5be08a128539 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,6 +16,7 @@ Welcome to LightGBM's documentation! Features Experiments Parameters + Advanced Topics Parameters Tuning Python API Reference Parallel Learning Guide