Skip to content

Commit

Permalink
Merge pull request #124 from TorchJD/improve-aggregation-doc
Browse files Browse the repository at this point in the history
Improve introduction to the base class Aggregator in doc
  • Loading branch information
ValerianRey authored Sep 4, 2024
2 parents 7b75cb6 + d00f44e commit 929be29
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/source/docs/aggregation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ In the context of JD, the matrix to aggregate is a Jacobian whose rows are the g
individual objectives. The aggregator is used to reduce this matrix into an update vector for the
parameters of the model

This package provides several aggregators from the literature:
In TorchJD, an aggregator is a class that inherits from the abstract class
:doc:`Aggregator <bases>`. We provide the following list of aggregators from the literature:

.. role:: raw-html(raw)
:format: html
Expand All @@ -21,7 +22,7 @@ This package provides several aggregators from the literature:
:widths: 25 15 15 15
:header-rows: 1

* - :doc:`Aggregator (abstract) <bases>`
* - :doc:`Aggregator <bases>`
- :ref:`Non-conflicting <Non-conflicting>`
- :ref:`Linear under scaling <Linear under scaling>`
- :ref:`Weighted <Weighted>`
Expand Down

0 comments on commit 929be29

Please sign in to comment.