Skip to content

Commit aa0488d

Browse files
committed
Changes to get the documentation to build.
1 parent 26b746b commit aa0488d

4 files changed

Lines changed: 12 additions & 2 deletions

File tree

CHANGELOG.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ This release brings `ir_mul` layout support for
55
OpenEquivariance. Pass the parameter
66
`layout='ir_mul'` to any `TPProblem` instance to use
77
a transposed layout for the input and output
8-
irreps.
8+
irreps. To transpose input and output irreps use
9+
`oeq.transpose_irreps` or `oeq.jax.transpose_irreps`;
10+
see our API page for usage details.
911

1012
### v0.6.4 (2026-03-05)
1113
Bugfix: added missing MLIR lowerings for

docs/api.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ PyTorch API
3030
:undoc-members:
3131
:exclude-members: name
3232

33+
.. autofunction:: openequivariance.transpose_irreps
34+
3335
.. autofunction:: openequivariance.torch_to_oeq_dtype
3436

3537
.. autofunction:: openequivariance.torch_ext_so_path
@@ -54,7 +56,9 @@ breaking the PyTorch version of OpenEquivariance.
5456
.. autoclass:: openequivariance.jax.TensorProductConv
5557
:members: forward, reorder_weights_from_e3nn, reorder_weights_to_e3nn
5658
:undoc-members:
57-
:exclude-members:
59+
:exclude-members:
60+
61+
.. autofunction:: openequivariance.jax.transpose_irreps
5862

5963
Common API
6064
---------------------

docs/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@
3838
"openequivariance._torch.extlib",
3939
"openequivariance.jax.extlib",
4040
"openequivariance_extjax",
41+
"openequivariance.jax.jvp.tp_prim",
42+
"openequivariance.jax.jvp.conv_prim",
4143
"jinja2",
4244
"numpy",
4345
]

openequivariance/openequivariance/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ def _check_package_editable():
3737

3838
from openequivariance._torch.TensorProduct import TensorProduct
3939
from openequivariance._torch.TensorProductConv import TensorProductConv
40+
from openequivariance._torch.utils import transpose_irreps
4041

4142
from openequivariance._torch.extlib import (
4243
torch_ext_so_path as torch_ext_so_path_internal,
@@ -111,4 +112,5 @@ def TensorProductConv(*args, **kwargs):
111112
"_check_package_editable",
112113
"torch_ext_so_path",
113114
"jax",
115+
"transpose_irreps",
114116
]

0 commit comments

Comments
 (0)