- Move most toctree to `:hiden:` so there can be top-level categorizations in the navigation bar.
- Move frontend guide into design and developer guides
- Move get started tutorials into its separate folder.
Co-authored-by: Chris Hoge <chris@hogepodge.com>
Co-authored-by: Chris Hoge <chris@hogepodge.com>
specific language governing permissions and limitations
under the License.
-Links to API References
-=======================
+Links to Other API References
+=============================
This page contains links to API references that are build with different doc build system.
gallery_dirs = ["tutorials", "vta/tutorials"]
subsection_order = ExplicitOrder(
- ['../tutorials/frontend',
+ ['../tutorials/get_started',
+ '../tutorials/frontend',
'../tutorials/language',
'../tutorials/optimize',
'../tutorials/autotvm',
--- /dev/null
+.. 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.
+
+.. _dev-how-to:
+
+Developer How-To Guide
+======================
+This section contains a collection of tips about how to work on
+various areas of the TVM stack.
+
+.. toctree::
+ :maxdepth: 1
+
+ relay_add_op
+ relay_add_pass
+ relay_bring_your_own_codegen
+ codebase_walkthrough
- The `Logical Architecture Components`_ section describes the logical components.
The sections after are specific guides focused on each logical component, organized
by the component's name.
-- The `How Tos`_ section contains useful tutorials to solve specific development problems.
+- Feel free to also checkout the :ref:`dev-how-to` for useful development tips.
This guide provides a few complementary views of the architecture.
First, we review a single end-to-end compilation flow and discuss the key data structures and the transformations.
benchmark
-
-How Tos
--------
-This section contains a collection of tips about how to work on
-various areas of the TVM stack.
+Frontends
+---------
+Frontends ingest models from different frameworks into the TVM stack.
+:py:mod:`tvm.relay.frontend` is the namespace for model ingestion APIs.
.. toctree::
:maxdepth: 1
- relay_add_op
- relay_add_pass
- relay_bring_your_own_codegen
- codebase_walkthrough
+ frontend/tensorflow
Security
TVM Documentation
=================
+TVM is an open deep learning compiler stack for CPUs, GPUs, and specialized accelerators. It aims to close the gap between the productivity-focused deep learning frameworks, and the performance- or efficiency-oriented hardware backends.
+
+
Get Started
-----------
+
+- Follow the :doc:`instructions <install/index>` to install TVM.
+- Checkout the :doc:`Tutorials <tutorials/index>`.
+
+For Developers
+--------------
+
+- :doc:`dev/index` is useful for developers who want to understand the
+ 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: Get Started
+ :hidden:
install/index
+ contribute/index
+
+.. toctree::
+ :maxdepth: 1
+ :caption: Tutorials
+ :hidden:
+
tutorials/index
- vta/index
+
+
+.. toctree::
+ :maxdepth: 1
+ :caption: How-to Guide
+ :hidden:
+
deploy/index
- contribute/index
- faq
-API Reference
--------------
.. toctree::
:maxdepth: 2
+ :caption: References
+ :hidden:
langref/index
api/python/index
api/links
-Developer Guide
----------------
.. toctree::
:maxdepth: 2
+ :hidden:
+ :caption: For Developers
dev/index
+ dev/how_to
-Frontends
----------
.. toctree::
- :maxdepth: 1
+ :maxdepth: 2
+ :hidden:
+ :caption: MISC
+
+ vta/index
+ faq
- frontend/tensorflow
Index
-----
+
.. toctree::
:maxdepth: 1
-Tutorials
-=========
-This page contains the tutorials about TVM.
+
--- /dev/null
+Get Started Tutorials
+---------------------