From 73e6274a29c58bb9e253bcb4ebcb47ae47740ce4 Mon Sep 17 00:00:00 2001 From: Tianqi Chen Date: Thu, 5 Oct 2017 16:22:00 -0700 Subject: [PATCH] [DOCS] update docs (#67) --- README.md | 14 ++++++++++++-- docs/index.rst | 6 +++--- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1a33568c863d..9c770d42b9c3 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ # NNVM: Open Compiler for AI Frameworks - [![Build Status](https://travis-ci.org/dmlc/nnvm.svg?branch=master)](https://travis-ci.org/dmlc/nnvm) [![GitHub license](http://dmlc.github.io/img/apache2.svg)](./LICENSE) +[Installation](docs/how_to/install.md) | +[Documentation](http://nnvm.tvmlang.org) | +[Tutorials](http://nnvm.tvmlang.org/tutorials/index.html) | +[Release Notes](NEWS.md) + NNVM compiler offers reusable computation graph optimization and compilation for deep learning systems. It is backed by the [TVM stack](http://tvmlang.org) and provides modules to: @@ -49,6 +53,12 @@ rmodule.set_input(**params) rmodule.run() ``` -## Links +License +------- +Licensed under an [Apache-2.0](https://github.com/dmlc/tvm/blob/master/LICENSE) license. + + +Links +----- - [TinyFlow](https://github.com/tqchen/tinyflow) on how you can use NNVM to build a TensorFlow like API. - [Apache MXNet](http://mxnet.io/) uses NNVM as a backend. diff --git a/docs/index.rst b/docs/index.rst index df61dca776f8..939c46b45bb4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,6 @@ NNVM Documentation ================== - +This is a document about NNVM and NNVM compiler. Contents -------- @@ -9,11 +9,11 @@ Contents :maxdepth: 1 self - top how_to/install tutorials/index + top + json_spec how_to/contribute how_to/deploy - json_spec api/python/index dev/index