Docs

Signed-off-by: Justin Chu <[email protected]>

Author: justinchuby

src/onnx_ir/__init__.py

@@ -78,7 +78,7 @@
     # Convenience constructors
     "tensor",
     "node",
-    "value",
+    "val",
     # Pass infrastructure
     "passes",
     # IO
@@ -91,7 +91,7 @@
 import types
 
 from onnx_ir import convenience, external_data, passes, serde, tape, traversal
-from onnx_ir._convenience._constructors import node, tensor, value
+from onnx_ir._convenience._constructors import node, tensor, val
 from onnx_ir._core import (
     Attr,
     AttrFloat32,

src/onnx_ir/_convenience/_constructors.py

@@ -217,27 +217,35 @@ def node(
     )
 
 
-def value(
+def val(
     name: str,
     dtype: ir.DataType | None = None,
     shape: ir.Shape | Sequence[int | str | None] | None = None,
     *,
     type: ir.TypeProtocol | None = None,
     const_value: ir.TensorProtocol | None = None,
 ) -> ir.Value:
-    """Create a Value with the given name and type.
+    """Create a :class:`~onnx_ir.Value` with the given name and type.
+
+    This is a convenience constructor for creating a Value that allows you to specify
+    dtype and shape in a more relaxed manner. Whereas to create a Value directly, you
+    need to create a :class:`~onnx_ir.TypeProtocol` and :class:`~onnx_ir.Shape` object
+    first, this function allows you to specify dtype as a :class:`~onnx_ir.DataType`
+    and shape as a sequence of integers or symbolic dimensions.
 
     Example::
 
         >>> import onnx_ir as ir
-        >>> t = ir.value("x", ir.DataType.FLOAT, ["N", 42, 3])
+        >>> t = ir.val("x", ir.DataType.FLOAT, ["N", 42, 3])
         >>> t.name
         'x'
         >>> t.type
         Tensor(FLOAT)
         >>> t.shape
         Shape([SymbolicDim(N), 42, 3])
 
+    .. versionadded:: 0.1.9
+
     Args:
         name: The name of the value.
         dtype: The data type of the TensorType of the value. This is used only when type is None.