ȅiw!%SrSSKJr SSKJrJrJr SSKJr SSK r SSK J r \ "S5"S S 55r S r \"S \ RR5r\"S S55r\"5r\\\4\S'0r\\\4\S'S\S\4SjrS\S\SS4SjrS\S\4SjrS\S\4SjrS\S\4SjrS\S\\\\\444Sjrg)aM Note [Opaque Objects] Opaque objects are the way we allow custom operators to accept a user-defined "black box" object as an input. There are two kinds of opaque types: VALUE type and REFERENCE type. The distinction determines how torch.compile handles the object. REFERENCE TYPES (default): Reference-typed opaque objects represent mutable stateful objects and are treated as black boxes. In torch.compile, since torch.compile cannot optimize the anything (including tensors) within the object, the object must be an input to the graph. You can register a custom class as being a reference-based opaque object class through `register_opaque_type(MyClass, typ="reference")`. VALUE TYPES: Value-typed opaque objects represent constant values. In torch.compile, the graph specializes on the object like how other constants are. Therefore there are a couple of methods on the class that must be implemented before registering it as a value-typed opaque object class: - __eq__: torch.compile will create guards based on the equality of this object, meaning that a recompilation will happen if __eq__ returns False. - __hash__: This must be implemented for Fake Tensor caching - __fx_repr__: This must be implemented to provide an evaluable representation for FX graph codegen. It should return a tuple of (repr_string, dict[str, type]) where repr_string can reconstruct the object and the dict maps names used in repr_string to their corresponding types. You can register a custom class as being a reference-based opaque object class through `register_opaque_type(MyClass, typ="value")`. ) dataclass)AnyLiteralNewType)WeakKeyDictionaryN)register_fake_classzaten::OpaqueObjectcD\rSrSrSSjr\S\\\4SS4Sj5r Sr g) FakeOpaqueObject/returnNcg)N)selfs V/home/james-whalen/.local/lib/python3.13/site-packages/torch/_library/opaque_object.py__init__FakeOpaqueObject.__init__1s flattened_ctxc[S5e)NzFakeOpaqueObject should not be created through __obj_unflatten__ and should be special handled. Please file an issue to Github.) RuntimeError)clsrs r__obj_unflatten__"FakeOpaqueObject.__obj_unflatten__4s M  rr)r N) __name__ __module__ __qualname____firstlineno__r classmethoddictstrrr__static_attributes__rrrr r /s1  d38n   rr z)__torch__.torch.classes.aten.OpaqueObject OpaqueTypec0\rSrSr%\\S'\S\S'Srg)_OpaqueTypeInfoA class_name referencevalue opaque_typrN)rrrrr!__annotations__rr"rrrr%r%AsO,--rr% _OPAQUE_TYPES_OPAQUE_TYPES_BY_NAMErr ctU[;a[SUSURS35e[UR$)z Gets the registered opaque type name for a given class. Args: cls (type): The class to get the type name for. Returns: str: The registered type name for the class. Raises: ValueError: If the class is not registered as an opaque type. zClass z@ is not registered as an opaque type. Call register_opaque_type(z) first.)r- ValueErrorrr'rs rget_opaque_type_namer2MsI -SE)),h @     ( ((rtypcXSSKJs Jn URS:XdU[R La[ SUS35eXR;a[ US35eUS;dS5eUS :XahUR[RLa[S US 35eURc[S US 35e[US 5(d[S US35eURSUR3n[X15nU[U'U[ U'[R"R%U5 g)as Registers the given type as an opaque type which allows this to be consumed by a custom operator. The type name will be automatically generated from the class's fully qualified name (ex. my_module.MyClass). Args: cls (type): The class to register as an opaque type. typ (str): Either "reference" or "value". See Note [Opaque Objects] for more details. rNbuiltinsz!Unable to register built-in type z] as an opaque type. Please wrap it in a custom class and register the custom class as opaque.zv cannot be registered as an opaque object as it has been registered as a pytree. Opaque objects must be pytree leaves.r(z1Opaque type must be either 'reference' or 'value'r*!Value-type opaque object of type z is expected to have a non-default `__eq__` implementation as we will use this in torch.compile to guard on the equality of objects.zy is expected to have a non-default `__hash__` implementation as we will use this in torch.compile for FakeTensor caching. __fx_repr__z is expected to have a `__fx_repr__` method implementation as we will use this to reconstruct the object in the FX codegen. __fx_repr__ should return a tuple of (repr_string, set_of_types)..)torch.utils._pytreeutils_pytreertorchTensorr0SUPPORTED_NODES__eq__object TypeError__hash__hasattrrr%r-r._C_register_opaque_type)rr3pytreename type_infos rregister_opaque_typerIbsg)( ~~#sell':/u5X X   $$$eL L  ( (; ( g~ :: &3C5977  << 3C59** sM**3C59:: nn Qs//0 1D*I"M#"+$ HH""4(rc[U[5(a[RR U5$U[ ;ag[RR [ UR 5$)z- Checks if the given type is an opaque type. F) isinstancer!r<rD_is_opaque_type_registeredr-r'r1s ris_opaque_typerMsQ#sxx22377 - 88 . .}S/A/L/L MMrc[U5(dg[U[5(a[URS:H$[ URS:H$)zg Checks if the given type is an opaque **value** type. See Note [Opaque Objects] for more information. Fr*rMrKr!r.r+r-r1s ris_opaque_value_typerPsK #  #s$S)44??   ( (G 33rc[U5(dg[U[5(a[URS:H$[ URS:H$)zk Checks if the given type is an opaque **reference** type. See Note [Opaque Objects] for more information. Fr)rOr1s ris_opaque_reference_typerRsK #  #s$S)44 CC   ( (K 77robjc[US5(d[SUS35eUR5up[U[5(d7[S[ U5R S[ U5R 35e[U[5(d7[S[ U5R S[ U5R 35eX4$)a Get the FX-evaluable repr for an opaque object and collect required globals. Objects must implement __fx_repr__() which should return: (repr_string, dict_mapping_name_to_type) where repr_string is an evaluable string representation and dict_mapping_name_to_type maps the names used in repr_string to their types. For example, if repr_string is "Foo(bar=Bar(1))", the dict should be: {"Foo": Foo, "Bar": Bar} r7r6z is expected to have a `__fx_repr__` method implementation as we will use this to reconstruct the object in the FX codegen. __fx_repr__ should return a tuple of (repr_string, dict[str, type]).z__fx_repr__ for z0 must return a string as the first element, got z/ must return a dict as the second element, got )rCrAr7rKr!typerr )rSrepr_str globals_dicts rget_opaque_obj_reprrXs 3 & &/u59 9  !__.H h $ $tCy1123""&x."9"9!: <  lD ) )tCy1123##' #5#>#>"? A   !!r) __doc__ dataclassesrtypingrrrweakrefrr<fake_class_registryr r OpaqueTypeStrrD ScriptObjectr#r%r-r,r.r r!r2rIboolrMrPrRtuplerUrXrrrrbs7#J"((% 4)*   +  < \588#8#8 9  .. . :K9L  o!56L46tC016)c)c)*C)cC)3C)4C)L N N N 4c 4d 4 8# 8$ 8$"S$"U3S$Y+?%@$"r