Unverified Commit fac4afe0 authored by Nikita Titov's avatar Nikita Titov Committed by GitHub
Browse files

[docs] Added permalink to each param (#1498)

* added permalink to each parameter

* run parameter_generator.py

* concretized links

* hotfix

* run parameter_generator.py

* added space between param name and permalink

* added info about initscore_filename in Continued Training section and edited links

* replaced aliases for weight and group with original names

* disable emoji
parent 9187c75f
......@@ -201,9 +201,9 @@ LightGBM supports the following metrics:
- MAP
- Multi class log loss
- Multi-class log loss
- Multi class error rate
- Multi-class error rate
- Fair
......
This diff is collapsed.
......@@ -37,8 +37,8 @@ For the setting details, please refer to `Parameters <./Parameters.rst>`__.
Weight and Query/Group Data
~~~~~~~~~~~~~~~~~~~~~~~~~~~
LightGBM also supports weighted training, it needs an additional `weight data <./Parameters.rst#io-parameters>`__.
And it needs an additional `query data <./Parameters.rst#io-parameters>`_ for ranking task.
LightGBM also supports weighted training, it needs an additional `weight data <./Parameters.rst#weight-data>`__.
And it needs an additional `query data <./Parameters.rst#query-data>`_ for ranking task.
Also, weight and query data could be specified as columns in training data in the same manner as label.
......
......@@ -147,7 +147,7 @@ def GenParameterDescription(sections, descriptions, params_rst):
checks_str = ', constraints: ``{0} {1} {2}``'.format(name, sign, number)
else:
checks_str = ''
main_desc = '- ``{0}``, default = ``{1}``, type = {2}{3}{4}{5}'.format(name, default, param_type, options_str, aliases_str, checks_str)
main_desc = '- ``{0}`` :raw-html:`<a id="{0}" title="Permalink to this parameter" href="#{0}">&#x1F517;&#xFE0E;</a>`, default = ``{1}``, type = {2}{3}{4}{5}'.format(name, default, param_type, options_str, aliases_str, checks_str)
params_to_write.append(main_desc)
params_to_write.extend([' ' * 3 * int(desc[0][-1]) + '- ' + desc[1] for desc in param_desc['desc']])
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment