onnxruntime-tvm/docs
Tianqi Chen d4f8d20e20
[RELAY][FRONTEND] Initial MXNet frontend support. (#2163)
2018-11-25 12:54:03 -08:00
..
_static [DOCS] Add logo and tracker to docs (#1064) 2018-03-28 16:35:17 -07:00
api/python [NNVM/TOPI][OP] gather_nd (#2041) 2018-10-31 15:14:01 -07:00
contribute [COMMUNITY] new community guideline (#2077) 2018-11-19 12:26:35 -08:00
deploy [DOCS] Fix C++ example:graph_runtime.cc:151: Check failed: data->ndim == data_out->ndim (2 vs. 1) (#1987) 2018-10-25 09:29:00 -07:00
dev [DOCS]Update debugger in docs.tvm.ai (#1924) 2018-10-18 08:49:20 -07:00
frontend [FRONTEND][TENSORFLOW] Enhancements. (#1923) 2018-11-01 12:30:01 -07:00
install clarify NNVM’s LLVM requirement (#2117) 2018-11-15 20:58:12 -08:00
langref [RELAY][FRONTEND] Initial MXNet frontend support. (#2163) 2018-11-25 12:54:03 -08:00
vta [VTA] pynq v2.1 -> v2.3 (#1945) 2018-10-20 21:55:12 -07:00
.gitignore [DOC] Initial doc system (#88) 2017-04-15 12:37:43 -07:00
Doxyfile [BUILD][DOCS] Migrate VTA CI, test, build, docs 2018-07-11 21:54:39 -07:00
Makefile [BUILD][DOCS] Migrate VTA CI, test, build, docs 2018-07-11 21:54:39 -07:00
README.txt [BUILD][DOCS] Migrate VTA CI, test, build, docs 2018-07-11 21:54:39 -07:00
api_links.rst Add javadoc build into Jenkins workflow (#1909) 2018-10-16 18:48:28 -07:00
conf.py [High level OPT][RFC] NNVMv2 IR - Relay (#1672) 2018-09-19 15:55:12 -07:00
faq.md [DOCS] fix link (#2157) 2018-11-21 23:35:53 -08:00
genindex.rst [DOC] move comments to file header (#91) 2017-04-16 22:03:52 -07:00
index.rst [BUILD][DOCS] Migrate VTA CI, test, build, docs 2018-07-11 21:54:39 -07:00
nnvm_top.rst [NNVM/TOPI][OP] gather_nd (#2041) 2018-10-31 15:14:01 -07:00

README.txt

TVM Documentations
==================
This folder contains the source of TVM documents

- A hosted version of doc is at http://docs.tvm.ai
- pip install sphinx>=1.5.5 sphinx-gallery sphinx_rtd_theme matplotlib Image recommonmark Pillow
- Build tvm first in the root folder.
- To build locally, you need to enable USE_CUDA, USE_OPENCL, LLVM_CONFIG in config.mk and then type "make html" in this folder.

Only Execute Specified Tutorials
--------------------------------
The document build process will execute all the tutorials in the sphinx gallery.
This will cause failure in some cases when certain machines do not have necessary
environment. You can set ```TVM_TUTORIAL_EXEC_PATTERN``` to only execute
the path that matches the regular expression pattern.

For example, to only build tutorials under /vta/tutorials, run

```bash
TVM_TUTORIAL_EXEC_PATTERN=/vta/tutorials make html
```

To only build one specific file, do

```bash
# The slash \ is used to get . in regular expression
TVM_TUTORIAL_EXEC_PATTERN=file_name\.py make html
```