From 4a97485a3cd0d7d82152bf355f0b6b77371e88a7 Mon Sep 17 00:00:00 2001
From: Yifan Zhao <yifanz16@illinois.edu>
Date: Sun, 28 Mar 2021 20:25:24 -0500
Subject: [PATCH] 'References' -> 'Specifications'; also moved some to
developer docs
---
hpvm/docs/components/index.rst | 2 +-
.../compilation-process.rst | 0
hpvm/docs/developerdocs/index.rst | 2 ++
hpvm/docs/developerdocs/port-to-hpvm-c.rst | 30 +++++++++++++++++
hpvm/docs/index.rst | 2 +-
hpvm/docs/references/index.rst | 11 -------
.../hpvm-c-spec.rst} | 32 -------------------
.../hpvm-spec.rst} | 0
hpvm/docs/specifications/index.rst | 10 ++++++
9 files changed, 44 insertions(+), 45 deletions(-)
rename hpvm/docs/{references => developerdocs}/compilation-process.rst (100%)
create mode 100644 hpvm/docs/developerdocs/port-to-hpvm-c.rst
delete mode 100644 hpvm/docs/references/index.rst
rename hpvm/docs/{references/hpvm-c.rst => specifications/hpvm-c-spec.rst} (81%)
rename hpvm/docs/{references/hpvm-specification.rst => specifications/hpvm-spec.rst} (100%)
create mode 100644 hpvm/docs/specifications/index.rst
diff --git a/hpvm/docs/components/index.rst b/hpvm/docs/components/index.rst
index 8f9ab42a8d..d0da3e469d 100644
--- a/hpvm/docs/components/index.rst
+++ b/hpvm/docs/components/index.rst
@@ -7,7 +7,7 @@ HPVM consists of a few relatively independent key components.
* HPVM code generator: a few ``opt`` passes that lowers HPVM IR to LLVM IR,
which is then compiled into object code and binary.
-:doc:`Compilation process of HPVM </references/hpvm-specification>`
+:doc:`Compilation process of HPVM </specifications/hpvm-spec>`
shows how these 2 components work together.
In addition, there are:
diff --git a/hpvm/docs/references/compilation-process.rst b/hpvm/docs/developerdocs/compilation-process.rst
similarity index 100%
rename from hpvm/docs/references/compilation-process.rst
rename to hpvm/docs/developerdocs/compilation-process.rst
diff --git a/hpvm/docs/developerdocs/index.rst b/hpvm/docs/developerdocs/index.rst
index 225fbdfd49..38c8c51419 100644
--- a/hpvm/docs/developerdocs/index.rst
+++ b/hpvm/docs/developerdocs/index.rst
@@ -6,4 +6,6 @@ Developer Documents
approximation-implementation
cnn-models
+ compilation-process
configuration-format
+ port-to-hpvm-c
diff --git a/hpvm/docs/developerdocs/port-to-hpvm-c.rst b/hpvm/docs/developerdocs/port-to-hpvm-c.rst
new file mode 100644
index 0000000000..dbdb900b8a
--- /dev/null
+++ b/hpvm/docs/developerdocs/port-to-hpvm-c.rst
@@ -0,0 +1,30 @@
+Porting a Program from C to HPVM-C
+==================================
+
+The following represents the required steps to port a regular C program into an HPVM program with HPVM-C. These steps are described at a high level; for more detail, please see `hpvm-cava </hpvm/test/benchmarks/hpvm-cava>`_ provided in `benchmarks </hpvm/test/benchmarks>`_.
+
+* Separate the computation that will become a kernel into its own (leaf node) function and add the attributes and target hint.
+* Create a level 1 wrapper node function that will describe the thread-level parallelism (for the GPU). The node will:
+
+ * Use the ``createNode[ND]()`` method to create a kernel node and specify how many threads will execute it.
+ * Bind its arguments to the kernel arguments.
+
+* If desired, create a level 2 wrapper node function which will describe the threadblock-level parallalism (for the GPU). This node will:
+
+ * Use the ``createNode[ND]()`` method to create a level 1 wrapper node and specify how many threadblocks will execute it.
+ * Bind its arguments to its child node's arguments.
+
+* A root node function that creates all the top-level wrapper nodes, binds their arguments, and connects their edges.
+
+ * Each root node represents a DFG.
+
+* All the above node functions have the combined arguments of all the kernels that are nested at each level.
+* The host code will have to include the following:
+
+ * Initialize the HPVM runtime using the ``init()`` method.
+ * Create an argument struct for each DFG and assign its member variables.
+ * Add all the memory that is required by the kernel into the memory tracker.
+ * Launch the DFG by calling the ``launch()`` method on the root node function, and passing the corresponding argument struct.
+ * Wait for the DFG to complete execution.
+ * Read out any generated memory using the ``request_mem()`` method.
+ * Remove all the tracked memory from the memory tracker.
diff --git a/hpvm/docs/index.rst b/hpvm/docs/index.rst
index 8bf0744c50..e964b84b33 100644
--- a/hpvm/docs/index.rst
+++ b/hpvm/docs/index.rst
@@ -52,7 +52,7 @@ Documentation
getting-started
tests
components/index
- references/index
+ specifications/index
developerdocs/index
Indices and tables
diff --git a/hpvm/docs/references/index.rst b/hpvm/docs/references/index.rst
deleted file mode 100644
index e2650fb9e2..0000000000
--- a/hpvm/docs/references/index.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-References
-============
-
-Below are some technical details of HPVM system and the HPVM-C language.
-
-.. toctree::
- :maxdepth: 1
-
- hpvm-c
- hpvm-specification
- compilation-process
diff --git a/hpvm/docs/references/hpvm-c.rst b/hpvm/docs/specifications/hpvm-c-spec.rst
similarity index 81%
rename from hpvm/docs/references/hpvm-c.rst
rename to hpvm/docs/specifications/hpvm-c-spec.rst
index 8956bf0c87..ee2b55a496 100644
--- a/hpvm/docs/references/hpvm-c.rst
+++ b/hpvm/docs/specifications/hpvm-c-spec.rst
@@ -117,35 +117,3 @@ Atomically computes the bitwise XOR of ``v`` and the value stored at memory loca
``void __hpvm__barrier()``:raw-html-m2r:`<br>`
Local synchronization barrier across dynamic instances of current leaf node.
-
-Porting a Program from C to HPVM-C
-==================================
-
-The following represents the required steps to port a regular C program into an HPVM program with HPVM-C. These steps are described at a high level; for more detail, please see `hpvm-cava </hpvm/test/benchmarks/hpvm-cava>`_ provided in `benchmarks </hpvm/test/benchmarks>`_.
-
-
-* Separate the computation that will become a kernel into its own (leaf node) function and add the attributes and target hint.
-* Create a level 1 wrapper node function that will describe the thread-level parallelism (for the GPU). The node will:
-
- * Use the ``createNode[ND]()`` method to create a kernel node and specify how many threads will execute it.
- * Bind its arguments to the kernel arguments.
-
-* If desired, create a level 2 wrapper node function which will describe the threadblock-level parallalism (for the GPU). This node will:
-
- * Use the ``createNode[ND]()`` method to create a level 1 wrapper node and specify how many threadblocks will execute it.
- * Bind its arguments to its child node's arguments.
-
-* A root node function that creates all the top-level wrapper nodes, binds their arguments, and connects their edges.
-
- * Each root node represents a DFG.
-
-* All the above node functions have the combined arguments of all the kernels that are nested at each level.
-* The host code will have to include the following:
-
- * Initialize the HPVM runtime using the ``init()`` method.
- * Create an argument struct for each DFG and assign its member variables.
- * Add all the memory that is required by the kernel into the memory tracker.
- * Launch the DFG by calling the ``launch()`` method on the root node function, and passing the corresponding argument struct.
- * Wait for the DFG to complete execution.
- * Read out any generated memory using the ``request_mem()`` method.
- * Remove all the tracked memory from the memory tracker.
diff --git a/hpvm/docs/references/hpvm-specification.rst b/hpvm/docs/specifications/hpvm-spec.rst
similarity index 100%
rename from hpvm/docs/references/hpvm-specification.rst
rename to hpvm/docs/specifications/hpvm-spec.rst
diff --git a/hpvm/docs/specifications/index.rst b/hpvm/docs/specifications/index.rst
new file mode 100644
index 0000000000..bcd6199fc9
--- /dev/null
+++ b/hpvm/docs/specifications/index.rst
@@ -0,0 +1,10 @@
+Specifications
+==============
+
+Below are the specifications of HPVM Graph Abstraction and the HPVM-C language.
+
+.. toctree::
+ :maxdepth: 1
+
+ hpvm-spec
+ hpvm-c-spec
--
GitLab