deploy: SimplexLab/TorchJD@e9a5016

Author: ValerianRey

latest/_sources/docs/aggregation/index.rst.txt

@@ -19,10 +19,6 @@ Abstract base classes
 .. autoclass:: torchjd.aggregation.Weighting
     :members: __call__
 
-.. autoclass:: torchjd.aggregation.Stateful
-    :members: reset
-
-
 .. toctree::
     :hidden:
     :maxdepth: 1

latest/_sources/docs/scalarization/index.rst.txt

@@ -10,7 +10,6 @@ Abstract base class
 .. autoclass:: torchjd.scalarization.Scalarizer
     :members: __call__
 
-
 .. toctree::
     :hidden:
     :maxdepth: 1
@@ -21,3 +20,4 @@ Abstract base class
     random.rst
     stch.rst
     sum.rst
+    uw.rst

latest/_sources/docs/scalarization/uw.rst.txt

@@ -0,0 +1,7 @@
+:hide-toc:
+
+UW
+==
+
+.. autoclass:: torchjd.scalarization.UW
+    :members: __call__, reset

latest/_sources/docs/stateful.rst.txt

@@ -0,0 +1,4 @@
+:orphan:
+
+.. autoclass:: torchjd.Stateful
+    :members: reset

latest/_sources/examples/grouping.rst.txt

@@ -19,8 +19,8 @@ the parameters:
 
 In TorchJD, grouping is achieved by calling :func:`~torchjd.autojac.jac_to_grad` once per group
 after :func:`~torchjd.autojac.backward` or :func:`~torchjd.autojac.mtl_backward`, with a dedicated
