Rename XLATensor2 to Tensor

Author: qihqi

torchax/README.md

@@ -128,7 +128,7 @@ with env:
   inputs = torch.randn(3, 3, 28, 28)
   m = MyModel()
   res = m(inputs)
-  print(type(res))  # outputs XLATensor2
+  print(type(res))  # outputs Tensor
 ```
 
 You can also enable the environment globally with

torchax/docs/how_it_works.md

@@ -4,15 +4,15 @@ How it works
 
 ## Tensor subclass and eager mode
 
-The class `XLATensor2` is a `torch.Tensor` subclass
+The class `Tensor` is a `torch.Tensor` subclass
 that overrides `__torch_dispatch__`.
 
 It roughly looks like this (with some details removed):
 
 The complete class impl is at [tensor.py](../torchax/tensor.py).
 
 ```python
-class XLATensor2(torch.Tensor):
+class Tensor(torch.Tensor):
 
   @staticmethod
   def __new__(cls, elem):
@@ -33,21 +33,21 @@ class XLATensor2(torch.Tensor):
   @classmethod
   def __torch_dispatch__(cls, func, types, args=(), kwargs=None):
     # here assumes ALL tensors in args / kwargs are 
-    # instances of XLATensor2
+    # instances of Tensor
     args, kwargs = unwrap((args, kwargs))
     jax_func = some_registry[func]
     res = jax_func(*args, **kwargs)
     return wrap(res)
 
 def wrap(tree):
-    # wrap jax.Array with XLATensor2
+    # wrap jax.Array with Tensor
     return pytree.tree_map_only(
-        jax.Array, XLATensor2, tree)
+        jax.Array, Tensor, tree)
 
 def unwrap(tree):
-    # get jax.Array out ofXLATensor2
+    # get jax.Array out ofTensor
     return pytree.tree_map_only(
-        XLATensor2, lambda x: x._elem, tree)
+        Tensor, lambda x: x._elem, tree)
 ```
 
 In other words, assuming that we have a function
@@ -120,7 +120,7 @@ def backend(fxgraph):
 The inner function `tojit` is a function that takes and returns 
 `jax.Array`'s. So it's suitable to be jitted with `jax.jit`.
 
-`f` is returned callable that takes `XLATensor2`; so can interop with 
+`f` is returned callable that takes `Tensor`; so can interop with 
 other torch codes.
 
 ## nn.Modules and state management

torchax/docs/torch_xla2_dynamo.md

@@ -33,11 +33,11 @@ not incur any data copies in this process.
 Consider this following pseudocode:
 
 ```python
-class XLATensor2:
+class Tensor:
   _data: jax.Array 
   def __torch_dispatch__(...):
       # do stuff with _data, get new data
-      return XLATensor2(new_data)
+      return Tensor(new_data)
 
 def dynamo_backend(fx, sample):
   compiled = compile fx into graph that manipulate jax.Array.

torchax/docs/understand_jax_jit/torch_module.py

@@ -48,20 +48,20 @@ def forward(self, X):
 print('---- example 3 -----')
 # where is the jax jit?
 
-# m2 is a callable that takes in XLATensor2 and returns XLATensor2
-#    m2: (XLATensor2 -> XLATensor2)
+# m2 is a callable that takes in Tensor and returns Tensor
+#    m2: (Tensor -> Tensor)
 
-# suppose t2j (XLATensor2 -> jax.Array) "unwraps the XLATensor"
-# suppose j2t (jax.Array  -> XLATensor2) "wraps the XLATensor"
+# suppose t2j (Tensor -> jax.Array) "unwraps the XLATensor"
+# suppose j2t (jax.Array  -> Tensor) "wraps the XLATensor"
 from torchax import tensor
 import jax
 
-def t2j(torch_tensor: tensor.XLATensor2) -> jax.Array:
+def t2j(torch_tensor: tensor.Tensor) -> jax.Array:
   return torch_tensor._elem
 
 
-def j2t(jax_array: jax.Array) -> tensor.XLATensor2:
-  return tensor.XLATensor2(jax_array, env)
+def j2t(jax_array: jax.Array) -> tensor.Tensor:
+  return tensor.Tensor(jax_array, env)
 
 # # further notice t2j(j2t(x)) == x; j2t(t2j(x)) == x
 
@@ -75,7 +75,7 @@ def jax_m(X: jax.Array):
 jax_x = jnp.ones((10, 1000))
 print(jax_m(jax_x))
 
-## Let f: XLATensor2 -> XLATensor2
+## Let f: Tensor -> Tensor
 ## There is a function g: jax.Array -> jax.Array; 
 ##   g = x |-> j2t (f (t2j(x))). OR,
 ##   g = j2t . f . t2j (. denotes function composition)

torchax/examples/_diffusion.py

@@ -26,7 +26,7 @@ def __init__(self, model):
 
 
     def _maybe_move_tensor(self, tensor):
-        if isinstance(tensor, torch.Tensor) and not isinstance(tensor, torchax.tensor.XLATensor2):
+        if isinstance(tensor, torch.Tensor) and not isinstance(tensor, torchax.tensor.Tensor):
             return torchax.tensor.move_to_device(tensor)
         return tensor
 

torchax/examples/mnist_tpu.ipynb

