From e7ccedd2b0d04acaaff1c94e133276d8d049b509 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Val=C3=A9rian=20Rey?= Date: Thu, 16 Apr 2026 17:36:04 +0200 Subject: [PATCH] Change rst files of aggregators to opt-in member documentation instead of opt-out --- docs/source/docs/aggregation/aligned_mtl.rst | 6 ------ docs/source/docs/aggregation/cagrad.rst | 6 ------ docs/source/docs/aggregation/config.rst | 3 --- docs/source/docs/aggregation/constant.rst | 6 ------ docs/source/docs/aggregation/dualproj.rst | 6 ------ docs/source/docs/aggregation/flattening.rst | 3 --- docs/source/docs/aggregation/graddrop.rst | 3 --- docs/source/docs/aggregation/gradvac.rst | 8 ++------ docs/source/docs/aggregation/imtl_g.rst | 6 ------ docs/source/docs/aggregation/index.rst | 12 +----------- docs/source/docs/aggregation/krum.rst | 6 ------ docs/source/docs/aggregation/mean.rst | 6 ------ docs/source/docs/aggregation/mgda.rst | 6 ------ docs/source/docs/aggregation/nash_mtl.rst | 4 +--- docs/source/docs/aggregation/pcgrad.rst | 6 ------ docs/source/docs/aggregation/random.rst | 6 ------ docs/source/docs/aggregation/sum.rst | 6 ------ docs/source/docs/aggregation/trimmed_mean.rst | 3 --- docs/source/docs/aggregation/upgrad.rst | 6 ------ 19 files changed, 4 insertions(+), 104 deletions(-) diff --git a/docs/source/docs/aggregation/aligned_mtl.rst b/docs/source/docs/aggregation/aligned_mtl.rst index 64ffcb614..2b9d818c6 100644 --- a/docs/source/docs/aggregation/aligned_mtl.rst +++ b/docs/source/docs/aggregation/aligned_mtl.rst @@ -4,11 +4,5 @@ Aligned-MTL =========== .. autoclass:: torchjd.aggregation.AlignedMTL - :members: - :undoc-members: - :exclude-members: forward .. autoclass:: torchjd.aggregation.AlignedMTLWeighting - :members: - :undoc-members: - :exclude-members: forward diff --git a/docs/source/docs/aggregation/cagrad.rst b/docs/source/docs/aggregation/cagrad.rst index 0aff4ac07..8a8976b31 100644 --- a/docs/source/docs/aggregation/cagrad.rst +++ b/docs/source/docs/aggregation/cagrad.rst @@ -4,11 +4,5 @@ CAGrad ====== .. autoclass:: torchjd.aggregation.CAGrad - :members: - :undoc-members: - :exclude-members: forward .. autoclass:: torchjd.aggregation.CAGradWeighting - :members: - :undoc-members: - :exclude-members: forward diff --git a/docs/source/docs/aggregation/config.rst b/docs/source/docs/aggregation/config.rst index 94ab3f4a8..fba4b3843 100644 --- a/docs/source/docs/aggregation/config.rst +++ b/docs/source/docs/aggregation/config.rst @@ -4,6 +4,3 @@ ConFIG ====== .. autoclass:: torchjd.aggregation.ConFIG - :members: - :undoc-members: - :exclude-members: forward diff --git a/docs/source/docs/aggregation/constant.rst b/docs/source/docs/aggregation/constant.rst index 2d2b4c5c0..1ad4fb290 100644 --- a/docs/source/docs/aggregation/constant.rst +++ b/docs/source/docs/aggregation/constant.rst @@ -4,11 +4,5 @@ Constant ======== .. autoclass:: torchjd.aggregation.Constant - :members: - :undoc-members: - :exclude-members: forward .. autoclass:: torchjd.aggregation.ConstantWeighting - :members: - :undoc-members: - :exclude-members: forward diff --git a/docs/source/docs/aggregation/dualproj.rst b/docs/source/docs/aggregation/dualproj.rst index 25c2e3340..a326530b8 100644 --- a/docs/source/docs/aggregation/dualproj.rst +++ b/docs/source/docs/aggregation/dualproj.rst @@ -4,11 +4,5 @@ DualProj ======== .. autoclass:: torchjd.aggregation.DualProj - :members: - :undoc-members: - :exclude-members: forward .. autoclass:: torchjd.aggregation.DualProjWeighting - :members: - :undoc-members: - :exclude-members: forward diff --git a/docs/source/docs/aggregation/flattening.rst b/docs/source/docs/aggregation/flattening.rst index b4ac237dd..0214f1317 100644 --- a/docs/source/docs/aggregation/flattening.rst +++ b/docs/source/docs/aggregation/flattening.rst @@ -4,6 +4,3 @@ Flattening ========== .. autoclass:: torchjd.aggregation.Flattening - :members: - :undoc-members: - :exclude-members: forward diff --git a/docs/source/docs/aggregation/graddrop.rst b/docs/source/docs/aggregation/graddrop.rst index f27f36125..3dae9f04d 100644 --- a/docs/source/docs/aggregation/graddrop.rst +++ b/docs/source/docs/aggregation/graddrop.rst @@ -4,6 +4,3 @@ GradDrop ======== .. autoclass:: torchjd.aggregation.GradDrop - :members: - :undoc-members: - :exclude-members: forward diff --git a/docs/source/docs/aggregation/gradvac.rst b/docs/source/docs/aggregation/gradvac.rst index 1c2a7d0ae..471afc003 100644 --- a/docs/source/docs/aggregation/gradvac.rst +++ b/docs/source/docs/aggregation/gradvac.rst @@ -4,11 +4,7 @@ GradVac ======= .. autoclass:: torchjd.aggregation.GradVac - :members: - :undoc-members: - :exclude-members: forward, eps, beta + :members: reset .. autoclass:: torchjd.aggregation.GradVacWeighting - :members: - :undoc-members: - :exclude-members: forward, eps, beta + :members: reset diff --git a/docs/source/docs/aggregation/imtl_g.rst b/docs/source/docs/aggregation/imtl_g.rst index 4fefeab82..482dd2de5 100644 --- a/docs/source/docs/aggregation/imtl_g.rst +++ b/docs/source/docs/aggregation/imtl_g.rst @@ -4,11 +4,5 @@ IMTL-G ====== .. autoclass:: torchjd.aggregation.IMTLG - :members: - :undoc-members: - :exclude-members: forward .. autoclass:: torchjd.aggregation.IMTLGWeighting - :members: - :undoc-members: - :exclude-members: forward diff --git a/docs/source/docs/aggregation/index.rst b/docs/source/docs/aggregation/index.rst index 0dbdab0c8..73442a93f 100644 --- a/docs/source/docs/aggregation/index.rst +++ b/docs/source/docs/aggregation/index.rst @@ -8,23 +8,13 @@ Abstract base classes --------------------- .. autoclass:: torchjd.aggregation.Aggregator - :members: - :undoc-members: - :exclude-members: forward .. autoclass:: torchjd.aggregation.Weighting - :members: - :undoc-members: - :exclude-members: forward .. autoclass:: torchjd.aggregation.GeneralizedWeighting - :members: - :undoc-members: - :exclude-members: forward .. autoclass:: torchjd.aggregation.Stateful - :members: - :undoc-members: + :members: reset .. toctree:: diff --git a/docs/source/docs/aggregation/krum.rst b/docs/source/docs/aggregation/krum.rst index b869d91bf..6cf4bb07c 100644 --- a/docs/source/docs/aggregation/krum.rst +++ b/docs/source/docs/aggregation/krum.rst @@ -4,11 +4,5 @@ Krum ==== .. autoclass:: torchjd.aggregation.Krum - :members: - :undoc-members: - :exclude-members: forward .. autoclass:: torchjd.aggregation.KrumWeighting - :members: - :undoc-members: - :exclude-members: forward diff --git a/docs/source/docs/aggregation/mean.rst b/docs/source/docs/aggregation/mean.rst index 35117ef90..848c820e1 100644 --- a/docs/source/docs/aggregation/mean.rst +++ b/docs/source/docs/aggregation/mean.rst @@ -4,11 +4,5 @@ Mean ==== .. autoclass:: torchjd.aggregation.Mean - :members: - :undoc-members: - :exclude-members: forward .. autoclass:: torchjd.aggregation.MeanWeighting - :members: - :undoc-members: - :exclude-members: forward diff --git a/docs/source/docs/aggregation/mgda.rst b/docs/source/docs/aggregation/mgda.rst index ec3910eda..06f67cceb 100644 --- a/docs/source/docs/aggregation/mgda.rst +++ b/docs/source/docs/aggregation/mgda.rst @@ -4,11 +4,5 @@ MGDA ==== .. autoclass:: torchjd.aggregation.MGDA - :members: - :undoc-members: - :exclude-members: forward .. autoclass:: torchjd.aggregation.MGDAWeighting - :members: - :undoc-members: - :exclude-members: forward diff --git a/docs/source/docs/aggregation/nash_mtl.rst b/docs/source/docs/aggregation/nash_mtl.rst index e95ddea91..a23f25bbd 100644 --- a/docs/source/docs/aggregation/nash_mtl.rst +++ b/docs/source/docs/aggregation/nash_mtl.rst @@ -4,6 +4,4 @@ Nash-MTL ======== .. autoclass:: torchjd.aggregation.NashMTL - :members: - :undoc-members: - :exclude-members: forward + :members: reset diff --git a/docs/source/docs/aggregation/pcgrad.rst b/docs/source/docs/aggregation/pcgrad.rst index 2fff53cbc..5d59c8853 100644 --- a/docs/source/docs/aggregation/pcgrad.rst +++ b/docs/source/docs/aggregation/pcgrad.rst @@ -4,11 +4,5 @@ PCGrad ====== .. autoclass:: torchjd.aggregation.PCGrad - :members: - :undoc-members: - :exclude-members: forward .. autoclass:: torchjd.aggregation.PCGradWeighting - :members: - :undoc-members: - :exclude-members: forward diff --git a/docs/source/docs/aggregation/random.rst b/docs/source/docs/aggregation/random.rst index c96a648e7..1b1a0e289 100644 --- a/docs/source/docs/aggregation/random.rst +++ b/docs/source/docs/aggregation/random.rst @@ -4,11 +4,5 @@ Random ====== .. autoclass:: torchjd.aggregation.Random - :members: - :undoc-members: - :exclude-members: forward .. autoclass:: torchjd.aggregation.RandomWeighting - :members: - :undoc-members: - :exclude-members: forward diff --git a/docs/source/docs/aggregation/sum.rst b/docs/source/docs/aggregation/sum.rst index aacdaf0eb..b24003222 100644 --- a/docs/source/docs/aggregation/sum.rst +++ b/docs/source/docs/aggregation/sum.rst @@ -4,11 +4,5 @@ Sum === .. autoclass:: torchjd.aggregation.Sum - :members: - :undoc-members: - :exclude-members: forward .. autoclass:: torchjd.aggregation.SumWeighting - :members: - :undoc-members: - :exclude-members: forward diff --git a/docs/source/docs/aggregation/trimmed_mean.rst b/docs/source/docs/aggregation/trimmed_mean.rst index e7f5abd8c..b332662b4 100644 --- a/docs/source/docs/aggregation/trimmed_mean.rst +++ b/docs/source/docs/aggregation/trimmed_mean.rst @@ -4,6 +4,3 @@ Trimmed Mean ============ .. autoclass:: torchjd.aggregation.TrimmedMean - :members: - :undoc-members: - :exclude-members: forward diff --git a/docs/source/docs/aggregation/upgrad.rst b/docs/source/docs/aggregation/upgrad.rst index bc3806eca..a44a46e1c 100644 --- a/docs/source/docs/aggregation/upgrad.rst +++ b/docs/source/docs/aggregation/upgrad.rst @@ -4,11 +4,5 @@ UPGrad ====== .. autoclass:: torchjd.aggregation.UPGrad - :members: - :undoc-members: - :exclude-members: forward .. autoclass:: torchjd.aggregation.UPGradWeighting - :members: - :undoc-members: - :exclude-members: forward