From 61f21859d943ba413a35f9239b86dc982ce309ab Mon Sep 17 00:00:00 2001 From: tqchen Date: Thu, 1 Jan 2015 05:57:46 -0800 Subject: [PATCH] add api --- README.md | 4 +++- guide/README.md | 4 ++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0517473a5..2834bfd22 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,9 @@ 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. -* See the [package interface file](include/rabit.h) +* [Guide Tutorial of Rabit](guide) +* [API Documentation](http://home.cs.washington.edu/~tqchen/rabit/doc) +* You can also directly read the [interface header](include/rabit.h) Features ==== diff --git a/guide/README.md b/guide/README.md index 311681aac..0166521f7 100644 --- a/guide/README.md +++ b/guide/README.md @@ -3,12 +3,16 @@ Tutorial of Rabit This is an tutorial of rabit, a ***Reliable Allreduce and Broadcast interface***. To run the examples locally, you will need to type ```make``` to build all the examples. +Please also refer to the [API Documentation](http://home.cs.washington.edu/~tqchen/rabit/doc) + + **List of Topics** * [What is Allreduce](#what-is-allreduce) * [Common Use Case](#common-use-case) * [Structure of Rabit Program](#structure-of-rabit-program) * [Fault Tolerance](#fault-tolerance) + What is Allreduce ===== The main method provided by rabit are Allreduce and Broadcast. Allreduce performs reduction across different computation nodes,