@@ -304,7 +304,7 @@
         {
           "data": {
             "text/plain": [
-              "XLATensor2(<class 'jaxlib.xla_extension.ArrayImpl'> [[ 0.03249096  0.01343462 -0.022144   ...  0.00668433  0.00833362\n",
+              "Tensor(<class 'jaxlib.xla_extension.ArrayImpl'> [[ 0.03249096  0.01343462 -0.022144   ...  0.00668433  0.00833362\n",
               "   0.00225713]\n",
               " [ 0.02272127  0.02205281  0.00828168 ... -0.02310903  0.02183958\n",
               "   0.01084254]\n",

torchax/examples/train_gpt/train_ddp.py

@@ -29,8 +29,8 @@
 def _checkpoint(jax_model, path: pathlib.Path):
   torch.save(
     torch_pytree.tree_map_only(
-      torchax.tensor.XLATensor2,
-      torchax.tensor.XLATensor2.torch,
+      torchax.tensor.Tensor,
+      torchax.tensor.Tensor.torch,
       jax_model.state_dict(),
     ),
     path,

torchax/test/test_base.py

@@ -40,7 +40,7 @@ def run_function_and_compare(testcase,
       args2, kwargs2 = pytree.tree_map_only(torch.Tensor, tensor.move_to_device,
                                             (args, kwargs))
       res2 = func(*args2, **kwargs2)
-      res2 = pytree.tree_map_only(tensor.XLATensor2, lambda t: t.torch(), res2)
+      res2 = pytree.tree_map_only(tensor.Tensor, lambda t: t.torch(), res2)
       with testcase.subTest("torchax_diff:" + str(atol)):
         if ignore_indices and isinstance(res, tuple) and len(res) == 2:
           diff_output(

torchax/test/test_context.py

@@ -20,9 +20,9 @@ def tearDown(self):
   def test_mode_context_manager(self):
     with xla_env:
       x = torch.full((3, 3), -1)
-      self.assertIsInstance(x, tensor.XLATensor2)
+      self.assertIsInstance(x, tensor.Tensor)
       y = x.abs()
-      self.assertIsInstance(y, tensor.XLATensor2)
+      self.assertIsInstance(y, tensor.Tensor)
 
   @staticmethod
   @xla_env
@@ -34,30 +34,30 @@ def _test_mode_decorator():
 
   def test_mode_decorator(self):
     x, y = self._test_mode_decorator()
-    self.assertIsInstance(x, tensor.XLATensor2)
-    self.assertIsInstance(y, tensor.XLATensor2)
+    self.assertIsInstance(x, tensor.Tensor)
+    self.assertIsInstance(y, tensor.Tensor)
 
   def test_same_manual_seed(self):
     with xla_env:
       torch.manual_seed(1234)
       x = torch.randn((3, 3))
-      self.assertIsInstance(x, tensor.XLATensor2)
+      self.assertIsInstance(x, tensor.Tensor)
 
       torch.manual_seed(1234)
       y = torch.randn((3, 3))
-      self.assertIsInstance(y, tensor.XLATensor2)
+      self.assertIsInstance(y, tensor.Tensor)
 
     self.assertTrue(torch.equal(torchax.tensor.j2t(x._elem), torchax.tensor.j2t(y._elem)))
 
   def test_different_manual_seed(self):
     with xla_env:
       torch.manual_seed(1234)
       x = torch.randn((3, 3))
-      self.assertIsInstance(x, tensor.XLATensor2)
+      self.assertIsInstance(x, tensor.Tensor)
 
       torch.manual_seed(12345)
       y = torch.randn((3, 3))
-      self.assertIsInstance(y, tensor.XLATensor2)
+      self.assertIsInstance(y, tensor.Tensor)
 
     self.assertFalse(torch.equal(torchax.tensor.j2t(x._elem), torchax.tensor.j2t(y._elem)))
 
@@ -69,7 +69,7 @@ def random_op():
       return x @ y
 
     random_jit = torchax.interop.jax_jit(random_op)
-    self.assertIsInstance(random_jit(), tensor.XLATensor2)
+    self.assertIsInstance(random_jit(), tensor.Tensor)
 
     # Result always expected to be the same for a jitted function because seeds
     # are baked in
@@ -101,13 +101,13 @@ def __init__(self):
     # Test context manager.
     with xla_env:
       m = M()
-      self.assertIsInstance(m.c, tensor.XLATensor2)
-      self.assertIsInstance(m.c2, tensor.XLATensor2)
+      self.assertIsInstance(m.c, tensor.Tensor)
+      self.assertIsInstance(m.c2, tensor.Tensor)
     # Test `to_xla`.
     m = M()
     m = xla_env.to_xla(m)
-    self.assertIsInstance(m.c, tensor.XLATensor2)
-    self.assertIsInstance(m.c2, tensor.XLATensor2)
+    self.assertIsInstance(m.c, tensor.Tensor)
+    self.assertIsInstance(m.c2, tensor.Tensor)
 
 
 if __name__ == "__main__":

torchax/test/test_core_aten_ops.py

@@ -39,7 +39,7 @@ def run_export_and_compare(testcase,
       args2, kwargs2 = testcase.env.to_xla((args, kwargs))
       with testcase.env:
         res2 = func(*args2, **kwargs2)
-      res2 = pytree.tree_map_only(tensor.XLATensor2, lambda t: t.torch(), res2)
+      res2 = pytree.tree_map_only(tensor.Tensor, lambda t: t.torch(), res2)
       # import pdb; pdb.set_trace()
       with testcase.subTest("torchax_diff:" + str(atol)):
         if ignore_indices and isinstance(res, tuple) and len(res) == 2: