refactor: Make more things protected (#350)

* Make Aggregator modules protected
* Make WeightedAggregator and GramianWeightedAggregator public
* Make autojac modules protected
* Make autojac protected
* Make Transforms protected
* Update rst files to use the new paths for newly protected modules
* Add changelog entry

Author: ValerianRey

CHANGELOG.md

@@ -14,6 +14,13 @@ changes that do not affect the user.
   TorchJD. Users of these aggregators will have to use `pip install torchjd[cagrad]`, `pip install
   torchjd[nash_mtl]` or `pip install torchjd[full]` to install TorchJD alongside those dependencies.
   This should make TorchJD more lightweight.
+- **BREAKING**: Made the aggregator modules and the `autojac` package protected. The aggregators
+  must now always be imported via their package (e.g.
+  `from torchjd.aggregation.upgrad import UPGrad` must be changed to
+  `from torchjd.aggregation import UPGrad`). The `backward` and `mtl_backward` functions must now
+  always be imported directly from the `torchjd` package (e.g.
+  `from torchjd.autojac.mtl_backward import mtl_backward` must be changed to
+  `from torchjd import mtl_backward`).
 
 ### Fixed
 

docs/source/docs/aggregation/aligned_mtl.rst

@@ -3,7 +3,7 @@
 Aligned-MTL
 ===========
 
-.. automodule:: torchjd.aggregation.aligned_mtl
+.. autoclass:: torchjd.aggregation.AlignedMTL
     :members:
     :undoc-members:
     :exclude-members: forward

docs/source/docs/aggregation/bases.rst

@@ -3,7 +3,7 @@
 Aggregator (abstract)
 =====================
 
-.. automodule:: torchjd.aggregation.aggregator_bases
+.. autoclass:: torchjd.aggregation.Aggregator
     :members:
     :undoc-members:
     :show-inheritance:

docs/source/docs/aggregation/cagrad.rst

@@ -3,7 +3,7 @@
 CAGrad
 ======
 
-.. automodule:: torchjd.aggregation.cagrad
+.. autoclass:: torchjd.aggregation.CAGrad
     :members:
     :undoc-members:
     :exclude-members: forward

docs/source/docs/aggregation/config.rst

@@ -3,7 +3,7 @@
 ConFIG
 ======
 
-.. automodule:: torchjd.aggregation.config
+.. autoclass:: torchjd.aggregation.ConFIG
     :members:
     :undoc-members:
     :exclude-members: forward

docs/source/docs/aggregation/constant.rst

@@ -3,7 +3,7 @@
 Constant
 ========
 
-.. automodule:: torchjd.aggregation.constant
+.. autoclass:: torchjd.aggregation.Constant
     :members:
     :undoc-members:
     :exclude-members: forward

docs/source/docs/aggregation/dualproj.rst

@@ -3,7 +3,7 @@
 DualProj
 ========
 
-.. automodule:: torchjd.aggregation.dualproj
+.. autoclass:: torchjd.aggregation.DualProj
     :members:
     :undoc-members:
     :exclude-members: forward

docs/source/docs/aggregation/graddrop.rst

@@ -3,7 +3,7 @@
 GradDrop
 ========
 
-.. automodule:: torchjd.aggregation.graddrop
+.. autoclass:: torchjd.aggregation.GradDrop
     :members:
     :undoc-members:
     :exclude-members: forward

docs/source/docs/aggregation/imtl_g.rst

@@ -3,7 +3,7 @@
 IMTL-G
 ======
 
-.. automodule:: torchjd.aggregation.imtl_g
+.. autoclass:: torchjd.aggregation.IMTLG
     :members:
     :undoc-members:
     :exclude-members: forward

docs/source/docs/aggregation/krum.rst

@@ -3,7 +3,7 @@
 Krum
 ====
 
-.. automodule:: torchjd.aggregation.krum
+.. autoclass:: torchjd.aggregation.Krum
     :members:
     :undoc-members:
     :exclude-members: forward