-aggregator instance per group. For :class:`~torchjd.aggregation.Stateful` aggregators, each instance
-should independently maintain its own state (e.g. the EMA :math:`\hat{\phi}` state in
+aggregator instance per group. For :class:`~torchjd.Stateful` aggregators, each instance should
+independently maintain its own state (e.g. the EMA :math:`\hat{\phi}` state in
 :class:`~torchjd.aggregation.GradVac`, matching the per-block targets from the original paper).
 
 .. note::

latest/docs/aggregation/aligned_mtl/index.html

@@ -264,6 +264,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../../scalarization/random/">Random</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../scalarization/stch/">STCH</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../scalarization/sum/">Sum</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../scalarization/uw/">UW</a></li>
 </ul>
 </li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../linalg/">linalg</a><input aria-label="Toggle navigation of linalg" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>

latest/docs/aggregation/cagrad/index.html

@@ -264,6 +264,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../../scalarization/random/">Random</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../scalarization/stch/">STCH</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../scalarization/sum/">Sum</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../scalarization/uw/">UW</a></li>
 </ul>
 </li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../linalg/">linalg</a><input aria-label="Toggle navigation of linalg" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>

latest/docs/aggregation/config/index.html

@@ -264,6 +264,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../../scalarization/random/">Random</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../scalarization/stch/">STCH</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../scalarization/sum/">Sum</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../scalarization/uw/">UW</a></li>
 </ul>
 </li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../linalg/">linalg</a><input aria-label="Toggle navigation of linalg" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>

latest/docs/aggregation/constant/index.html

@@ -264,6 +264,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../../scalarization/random/">Random</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../scalarization/stch/">STCH</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../scalarization/sum/">Sum</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../scalarization/uw/">UW</a></li>
 </ul>
 </li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../linalg/">linalg</a><input aria-label="Toggle navigation of linalg" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>

latest/docs/aggregation/cr_mogm/index.html

@@ -264,6 +264,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../../scalarization/random/">Random</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../scalarization/stch/">STCH</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../scalarization/sum/">Sum</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../scalarization/uw/">UW</a></li>
 </ul>
 </li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../linalg/">linalg</a><input aria-label="Toggle navigation of linalg" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
@@ -315,7 +316,7 @@ <h1>CR-MOGM<a class="headerlink" href="#cr-mogm" title="Link to this heading">¶
 <dl class="py class">
 <dt class="sig sig-object py" id="torchjd.aggregation.CRMOGMWeighting">
 <span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">torchjd.aggregation.</span></span><span class="sig-name descname"><span class="pre">CRMOGMWeighting</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">weighting</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alpha</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.9</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">initial_weights</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/SimplexLab/TorchJD/blob/main/src/torchjd/aggregation/_cr_mogm.py#L14-L155"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#torchjd.aggregation.CRMOGMWeighting" title="Link to this definition">¶</a></dt>
-<dd><p><a class="reference internal" href="../#torchjd.aggregation.Stateful" title="torchjd.aggregation._mixins.Stateful"><code class="xref py py-class docutils literal notranslate"><span class="pre">Stateful</span></code></a>
+<dd><p><a class="reference internal" href="../../stateful/#torchjd.Stateful" title="torchjd.Stateful"><code class="xref py py-class docutils literal notranslate"><span class="pre">Stateful</span></code></a>
 <a class="reference internal" href="../#torchjd.aggregation.Weighting" title="torchjd.aggregation._weighting_bases.Weighting"><code class="xref py py-class docutils literal notranslate"><span class="pre">Weighting</span></code></a> that wraps another
 <a class="reference internal" href="../#torchjd.aggregation.Weighting" title="torchjd.aggregation._weighting_bases.Weighting"><code class="xref py py-class docutils literal notranslate"><span class="pre">Weighting</span></code></a> and stabilises the weights it
 produces with an exponential moving average (EMA) across calls. This is the weight-smoothing
@@ -354,7 +355,7 @@ <h1>CR-MOGM<a class="headerlink" href="#cr-mogm" title="Link to this heading">¶
 themselves, so wrapping by <code class="docutils literal notranslate"><span class="pre">CRMOGMWeighting</span></code> will have no effect.</p>
 <p>This weighting is stateful: it keeps <span class="math notranslate nohighlight">\(\lambda_{k-1}\)</span> across calls. Use <a class="reference internal" href="#torchjd.aggregation.CRMOGMWeighting.reset" title="torchjd.aggregation.CRMOGMWeighting.reset"><code class="xref py py-meth docutils literal notranslate"><span class="pre">reset()</span></code></a>
 to restart the smoothing from the initial state. Note that calling <a class="reference internal" href="#torchjd.aggregation.CRMOGMWeighting.reset" title="torchjd.aggregation.CRMOGMWeighting.reset"><code class="xref py py-meth docutils literal notranslate"><span class="pre">reset()</span></code></a> will also
-reset the wrapped weighting if it is <a class="reference internal" href="../#torchjd.aggregation.Stateful" title="torchjd.aggregation.Stateful"><code class="xref py py-class docutils literal notranslate"><span class="pre">Stateful</span></code></a>.</p>
+reset the wrapped weighting if it is <a class="reference internal" href="../../stateful/#torchjd.Stateful" title="torchjd.Stateful"><code class="xref py py-class docutils literal notranslate"><span class="pre">Stateful</span></code></a>.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
@@ -397,7 +398,7 @@ <h1>CR-MOGM<a class="headerlink" href="#cr-mogm" title="Link to this heading">¶
 <dt class="sig sig-object py" id="torchjd.aggregation.CRMOGMWeighting.reset">
 <span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/SimplexLab/TorchJD/blob/main/src/torchjd/aggregation/_cr_mogm.py#L120-L128"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#torchjd.aggregation.CRMOGMWeighting.reset" title="Link to this definition">¶</a></dt>
 <dd><p>Clears the EMA state so the next forward restarts from the initial state. Also resets the
-wrapped weighting if it is <a class="reference internal" href="../#torchjd.aggregation.Stateful" title="torchjd.aggregation._mixins.Stateful"><code class="xref py py-class docutils literal notranslate"><span class="pre">Stateful</span></code></a>.</p>
+wrapped weighting if it is <a class="reference internal" href="../../stateful/#torchjd.Stateful" title="torchjd.Stateful"><code class="xref py py-class docutils literal notranslate"><span class="pre">Stateful</span></code></a>.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
 <dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p>