Hendrik/xgboost
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
xgboost/doc
History
Philip Hyunsu Cho 4ed8a88240
Update Python API doc (#3619) 
* Add XGBRanker to Python API doc

* 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 and XGBRanker

* Expose XGBRanker to Python XGBoost module directory

* Add docstring to XGBRegressor.predict() and XGBRanker.predict()

* Fix rendering errors in Python docstrings

* Fix lint
2018-08-22 18:59:30 -07:00
..
_static
Doc modernization (#3474)
2018-07-19 14:22:16 -07:00
gpu
Clarify multi-GPU training, binary wheels, Pandas integration (#3581)
2018-08-11 19:21:28 -07:00
jvm
Update Python API doc (#3619)
2018-08-22 18:59:30 -07:00
python
Update Python API doc (#3619)
2018-08-22 18:59:30 -07:00
R-package
replace nround with nrounds to match actual parameter (#3592)
2018-08-15 11:13:53 -07:00
tutorials
Remove errant $ (#3618)
2018-08-21 12:32:38 -07:00
.gitignore
[DOC] Update R doc
2016-01-16 11:52:33 -08:00
build.rst
Clarify multi-GPU training, binary wheels, Pandas integration (#3581)
2018-08-11 19:21:28 -07:00
cli.rst
Doc modernization (#3474)
2018-07-19 14:22:16 -07:00
conf.py
Update Python API doc (#3619)
2018-08-22 18:59:30 -07:00
contribute.rst
Add travis sanitizers tests. (#3557)
2018-08-19 16:40:30 +12:00
Doxyfile
[TRAVIS] cleanup travis script
2016-01-16 10:25:12 -08:00
faq.rst
Update faq.rst (#3521)
2018-07-28 10:34:14 -07:00
get_started.rst
replace nround with nrounds to match actual parameter (#3592)
2018-08-15 11:13:53 -07:00
index.rst
Doc modernization (#3474)
2018-07-19 14:22:16 -07:00
julia.rst
Doc modernization (#3474)
2018-07-19 14:22:16 -07:00
Makefile
enable basic sphinx doc
2015-08-01 11:27:13 -07:00
parameter.rst
Fix #3609: Removed unused parameter 'use_buffer' (#3610)
2018-08-21 07:54:15 -07:00
README
Fix doc build (#3126)
2018-02-21 16:57:30 -08:00
requirements.txt
[BLOCKING] Adding JVM doc build to Jenkins CI (#3567)
2018-08-09 13:27:01 -07:00
sphinx_util.py
Doc modernization (#3474)
2018-07-19 14:22:16 -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.