This commit is contained in:
tqchen 2015-07-27 17:47:28 -07:00
parent cbc21ae531
commit fcf0f4351a
3 changed files with 44 additions and 0 deletions

24
doc/README.md Normal file
View File

@ -0,0 +1,24 @@
Rabit Documentation
=====================
rabit is a light weight library that provides a fault tolerant interface of Allreduce and Broadcast. It is designed to support easy implementations of distributed machine learning programs, many of which fall naturally under the Allreduce abstraction. The goal of rabit is to support **portable** , **scalable** and **reliable** distributed machine learning programs.
API Documents
=============
```eval_rst
.. toctree::
:maxdepth: 2
python_api.md
cpp_api.md
parameters.md
guide.md
```
Indices and tables
==================
```eval_rst
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
```

9
doc/cpp_api.md Normal file
View File

@ -0,0 +1,9 @@
C++ Library API of Rabit
========================
This page contains document of Library API of rabit.
```eval_rst
.. toctree::
.. doxygennamespace:: rabit
```

11
doc/python_api.md Normal file
View File

@ -0,0 +1,11 @@
Python API of Rabit
===================
This page contains document of python API of rabit.
```eval_rst
.. toctree::
.. automodule:: rabit
:members:
:show-inheritance:
```