From 89f8981729b8e6ef18fe06df943699d9cacb7c51 Mon Sep 17 00:00:00 2001
From: Yifan Zhao <yifanz16@illinois.edu>
Date: Sat, 3 Apr 2021 22:38:34 -0500
Subject: [PATCH] Tuck 'tests and benchmarks' under components
---
hpvm/docs/components/index.rst | 13 +++++++++++++
hpvm/docs/components/tests.rst | 1 +
hpvm/docs/index.rst | 1 -
hpvm/docs/install.rst | 8 ++++----
hpvm/docs/tests.rst | 1 -
5 files changed, 18 insertions(+), 6 deletions(-)
create mode 120000 hpvm/docs/components/tests.rst
delete mode 120000 hpvm/docs/tests.rst
diff --git a/hpvm/docs/components/index.rst b/hpvm/docs/components/index.rst
index d0da3e469d..ccafd09082 100644
--- a/hpvm/docs/components/index.rst
+++ b/hpvm/docs/components/index.rst
@@ -31,3 +31,16 @@ which explains their role, usage, and other details.
torch2hpvm
predtuner
hpvm-profiler
+
+
+Tests and Benchmarks
+--------------------
+
+HPVM provides a number of general benchmarks (written in HPVM-C), DNN benchmarks,
+and test cases testing the components listed above.
+See this for more details on these tests and benchmarks:
+
+.. toctree::
+ :maxdepth: 1
+
+ tests
diff --git a/hpvm/docs/components/tests.rst b/hpvm/docs/components/tests.rst
new file mode 120000
index 0000000000..e1a7aca464
--- /dev/null
+++ b/hpvm/docs/components/tests.rst
@@ -0,0 +1 @@
+../../test/README.rst
\ No newline at end of file
diff --git a/hpvm/docs/index.rst b/hpvm/docs/index.rst
index 70817d4bef..04e589bc1a 100644
--- a/hpvm/docs/index.rst
+++ b/hpvm/docs/index.rst
@@ -50,7 +50,6 @@ Documentation
install
getting-started
- tests
components/index
specifications/index
developerdocs/index
diff --git a/hpvm/docs/install.rst b/hpvm/docs/install.rst
index 07de74e4c5..e13b30450b 100644
--- a/hpvm/docs/install.rst
+++ b/hpvm/docs/install.rst
@@ -177,17 +177,17 @@ Now, compile the HPVM Compilation Tool ``hpvm-clang`` using:
With all the aforementioned steps, HPVM should be built, installed, tested and ready to use.
In particular, ``hpvm-clang`` should be an executable command from your command line.
-Benchmarks and Tests
+Tests and Benchmarks
--------------------
We provide a number of general benchmarks, DNN benchmarks, and test cases, written in HPVM.
-``make`` targets ``check-hpvm-pass``, ``check-hpvm-dnn``, and ``check-hpvm-profiler``
-tests various components of HPVM and are increasingly time-consuming.
+``make`` targets ``check-hpvm-pass``, ``check-hpvm-dnn``, ``check-hpvm-profiler``,
+and others tests various components of HPVM.
You can run tests similarly as how ``hpvm-clang`` is compiled: for example,
.. code-block:: shell
make -j<number of threads> check-hpvm-pass
-runs ``check-hpvm-pass`` tests. See :doc:`/tests` for details on benchmarks and test cases.
+runs ``check-hpvm-pass`` tests. See :doc:`/components/tests` for details on benchmarks and test cases.
diff --git a/hpvm/docs/tests.rst b/hpvm/docs/tests.rst
deleted file mode 120000
index 729ecaa5ca..0000000000
--- a/hpvm/docs/tests.rst
+++ /dev/null
@@ -1 +0,0 @@
-../test/README.rst
\ No newline at end of file
--
GitLab