Chris Hoge
44549e6234
* Documentation Refactor - Stage 1 RFC: https://github.com/apache/tvm-rfcs/blob/main/rfcs/0027-formalize-documentation-organization.md Tracking Issue: https://github.com/apache/tvm/issues/8987 Stage 1 of the documentation refactor reorganizes the docs structure, moving files (without content changes) and adding new scaffolding to generate the proper document tree. It does not address naming, style, content, links, or other existing content in documents that were moved. State 2 will address fixing these issues with existing content. Major changes include but are not limited to: * Dividing the existing tutorials into two sections: * Tutorials * How Tos * Moving all of the existing tutorials out of the `/tutorial` directory and into the more general `/gallery` directory. * Breaking up how-tos into individual sections for more flexibility and more consistent rendering. * Moving content into new classifications: * `/docs/arch` for architecture guides * `/docs/reference` for API guides and other reference material * `/docs/topic` for topic specific guides such as microTVM and VTA * Restructuring `/docs/dev` * Adding a table of contents to the doc index * Adding instructions on how to install using third-party tlcpack * Documentation Refactor - Stage 2 RFC: https://github.com/apache/tvm-rfcs/blob/main/rfcs/0027-formalize-documentation-organization.md Tracking Issue: https://github.com/apache/tvm/issues/8987 Stage 2 of the documentation refactor fixes naming and links in the documentation to be consistent with the overall structure. Major changes include: * an update to how to contribute to docs. * several updated index pages with title changes to match the organization style and bring consistency to the sections * expanded descriptions of some page collections * fixed links * Documentation Refactor - Stage 3 RFC: https://github.com/apache/tvm-rfcs/blob/main/rfcs/0027-formalize-documentation-organization.md Tracking Issue: https://github.com/apache/tvm/issues/8987 Stage 3 of the documentation refactor adjusts CI for the new structure. The CI build script takes into account the new gallery format. It also prevents deleting existing documents, and takes advantage of the `_staging` and `_build` directories to clean out previous builds.
73 lines
3.0 KiB
ReStructuredText
73 lines
3.0 KiB
ReStructuredText
.. 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.
|
|
|
|
|
|
Handle TVM Errors
|
|
=================
|
|
|
|
When running TVM, you may encounter an error message like:
|
|
|
|
.. code::
|
|
|
|
---------------------------------------------------------------
|
|
An error occurred during the execution of TVM.
|
|
For more information, please see: https://tvm.apache.org/docs/errors.html
|
|
---------------------------------------------------------------
|
|
|
|
Congratulations! You found this page. Below are some hints on how to interpret
|
|
these error messages and what you can do when they occur.
|
|
|
|
Where do these errors come from?
|
|
--------------------------------
|
|
|
|
This error is caused by an internal invariant being violated during TVM's
|
|
execution. On a technical level, the message is generated by the
|
|
``ICHECK`` macro, found in ``include/tvm/runtime/logging.h``.
|
|
The ``ICHECK`` macro is used in many places in the TVM code to assert
|
|
some condition is true during execution; any time the assertion fails, TVM
|
|
will exit with the error message shown above.
|
|
|
|
For more details about how errors are handled and generated by TVM, please
|
|
see `error-handling-guide`.
|
|
|
|
What should I do when I encounter such an error?
|
|
------------------------------------------------
|
|
|
|
First of all, *don't panic*. Well, you can panic, but it won't help.
|
|
|
|
The best course of action is to search the
|
|
`Apache TVM Discuss Forum <https://discuss.tvm.apache.org/>`_
|
|
for the error you are encountering, to see if this has been a problem
|
|
that others have encountered, and what the solution might be.
|
|
If this error is the result of a bug that has been fixed in a more
|
|
recent version of TVM, you may need to update to a newer version.
|
|
|
|
If you do not find an existing Discuss Forum thread about your
|
|
issue, you are welcome to start a new thread on the forum with details
|
|
on the problem. *Please* include in your posting the following key
|
|
pieces of information:
|
|
|
|
* The version of TVM you are using (e.g., the git commit hash of your source tree).
|
|
* Which hardware and operating system version you are running TVM on.
|
|
* Which hardware device and OS you are targeting for your TVM compilation.
|
|
* Details on the model, inputs, or other information about the workload, which can
|
|
be used to reproduce your problem.
|
|
|
|
Without these details it is very difficult for the TVM developers to do very
|
|
much to help you.
|
|
|