Class Var

python/tvm/relax/expr.py:762–805

The variable class for all Relax bindings. Parameters ---------- name_hint: str | Id The name hint of the variable. struct_info: Optional[StructInfo] The struct info annotation of the variable. span: Optional[Span] Span that points to original source co

@tvm_ffi.register_object("relax.expr.Var")
class Var(ExprWithOp):
    """The variable class for all Relax bindings.

    Parameters
    ----------
    name_hint: str | Id
        The name hint of the variable.

    struct_info: Optional[StructInfo]
        The struct info annotation of the variable.

    span: Optional[Span]
        Span that points to original source code
    """

    vid: Id
    span: Span | None

    def __init__(
        self,
        name_hint: str | Id,
        struct_info: StructInfo | None = None,
        span: Span | None = None,
    ) -> None:
        if struct_info is not None:
            struct_info = tvm.runtime.convert(struct_info)
            if not isinstance(struct_info, StructInfo):
                raise TypeError(
                    "struct_info needs to be an instance of StructInfo. "
                    "If you attempt to pass in shape, "
                    "use relax.TensorStructInfo(shape, dtype)."
                )
        self.__init_handle_by_constructor__(
            _ffi_api.Var if isinstance(name_hint, str) else _ffi_api.VarFromId,  # type: ignore
            name_hint,
            struct_info,
            span,
        )

    @property
    def name_hint(self) -> str:
        """Get name hint of the current var."""
        name = str(self.vid.name_hint)
        return name


@tvm_ffi.register_object("relax.expr.DataflowVar")