From bd5639d30d201e939b4a1209b9ae66f58a282441 Mon Sep 17 00:00:00 2001
From: Yifan Zhao <yifanz16@illinois.edu>
Date: Tue, 6 Apr 2021 15:13:25 -0500
Subject: [PATCH] Moved installation under getting-started
---
hpvm/docs/{install.rst => build-hpvm.rst} | 2 +-
hpvm/docs/getting-started.rst | 19 +++++++++++--------
hpvm/docs/index.rst | 4 +++-
3 files changed, 15 insertions(+), 10 deletions(-)
rename hpvm/docs/{install.rst => build-hpvm.rst} (99%)
diff --git a/hpvm/docs/install.rst b/hpvm/docs/build-hpvm.rst
similarity index 99%
rename from hpvm/docs/install.rst
rename to hpvm/docs/build-hpvm.rst
index 192b392765..746453ee98 100644
--- a/hpvm/docs/install.rst
+++ b/hpvm/docs/build-hpvm.rst
@@ -1,4 +1,4 @@
-Install
+Building HPVM
===============
Dependencies
diff --git a/hpvm/docs/getting-started.rst b/hpvm/docs/getting-started.rst
index 2ca06e2da3..2054c46d0a 100644
--- a/hpvm/docs/getting-started.rst
+++ b/hpvm/docs/getting-started.rst
@@ -1,19 +1,22 @@
Getting Started
===============
-This tutorial covers the basic usage of all components in HPVM
-(components listed :doc:`here </components/index>`).
-We will generate a DNN model, VGG16 (for CIFAR10 dataset), into HPVM code, compile it with HPVM,
+This tutorial explains how to build and use HPVM.
+
+* Before you proceed, check out the :doc:`build instruction for HPVM <build-hpvm>`.
+
+To demonstrate the workflow,
+we will generate a DNN model, VGG16 (for CIFAR10 dataset), into HPVM code, compile it with HPVM,
perform autotuning on the compiled binary to find approximation choices (configurations),
and profile the selected configurations to get real performance on device.
The result will be a figure showing the accuracy-performance tradeoff of VGG16 over the
(pre-defined) approximations and the configurations in a few formats.
-Please check ``test/dnn_benchmarks/model_params/`` exists and contains
-``vgg16_cifar10/`` and ``pytorch/vgg16_cifar10.pth.tar``,
-which may not be the case if you opted out of model parameter download in the installer.
-In that case, you may run the installer again to download the parameter.
-It will not rebuild everything from scratch.
+* Please check ``test/dnn_benchmarks/model_params/`` exists and contains
+ ``vgg16_cifar10/`` and ``pytorch/vgg16_cifar10.pth.tar``,
+ which may not be the case if you opted out of model parameter download in the installer.
+ In that case, you may run the installer again to download the parameter.
+ It will not rebuild everything from scratch.
Generating and Compiling a DNN Model
------------------------------------
diff --git a/hpvm/docs/index.rst b/hpvm/docs/index.rst
index 81efa69e13..cd6323bcdd 100644
--- a/hpvm/docs/index.rst
+++ b/hpvm/docs/index.rst
@@ -45,11 +45,13 @@ and experiment with new custom approximation techniques.
Documentation
-------------
+Please refer to :doc:`getting-started` for how to build and use HPVM.
+
.. toctree::
:maxdepth: 1
- install
getting-started
+ build-hpvm
FAQs<faqs>
components/index
specifications/index
--
GitLab