This is an automated email from the ASF dual-hosted git repository. tqchen pushed a commit to branch tirx-standalone-root in repository https://gitbox.apache.org/repos/asf/tvm.git
commit ad54df1414446aed90d41f212de854ff875916a7 Author: tqchen <[email protected]> AuthorDate: Fri Oct 16 02:33:56 2026 +0000 [DOCS] Add standalone TIRx Python API scaffold --- docs/.gitignore | 19 +++++++++++ docs/conf.py | 28 ++++++++++++++++ docs/index.rst | 28 ++++++++++++++++ docs/reference/python/index.rst | 71 +++++++++++++++++++++++++++++++++++++++++ docs/requirements.txt | 19 +++++++++++ 5 files changed, 165 insertions(+) diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000000..fabfa51909 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,19 @@ +# 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. + +_build/ +reference/python/generated/ diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000000..208c27c6ea --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,28 @@ +# 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. + +import sys +from pathlib import Path + +sys.path.insert(0, str(Path(__file__).resolve().parents[1] / "python")) + +project = "Apache TVM TIRx" +author = "Apache TVM Community" +extensions = ["sphinx.ext.autodoc", "sphinx.ext.autosummary", "sphinx.ext.napoleon"] +autosummary_generate = True +exclude_patterns = ["_build"] +html_theme = "sphinx_book_theme" diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000000..5abf08212f --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,28 @@ +.. 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. + +Apache TVM TIRx Documentation +============================== + +Table of Contents +----------------- + +.. toctree:: + :maxdepth: 1 + :caption: Reference + + reference/python/index.rst diff --git a/docs/reference/python/index.rst b/docs/reference/python/index.rst new file mode 100644 index 0000000000..17b96bafd2 --- /dev/null +++ b/docs/reference/python/index.rst @@ -0,0 +1,71 @@ +.. 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. + +Python API +========== + +.. automodule:: tvm_tirx + :no-members: + +.. currentmodule:: tvm_tirx + +.. contents:: Table of Contents + :local: + :depth: 2 + +IR +-- + +.. autosummary:: + :toctree: generated/ + + ir.IRModule + ir.Expr + ir.Stmt + +TIRx +---- + +.. autosummary:: + :toctree: generated/ + + tirx.Function + tirx.Var + tirx.TensorType + tirx.decl_tensor + tirx.IndexMap + tirx.Layout + tirx.TileLayout + tirx.compile + +Target +------ + +.. autosummary:: + :toctree: generated/ + + target.Target + +Runtime +------- + +.. autosummary:: + :toctree: generated/ + + runtime.Tensor + runtime.Module + runtime.Executable diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000000..bad902409b --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,19 @@ +# 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. + +sphinx>=7 +sphinx-book-theme
