Create docs

justinchuby · gramalingam · justinchuby · commit e0c16ea061c9 · 2025-05-15T08:23:32.000-07:00
Signed-off-by: Justin Chu &lt;justinchuby@users.noreply.github.com&gt;

Co-authored-by: G. Ramalingam &lt;grama@microsoft.com&gt;
diff --git a/REUSE.toml b/REUSE.toml
@@ -9,13 +9,16 @@ SPDX-PackageDownloadLocation = "onnx.ai"
 
 [[annotations]]
 path = [
-    "**/*.yml",
+    ".editorconfig",
+    ".gitignore",
+    "**/*.css",
+    "**/*.ipynb",
     "**/*.md",
+    "**/*.rst",
     "**/*.toml",
+    "**/*.yml",
+    "CODEOWNERS",
     "requirements/**/*.txt",
-    ".editorconfig",
-    ".gitignore",
-    "CODEOWNERS"
 ]
 precedence = "aggregate"
 SPDX-FileCopyrightText = "Copyright (c) ONNX Project Contributors"
diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
@@ -0,0 +1,75 @@
+.navbar-brand {
+  padding: 4px 0 2px 0;
+}
+
+.bi {
+  width: 1em;
+  height: 1em;
+  display: inline-block;
+  vertical-align: -0.125em;
+  fill: currentcolor;
+  flex-shrink: 0;
+}
+
+.article-meta {
+  display: flex;
+  align-items: first baseline;
+  opacity: 80%;
+}
+
+.article-meta:not(:last-child) {
+  margin-bottom: 0.5rem;
+}
+
+.article-meta .bi:first-child {
+  margin-right: 0.5em;
+}
+
+.article-authors > ul {
+  display: inline;
+  list-style: none;
+  margin: 0;
+  padding: 0;
+}
+
+.article-authors > ul > li {
+  display: inline;
+}
+
+.article-authors > ul > li:not(:last-child)::after {
+  content: " • ";
+}
+
+.article-date > span {
+  font-style: italic;
+  font-size: 0.875rem;
+  opacity: 80%;
+}
+
+.highlight {
+  overflow-x: auto;
+  overflow-y: scroll;
+}
+
+.code-title {
+  text-align: center;
+  font-weight: normal;
+  font-style: italic;
+  margin-top: 1.5em;
+}
+
+@media screen {
+  .longcode > .highlight {
+    max-height: 25em;
+  }
+}
+
+figure.math {
+  text-align: center;
+  margin: 1em 0;
+}
+
+figure.math svg {
+  fill: currentColor;
+  max-width: max(60%, 400px);
+}
diff --git a/docs/_templates/classtemplate.rst b/docs/_templates/classtemplate.rst
@@ -0,0 +1,14 @@
+.. role:: hidden
+    :class: hidden-section
+.. currentmodule:: {{ module }}
+
+
+{{ name | underline}}
+
+.. autoclass:: {{ name }}
+    :members:
+    :undoc-members:
+    :member-order: bysource
+
+..
+  autogenerated from docs/_templates/classtemplate.rst
diff --git a/docs/_templates/classtemplate_inherited.rst b/docs/_templates/classtemplate_inherited.rst
@@ -0,0 +1,16 @@
+.. role:: hidden
+    :class: hidden-section
+.. currentmodule:: {{ module }}
+
+
+{{ name | underline}}
+
+.. autoclass:: {{ name }}
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :member-order: bysource
+
+
+..
+  autogenerated from docs/_templates/classtemplate.rst
diff --git a/docs/_templates/functiontemplate.rst b/docs/_templates/functiontemplate.rst
@@ -0,0 +1,12 @@
+.. role:: hidden
+    :class: hidden-section
+.. currentmodule:: {{ module }}
+
+
+{{ name | underline}}
+
+.. autofunction:: {{ name }}
+
+
+..
+  autogenerated from docs/_templates/functiontemplate.rst
diff --git a/docs/api/core.md b/docs/api/core.md
@@ -0,0 +1,65 @@
+# onnx_ir
+
+```{eval-rst}
+.. automodule::onnx_ir
+.. currentmodule:: onnxscript
+```
+
+## Functions and constructors
+
+```{eval-rst}
+.. autosummary::
+    :toctree: generated
+    :template: functiontemplate.rst
+    :nosignatures:
+
+    ir.load
+    ir.save
+    ir.from_proto
+    ir.from_onnx_text
+    ir.to_proto
+    ir.tensor
+    ir.node
+```
+
+## Classes
+
+```{eval-rst}
+.. autosummary::
+    :toctree: generated
+    :template: classtemplate_inherited.rst
+    :nosignatures:
+
+    ir.TensorProtocol
+    ir.Value
+    ir.Node
+    ir.Graph
+    ir.Model
+    ir.GraphView
+    ir.Function
+    ir.Attr
+    ir.RefAttr
+    ir.Shape
+    ir.SymbolicDim
+    ir.TypeAndShape
+    ir.TensorType
+    ir.SparseTensorType
+    ir.SequenceType
+    ir.OptionalType
+    ir.Tensor
+    ir.ExternalTensor
+    ir.StringTensor
+    ir.LazyTensor
+```
+
+## Enums
+
+```{eval-rst}
+.. autosummary::
+    :toctree: generated
+    :template: classtemplate.rst
+    :nosignatures:
+
+    ir.DataType
+    ir.AttributeType
+```
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -0,0 +1,13 @@
+# IR APIs
+
+```{toctree}
+:maxdepth: 1
+
+core
+ir_convenience
+ir_external_data
+ir_passes
+ir_passes_common
+ir_traversal
+ir_tape
+```
diff --git a/docs/api/ir_convenience.md b/docs/api/ir_convenience.md
@@ -0,0 +1,15 @@
+# ir.convenience
+
+```{eval-rst}
+.. automodule::onnx_ir.convenience
+.. currentmodule:: onnx_ir.convenience
+```
+
+
+```{eval-rst}
+.. autofunction:: convert_attribute
+.. autofunction:: convert_attributes
+.. autofunction:: replace_all_uses_with
+.. autofunction:: replace_nodes_and_values
+.. autofunction:: create_value_mapping
+```
diff --git a/docs/api/ir_external_data.md b/docs/api/ir_external_data.md
@@ -0,0 +1,20 @@
+# ir.external_data
+
+```{eval-rst}
+.. automodule::onnx_ir.external_data
+.. currentmodule:: onnx_ir.external_data
+```
+
+The `onnx_ir.external_data` module provides utilities for handling external data in ONNX models. It enables the conversion of tensors to and from external data files, allowing for efficient storage and manipulation of large tensor data. This is particularly useful for models with large initializers that exceed memory constraints.
+
+## Functions
+
+```{eval-rst}
+.. autofunction:: load_to_model
+.. autofunction:: unload_from_model
+.. autofunction:: convert_tensors_to_external
+.. autofunction:: convert_tensors_from_external
+.. autofunction:: set_base_dir
+```
+
+<!-- TODO: Create examples -->
diff --git a/docs/api/ir_passes.md b/docs/api/ir_passes.md
@@ -0,0 +1,39 @@
+# ir.passes
+
+```{eval-rst}
+.. automodule::onnx_ir.passes
+.. currentmodule:: onnxscript
+```
+
+## Use built-in passes
+
+Common, reusable passes are implemented in `onnx_ir.passes.common`. You can use {py:class}`onnx_ir.passes.Sequential <onnx_ir.passes.Sequential>` to chain passes or use {py:class}`onnx_ir.passes.PassManager <onnx_ir.passes.PassManager>` which supports early stopping if no changes are made.
+
+## Pass infrastructure
+
+Inherent {py:class}`onnx_ir.passes.InPlacePass <onnx_ir.passes.InPlacePass>` or {py:class}`onnx_ir.passes.FunctionalPass <onnx_ir.passes.FunctionalPass>` to define a pass. You will need to implement the `call` method which returns a {py:class}`onnx_ir.passes.PassResult <onnx_ir.passes.PassResult>`.
+
+Alternatively, inherent the base class `onnx_ir.passes.PassBase <onnx_ir.passes.PassBase>` and override the two properties `changes_input` and `in_place` to set properties of the pass.
+
+```{eval-rst}
+.. autosummary::
+    :toctree: generated
+    :template: classtemplate.rst
+    :nosignatures:
+
+    ir.passes.PassBase
+    ir.passes.InPlacePass
+    ir.passes.FunctionalPass
+    ir.passes.Sequential
+    ir.passes.PassResult
+    ir.passes.PassManager
+```
+
+## Errors
+
+```{eval-rst}
+.. autoexception:: onnx_ir.passes.InvariantError
+.. autoexception:: onnx_ir.passes.PreconditionError
+.. autoexception:: onnx_ir.passes.PostconditionError
+.. autoexception:: onnx_ir.passes.PassError
+```
diff --git a/docs/api/ir_passes_common.md b/docs/api/ir_passes_common.md
@@ -0,0 +1,12 @@
+# ir.passes.common
+
+Built-in passes provided by the ONNX IR
+
+```{eval-rst}
+.. automodule:: onnx_ir.passes.common
+    :show-inheritance:
+    :members:
+    :undoc-members:
+    :exclude-members: call
+
+```
diff --git a/docs/api/ir_tape.md b/docs/api/ir_tape.md
@@ -0,0 +1,18 @@
+# ir.tape
+
+```{eval-rst}
+.. automodule:: onnx_ir.tape
+.. currentmodule:: onnx_ir.tape
+```
+
+The `onnx_ir.tape` module provides utilities for recording nodes and initializers to construct computational graphs or functions.
+
+## The `Tape` class
+
+The `Tape` class is a recorder that collects nodes and initializers created during the construction of a graph or function. It supports creating nodes with single or multiple outputs and registering initializers.
+
+```{eval-rst}
+.. autoclass:: Tape
+   :members:
+   :undoc-members:
+```
diff --git a/docs/api/ir_traversal.md b/docs/api/ir_traversal.md
@@ -0,0 +1,13 @@
+# ir.traversal
+
+```{eval-rst}
+.. automodule:: onnx_ir.traversal
+.. currentmodule:: onnx_ir.traversal
+```
+
+```{eval-rst}
+.. autoclass:: RecursiveGraphIterator
+   :members:
+   :undoc-members:
+   :special-members:
+```
diff --git a/docs/conf.py b/docs/conf.py
diff --git a/docs/getting_started.ipynb b/docs/getting_started.ipynb
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/tensors.md b/docs/tensors.md
