From 4e97e6d893d398cb79c656dd069514ee757e2b5e Mon Sep 17 00:00:00 2001 From: Jincheng Chen Date: Tue, 16 Nov 2021 07:42:58 +0000 Subject: [PATCH] add doc links to get started --- README.md | 6 ++++-- docs/Customized-Parser-Tutorial.rst | 2 +- docs/Transform-Tutorial.rst | 4 ++-- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f9e9f94..963078d 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,10 @@ In the repo, user could learn about: ## Get Started and Documentation -- [Customized parser tutorial](./docs/Customized-Parser-Tutorial.rst). -- [Transform tutorial](./docs/Transform-Tutorial.rst). +- [Installation guide](./docs/Installation-Guide.rst) +- [Customized parser tutorial](./docs/Customized-Parser-Tutorial.rst) +- [Transform tutorial](./docs/Transform-Tutorial.rst) +- [FreeForm2 language spec](./docs/FreeForm2-Language.rst) ## Contributing diff --git a/docs/Customized-Parser-Tutorial.rst b/docs/Customized-Parser-Tutorial.rst index da309be..72a5e9b 100644 --- a/docs/Customized-Parser-Tutorial.rst +++ b/docs/Customized-Parser-Tutorial.rst @@ -10,4 +10,4 @@ The basic methodology is to register custom parser to parser factory via reflect - See `Installation Guide <./Installation-Guide.rst>`__ for dependencies and your parser installation. -- See `Transform tutorial <./Transform-tutorial.rst>`__ for how to use LightGBM integrated with your parser version. +- See `Transform tutorial <./Transform-Tutorial.rst>`__ for how to use LightGBM integrated with your parser version. diff --git a/docs/Transform-Tutorial.rst b/docs/Transform-Tutorial.rst index 4a2e270..90e8e8c 100644 --- a/docs/Transform-Tutorial.rst +++ b/docs/Transform-Tutorial.rst @@ -1,7 +1,7 @@ LightGBM Transform Tutorial =========================== -The purpose of this document is to give you a tutorial on how to do transformation in LightGBM with `FreeForm2Parser <./examples/freeform2_parser.cpp>`__. +The purpose of this document is to give you a tutorial on how to do transformation in LightGBM with `FreeForm2Parser <../examples/freeform2_parser.cpp>`__. Transformation is a process to convert data/feature from one format to another. Now we support two kinds of transformations in LightGBM: @@ -42,7 +42,7 @@ Data preparation **Note**: transform value is the content of transform file. Transform file is not a supplement of raw features, but all used for training. Use "Linear" type if you want to keep the original ones. - See `FreeForm2 language spec <./FreeForm2-Language>`__ and learn more about the grammar. + See `FreeForm2 language spec <./FreeForm2-Language.rst>`__ and learn more about the grammar. **Note**: transformed feature index ranges from 0 to the maximum "Input" value given in transform file. By default, will pad 0 as feature value for missing indices within the range.