Skip to content

Commit 821a1b2

Browse files
committed
Minor documentation updates.
1 parent efc2149 commit 821a1b2

4 files changed

Lines changed: 10 additions & 8 deletions

File tree

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
2727

2828
html_theme = "furo"
29-
html_static_path = ["_static"]
29+
#html_static_path = ["_static"]
3030

3131
extensions = [
3232
"sphinx.ext.autodoc",

docs/installation.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ much faster since this extension is cached.
2626

2727

2828
Compiling the Integrated PyTorch Extension
29-
-----------------------------
29+
------------------------------------------
3030
To support ``torch.compile``, ``torch.export``, and
3131
JITScript, OpenEquivariance needs to compile a C++ extension
3232
tightly integrated with PyTorch. If you see a warning that
@@ -50,13 +50,13 @@ These configuration steps are required only ONCE after
5050
installation (or upgrade) with pip.
5151

5252
Configurations on Major Platforms
53-
-----------------------------
53+
---------------------------------
5454
OpenEquivariance has been tested on both supercomputers and lab clusters.
5555
Here are some tested environment configuration files. If use OpenEquivariance
5656
on a widely-used platform, send us a pull request to add your configuration!
5757

5858
NERSC Perlmutter (NVIDIA A100)
59-
""""""""""""""""""""""
59+
""""""""""""""""""""""""""""""
6060

6161
.. code-block:: bash
6262
:caption: env.sh (last updated June 2024)
@@ -73,7 +73,7 @@ NERSC Perlmutter (NVIDIA A100)
7373
7474
7575
OLCF Frontier (AMD MI250x)
76-
""""""""""""""""""""""
76+
""""""""""""""""""""""""""
7777
You need to install a HIP-enabled verison of PyTorch to use our package.
7878
To do this, follow the steps `here <https://docs.olcf.ornl.gov/software/analytics/pytorch_frontier.html>`_.
7979

docs/supported_ops.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Our code includes correctness checks, but the configuration space is large. If y
4545
a bug, let us know in a GitHub issue. We'll try our best to correct it or document the problem here.
4646

4747
Unsupported Tensor Product Configurations
48-
--------------------
48+
-----------------------------------------
4949

5050
We do not (yet) support:
5151

@@ -74,7 +74,7 @@ TorchBind in earlier versions.
7474

7575

7676
Multiple Devices and Streams
77-
--------------------
77+
----------------------------
7878
OpenEquivariance compiles kernels based on the compute capability of the
7979
first visible GPU. On heterogeneous systems, our kernels
8080
will only execute correctly on devices that share the compute capability

openequivariance/implementations/convolution/TensorProductConv.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ class TensorProductConv(torch.nn.Module, LoopUnrollConv):
1717
:math:`y_1...y_{|E|}`, and weights :math:`W_1...W_{|E|}`, computes
1818
1919
.. math::
20+
2021
z_i = \sum_{(i, j, e) \in \mathcal{N}(i)} W_e (x_j \otimes_{\\textrm{CG}} y_e)
22+
2123
where :math:`(i, j, e) \in \mathcal{N}(i)` indicates that node :math:`i` is connected to node :math:`j`
2224
via the edge indexed :math:`e`.
2325
@@ -29,7 +31,7 @@ class TensorProductConv(torch.nn.Module, LoopUnrollConv):
2931
:param deterministic: if ``False``, uses atomics for the convolution. If ``True``, uses a deterministic
3032
fixup-based algorithm. `Default`: ``False``.
3133
:param kahan: if ``True``, uses Kahan summation to improve accuracy during aggregation. To use this option,
32-
the input tensors must be in float32 precision AND you must set ``deterministic=True``. *Default*: ``False``.
34+
the input tensors must be in float32 precision AND you must set ``deterministic=True``. *Default*: ``False``.
3335
3436
"""
3537

0 commit comments

Comments
 (0)