Hendrik/xgboost
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
xgboost/doc
History
Philip Cho 953ed1a99b
Update Python API doc (#3619) 
* Show inherited members of XGBRegressor in API doc, since XGBRegressor uses default methods from XGBModel

* Add table of contents to Python API doc

* Skip JVM doc download if not available

* Show inherited members for XGBRegressor

* Add docstring to XGBRegressor.predict()

* Fix rendering errors in Python docstrings

* Fix lint
2018-09-05 12:15:23 -07:00
..
_static
Doc modernization (#3474)
2018-08-13 00:25:54 -07:00
get_started
fixed some typos (#1814)
2016-11-25 16:34:57 -05:00
gpu
Doc modernization (#3474)
2018-08-13 00:25:54 -07:00
how_to
Doc modernization (#3474)
2018-08-13 00:25:54 -07:00
jvm
Adding JVM doc build to Jenkins CI
2018-08-13 00:26:01 -07:00
python
Update Python API doc (#3619)
2018-09-05 12:15:23 -07:00
R-package
Doc modernization (#3474)
2018-08-13 00:25:54 -07:00
tutorials
Remove errant $ (#3618)
2018-09-05 12:10:28 -07:00
.gitignore
[DOC] Update R doc
2016-01-16 11:52:33 -08:00
build.md
Condense MinGW installation instruction (#3201)
2018-03-25 03:05:11 -07:00
build.rst
Doc modernization (#3474)
2018-08-13 00:25:54 -07:00
cli.rst
Doc modernization (#3474)
2018-08-13 00:25:54 -07:00
conf.py
Update Python API doc (#3619)
2018-09-05 12:15:23 -07:00
contribute.rst
Doc modernization (#3474)
2018-08-13 00:25:54 -07:00
Doxyfile
[TRAVIS] cleanup travis script
2016-01-16 10:25:12 -08:00
faq.rst
Backport doc fixes that are compatible with 0.72 release
2018-08-13 00:26:01 -07:00
get_started.rst
Doc modernization (#3474)
2018-08-13 00:25:54 -07:00
index.rst
Doc modernization (#3474)
2018-08-13 00:25:54 -07:00
input_format.md
fixed some typos (#1814)
2016-11-25 16:34:57 -05:00
julia.rst
Doc modernization (#3474)
2018-08-13 00:25:54 -07:00
Makefile
enable basic sphinx doc
2015-08-01 11:27:13 -07:00
parameter.md
Refactor linear modelling and add new coordinate descent updater (#3103)
2018-02-17 09:17:01 +13:00
parameter.rst
Fix #3609: Removed unused parameter 'use_buffer' (#3610)
2018-09-05 12:10:15 -07:00
README
Fix doc build (#3126)
2018-02-21 16:57:30 -08:00
requirements.txt
Adding JVM doc build to Jenkins CI
2018-08-13 00:26:01 -07:00
sphinx_util.py
Doc modernization (#3474)
2018-08-13 00:25:54 -07:00

README 

The documentation of xgboost is generated with recommonmark and sphinx.

You can build it locally by typing "make html" in this folder.

Checkout https://recommonmark.readthedocs.org for guide on how to write markdown with extensions used in this doc, such as math formulas and table of content.