Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Introduce how to add hardware backend to FAQ #4898

Merged
merged 1 commit into from
Feb 17, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/python/target.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ tvm.target
----------
.. automodule:: tvm.target
:members:
:imported-members:
:imported-members:
2 changes: 2 additions & 0 deletions docs/dev/relay_bring_your_own_codegen.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
specific language governing permissions and limitations
under the License.

.. _relay-bring-your-own-codegen:

=============================
Bring Your Own Codegen To TVM
=============================
Expand Down
49 changes: 0 additions & 49 deletions docs/faq.md

This file was deleted.

64 changes: 64 additions & 0 deletions docs/faq.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
.. 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.


Frequently Asked Questions
==========================


How to Install
--------------
See :ref:`installation`.


How to add a new Hardware Backend
---------------------------------

- If the hardware backend has LLVM support,
then we can directly generate the code by setting the correct target triple as in :py:mod:`~tvm.target`.
- If the target hardware is a GPU, try to use the cuda, opencl or vulkan backend.
- If the target hardware is a special accelerator,
checkout :ref:`vta-index` and :ref:`relay-bring-your-own-codegen`.
- For all of the above cases, You may want to add target specific
optimization templates using AutoTVM, see :ref:`tutorials-autotvm-sec`.
- Besides using LLVM's vectorization, we can also embed micro-kernels to leverage hardware intrinsics,
see :ref:`tutorials-tensorize`.


TVM's relation to Other IR/DSL Projects
---------------------------------------
There are usually two levels of abstractions of IR in the deep learning systems.
TensorFlow's XLA and Intel's ngraph both use a computation graph representation.
This representation is high level, and can be helpful to perform generic optimizations
such as memory reuse, layout transformation and automatic differentiation.

TVM adopts a low-level representation, that explicitly express the choice of memory
layout, parallelization pattern, locality and hardware primitives etc.
This level of IR is closer to directly target hardwares.
The low-level IR adopts ideas from existing image processing languages like Halide, darkroom
and loop transformation tools like loopy and polyhedra-based analysis.
We specifically focus on expressing deep learning workloads (e.g. recurrence),
optimization for different hardware backends and embedding with frameworks to provide
end-to-end compilation stack.


TVM's relation to libDNN, cuDNN
-------------------------------
TVM can incorporate these libraries as external calls. One goal of TVM is to be able to
generate high-performing kernels. We will evolve TVM an incremental manner as
we learn from the techniques of manual kernel crafting and add these as primitives in DSL.
See also top for recipes of operators in TVM.
2 changes: 2 additions & 0 deletions docs/install/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
specific language governing permissions and limitations
under the License.

.. _installation:

Installation
============
To install TVM, please read :ref:`install-from-source`.
Expand Down
4 changes: 3 additions & 1 deletion docs/vta/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
specific language governing permissions and limitations
under the License.

.. _vta-index:

VTA: Deep Learning Accelerator Stack
====================================

Expand Down Expand Up @@ -50,4 +52,4 @@ Literature
- Read the VTA tech report: `An Open Hardware Software Stack for Deep Learning`_.

.. _release blog post: https://tvm.apache.org/2018/07/12/vta-release-announcement
.. _An Open Hardware Software Stack for Deep Learning: https://arxiv.org/abs/1807.04188
.. _An Open Hardware Software Stack for Deep Learning: https://arxiv.org/abs/1807.04188
5 changes: 3 additions & 2 deletions tutorials/autotvm/README.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Auto tuning
-------------
.. _tutorials-autotvm-sec:

Auto tuning
-----------
2 changes: 2 additions & 0 deletions tutorials/language/tensorize.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
# specific language governing permissions and limitations
# under the License.
"""
.. _tutorials-tensorize:

Use Tensorize to Leverage Hardware Intrinsics
=============================================
**Author**: `Yizhi Liu <https://github.com/yzhliu>`_
Expand Down