Skip to content

Commit 7679d26

Browse files
committed
Fix docstring formatting
1 parent c441c9b commit 7679d26

File tree

3 files changed

+7
-6
lines changed

3 files changed

+7
-6
lines changed

src/torchjd/aggregation/__init__.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
r"""
22
When doing Jacobian descent, the Jacobian matrix has to be aggregated into a vector to store in the
33
``.grad`` fields of the model parameters. The
4-
The :class:`~torchjd.aggregation._aggregator_bases.Aggregator` is responsible for these aggregations.
4+
The :class:`~torchjd.aggregation._aggregator_bases.Aggregator` is responsible for these
5+
aggregations.
56
67
When using the :doc:`autogram <../autogram/index>` engine, we rather need to extract a vector
78
of weights from the Gramian of the Jacobian. The

src/torchjd/autogram/_edge_registry.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55

66
class EdgeRegistry:
77
"""
8-
Tracks `GradientEdge`s and provides a way to efficiently compute a minimally sufficient subset of
9-
leaf edges that are reachable from some given `GradientEdge`s.
8+
Tracks `GradientEdge`s and provides a way to efficiently compute a minimally sufficient subset
9+
of leaf edges that are reachable from some given `GradientEdge`s.
1010
"""
1111

1212
def __init__(self) -> None:

src/torchjd/autogram/_module_hook_manager.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,9 @@ class JacobianAccumulator(torch.autograd.Function):
103103
"""
104104
Autograd function that accumulates Jacobian Gramians during the first backward pass.
105105
106-
Acts as identity on forward pass. During the autogram algorithm,
107-
computes the Jacobian of outputs w.r.t. module parameters and feeds it to the gramian
108-
accumulator. Uses a toggle mechanism to activate only during the Gramian accumulation phase.
106+
Acts as identity on forward pass. During the autogram algorithm, computes the Jacobian
107+
of outputs w.r.t. module parameters and feeds it to the gramian accumulator. Uses a
108+
toggle mechanism to activate only during the Gramian accumulation phase.
109109
"""
110110

111111
@staticmethod

0 commit comments

Comments
 (0)