Skip to content

Commit b1ef1f2

Browse files
authored
Enable neighbor tools in api docs. (#1086)
1 parent 5568f65 commit b1ef1f2

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

docs/api/physicsnemo.utils.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,16 @@ These are particularly useful when implementing custom training loops or special
2222
:members:
2323
:show-inheritance:
2424

25+
Neighbor utils
26+
--------------
27+
28+
Utilities for optimized layers for neighbor searches.
29+
30+
.. automodule:: physicsnemo.utils.neighbors
31+
:members:
32+
:show-inheritance:
33+
34+
2535
GraphCast utils
2636
---------------
2737

physicsnemo/utils/neighbors/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,6 @@
1616

1717

1818
from .radius_search import radius_search
19+
20+
# This is exclusively for the autodoc to generate the api docs:
21+
__all__ = ["radius_search"]

0 commit comments

Comments
 (0)