This is an automated email from the ASF dual-hosted git repository. tlopex pushed a commit to branch docs/programming-guide-overview in repository https://gitbox.apache.org/repos/asf/tvm-tirx.git
commit e270b161cbe61b5676ef77acfa5c52e6dab3de09 Author: tlopex <[email protected]> AuthorDate: Wed Oct 21 21:25:47 2026 -0400 [DOCS] Add project introduction and programming guide overview --- README.md | 13 +++++++++++++ docs/index.rst | 6 ++++++ docs/user/index.rst | 36 ++++++++++++++++++++++++++++++++++++ 3 files changed, 55 insertions(+) diff --git a/README.md b/README.md index 719439f6..61fa2b61 100644 --- a/README.md +++ b/README.md @@ -16,3 +16,16 @@ <!--- under the License. --> # TVM TIRx + +TIRx is an Open ML Compiler Foundation for building and extending machine +learning compilers. It provides a shared intermediate representation and type +system, symbolic analysis, program transformations, code generation, and +runtime support. + +Its components can be used individually or combined into compiler workflows. +Developers can build on this infrastructure to add their own analyses, +transformation passes, operators, types, and backend implementations. + +- [Programming Guide](docs/user/index.rst) +- [Python API Reference](docs/reference/python/index.rst) +- [Build from Source](docs/dev/source_build.rst) diff --git a/docs/index.rst b/docs/index.rst index 77fbe430..ff542c43 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,6 +21,12 @@ tvm-tirx Table of Contents ----------------- +.. toctree:: + :maxdepth: 1 + :caption: Programming Guide + + user/index + .. toctree:: :maxdepth: 1 :caption: Reference diff --git a/docs/user/index.rst b/docs/user/index.rst new file mode 100644 index 00000000..e7fdcc93 --- /dev/null +++ b/docs/user/index.rst @@ -0,0 +1,36 @@ +.. 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. + +.. _what-tirx-provides: + +Overview +======== + +TIRx is an Open ML Compiler Foundation. It provides reusable infrastructure for +building and extending machine learning compilers, including an intermediate +representation, symbolic analysis, transformation passes, code generation, and +runtime support. + +A shared IR connects program construction, analysis, and transformation. +Expressions represent program values and computations, and types describe +properties such as tensor shapes, element types, and memory scopes. Analyses +and passes use this representation to reason about and transform programs. + +You can use individual components or combine them into a compiler workflow. +When you need additional functionality, you can build on the same components +to add custom analyses, transformation passes, operators, types, or backend +implementations.
