[WIP][POC] Proof of concept for documentation refactor.

docs/conf.py

@@ -197,11 +197,43 @@ def git_describe_version(original_version):
 
 from sphinx_gallery.sorting import ExplicitOrder
 
-examples_dirs = ["../tutorials/", "../vta/tutorials/"]
-gallery_dirs = ["tutorials", "vta/tutorials"]
+# This variable specifices where splinx gallery should look
+# for gallery files.
+examples_dirs = ["../gallery/user_tutorial",
+        "../gallery/user_how_tos/compile_models",
+        "../gallery/user_how_tos/deploy_models",
+        "../gallery/user_how_tos/work_with_relay",
+        "../gallery/user_how_tos/work_with_te_schedules",
+        "../gallery/user_how_tos/optimize_tensor_operators",
+        "../gallery/user_how_tos/tune_with_templates_autotvm",
+        "../gallery/user_how_tos/tune_with_autoscheduler",
+        "../gallery/user_how_tos/work_with_microtvm",
+        "../gallery/dev_how_tos",
+        "../tutorials/",
+        "../vta/tutorials/"]
+
+# This variable specifies where sphinx gallery should place
+# output from gallery generation, relative to the top level
+# docd directory. The output will be mapped as an ordered
+# tuple to the example_dirs. For example, the output
+# from ../gallery/user_tutorials will be rendered
+# in tvm/docs/user_tutorials.
+gallery_dirs = ["user_tutorial",
+        "user_how_tos/compile_models",
+        "user_how_tos/deploy_models",
+        "user_how_tos/work_with_relay",
+        "user_how_tos/work_with_te_schedules",
+        "user_how_tos/optimize_tensor_operators",
+        "user_how_tos/tune_with_templates_autotvm",
+        "user_how_tos/tune_with_autoscheduler",
+        "user_how_tos/work_with_microtvm",
+        "dev_how_tos",
+        "tutorials",
+        "vta/tutorials"]
 
 subsection_order = ExplicitOrder(
     [
+        "../gallery/user_tutorial",
         "../tutorials/get_started",
         "../tutorials/frontend",
         "../tutorials/language",
@@ -223,7 +255,7 @@ def git_describe_version(original_version):
 # The unlisted files are sorted by filenames.
 # The unlisted files always appear after listed files.
 within_subsection_order = {
-    "get_started": [
+    "user_tutorial": [
         "introduction.py",
         "install.py",
         "tvmc_command_line_driver.py",
@@ -232,9 +264,10 @@ def git_describe_version(original_version):
         "autotvm_matmul_x86.py",
         "auto_scheduler_matmul_x86.py",
         "cross_compilation_and_rpc.py",
-        "relay_quick_start.py",
+        "intro_topi.py",
+        "relay_quick_start.py"
     ],
-    "frontend": [
+    "compile_models": [
         "from_pytorch.py",
         "from_tensorflow.py",
         "from_mxnet.py",
@@ -245,7 +278,17 @@ def git_describe_version(original_version):
         "from_darknet.py",
         "from_caffe2.py",
     ],
-    "language": [
+    "deploy_models": [
+        "deploy_object_detection_pytorch.py",
+        "deploy_model_on_rasp.py",
+        "deploy_sparse.py",
+        "deploy_quantized.py",
+        "deploy_prequantized.py",
+        "deploy_prequantized_tflite.py",
+        "deploy_model_on_android.py",
+        "deploy_ssd_gluoncv.py"
+    ],
+    "work_with_te_schedules": [
         "schedule_primitives.py",
         "reduction.py",
         "intrin_math.py",
@@ -255,26 +298,26 @@ def git_describe_version(original_version):
         "tuple_inputs.py",
         "tedd.py",
     ],
-    "optimize": [
+    "optimize_tensor_operators": [
         "opt_gemm.py",
         "opt_conv_cuda.py",
         "opt_conv_tensorcore.py",
     ],
-    "autotvm": [
+    "tune_with_templates_autotvm": [
         "tune_simple_template.py",
         "tune_conv2d_cuda.py",
         "tune_relay_cuda.py",
         "tune_relay_x86.py",
         "tune_relay_arm.py",
         "tune_relay_mobile_gpu.py",
     ],
-    "auto_scheduler": [
+    "tune_with_autoscheduler": [
         "tune_matmul_x86.py",
         "tune_conv2d_layer_cuda.py",
         "tune_network_x86.py",
         "tune_network_cuda.py",
     ],
-    "dev": [
+    "dev_how_tos": [
         "low_level_custom_pass.py",
         "use_pass_infra.py",
         "use_pass_instrument.py",

docs/dev_deep_dive/index.rst

@@ -0,0 +1,25 @@
+..  Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+..    http://www.apache.org/licenses/LICENSE-2.0
+
+..  Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+.. _deep_dive:
+
+Deep Dive
+=========
+TVM Developer Deep Dives
+
+Refactor placeholder
+

docs/dev_how_tos/index.rst

@@ -0,0 +1,104 @@
+:orphan:
+
+
+
+.. _sphx_glr_dev_how_tos:
+
+How To
+------
+This gallery includes a number of how-tos on how to accomplish common
+develpment tasks in TVM.
+
+
+
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbcontainer" tooltip="TVM is a framework that abstracts away the heterogenity of machine learning accelerators. Somet...">
+
+.. only:: html
+
+    .. figure:: /dev_how_tos/images/thumb/sphx_glr_low_level_custom_pass_thumb.png
+
+        :ref:`sphx_glr_dev_how_tos_low_level_custom_pass.py`
+
+.. raw:: html
+
+    </div>
+
+
+.. toctree::
+   :hidden:
+
+   /dev_how_tos/low_level_custom_pass
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbcontainer" tooltip="As the number of optimization passes increases in Relay/tir, it becomes intractable to execute ...">
+
+.. only:: html
+
+    .. figure:: /dev_how_tos/images/thumb/sphx_glr_use_pass_infra_thumb.png
+
+        :ref:`sphx_glr_dev_how_tos_use_pass_infra.py`
+
+.. raw:: html
+
+    </div>
+
+
+.. toctree::
+   :hidden:
+
+   /dev_how_tos/use_pass_infra
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbcontainer" tooltip="As more and more passes are implemented, it becomes useful to instrument pass execution, analyz...">
+
+.. only:: html
+
+    .. figure:: /dev_how_tos/images/thumb/sphx_glr_use_pass_instrument_thumb.png
+
+        :ref:`sphx_glr_dev_how_tos_use_pass_instrument.py`
+
+.. raw:: html
+
+    </div>
+
+
+.. toctree::
+   :hidden:
+
+   /dev_how_tos/use_pass_instrument
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbcontainer" tooltip="In this tutorial, we will show you how to utilize the Bring Your Own Datatypes framework to use...">
+
+.. only:: html
+
+    .. figure:: /dev_how_tos/images/thumb/sphx_glr_bring_your_own_datatypes_thumb.png
+
+        :ref:`sphx_glr_dev_how_tos_bring_your_own_datatypes.py`
+
+.. raw:: html
+
+    </div>
+
+
+.. toctree::
+   :hidden:
+
+   /dev_how_tos/bring_your_own_datatypes
+.. raw:: html
+
+    <div style='clear:both'></div>
+
+
+
+.. only:: html
+
+ .. rst-class:: sphx-glr-signature
+
+    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_

docs/dev_reference/index.rst

@@ -0,0 +1,24 @@
+..  Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+..    http://www.apache.org/licenses/LICENSE-2.0
+
+..  Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+.. _reference:
+
+Reference
+=========
+TVM Developer Reference
+
+Placeholder for docs refactor

docs/contribute/index.rst → docs/dev_tutorial/index.rst

@@ -15,8 +15,8 @@
     specific language governing permissions and limitations
     under the License.
 
-Contribute to TVM
-=================
+Tutorial: Contributing to TVM
+=============================
 
 TVM has been developed by community members.
 Everyone is welcomed to contribute.

docs/index.rst

@@ -34,57 +34,30 @@ For Developers
   architecture of TVM and/or actively develop on the project.
 - :doc:`dev/how_to` gives quick development tips on various topics.
 
-
-.. toctree::
-   :maxdepth: 1
-   :caption: How to
-   :hidden:
-
-   install/index
-   contribute/index
-   deploy/index
-   dev/how_to
-   microtvm/index
-   errors
-   faq
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Tutorials
-   :hidden:
-
-   tutorials/index
-
-
 .. toctree::
-   :maxdepth: 2
-   :caption: References
+   :maxdepth: 3
+   :caption: TVM User Guide
    :hidden:
 
-   langref/index
-   api/python/index
-   api/links
+   user_tutorial/index
+   user_how_tos/index
+   user_deep_dive/index
+   user_reference/index
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
+   :caption: TVM Developer Guide
    :hidden:
-   :caption: Deep Dive
-
-   dev/index
-
-.. toctree::
-   :maxdepth: 2
-   :hidden:
-   :caption: MISC
-
-   vta/index
-   profiling/index
 
+   dev_tutorial/index
+   dev_how_tos/index
+   dev_deep_dive/index
+   dev_reference/index
 
 Index
 -----
-
 .. toctree::
    :maxdepth: 1
+   :caption: Index
 
    genindex

docs/user_deep_dive/index.rst

@@ -0,0 +1,24 @@
+..  Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+..    http://www.apache.org/licenses/LICENSE-2.0
+
+..  Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+.. _user_guide:
+
+Deep Dive
+=========
+TVM User Deep Dives
+
+refactor placeholder until content is in place