Skip to content

Commit e7d4981

Browse files
committed
Exclude properties from the documentation
- I think it's good to have properties for beta and eps, so that we can check the values before assigning them, but I also think that the documentation of those properties is a bit bloating the documentation of the aggregator itself (and it's quite a duplicate of the documentation of the parameters). So IMO the best thing to do is to keep those two as properties, but not display the documentation of those properties (it still shows in the documentation of these parameters)
1 parent 59e7942 commit e7d4981

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

docs/source/docs/aggregation/gradvac.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ GradVac
66
.. autoclass:: torchjd.aggregation.GradVac
77
:members:
88
:undoc-members:
9-
:exclude-members: forward
9+
:exclude-members: forward, eps, beta
1010

1111
.. autoclass:: torchjd.aggregation.GradVacWeighting
1212
:members:
1313
:undoc-members:
14-
:exclude-members: forward
14+
:exclude-members: forward, eps, beta

0 commit comments

Comments
 (0)