From d00f44ea4aa3568979c0f4e2342234ebf3e0fc15 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Val=C3=A9rian=20Rey?= Date: Thu, 5 Sep 2024 00:36:36 +0200 Subject: [PATCH] Improve introduction to the base class Aggregator in aggregation/index.rst --- docs/source/docs/aggregation/index.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/source/docs/aggregation/index.rst b/docs/source/docs/aggregation/index.rst index 111e87e1..9f8ff5e5 100644 --- a/docs/source/docs/aggregation/index.rst +++ b/docs/source/docs/aggregation/index.rst @@ -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 `. We provide the following list of aggregators from the literature: .. role:: raw-html(raw) :format: html @@ -21,7 +22,7 @@ This package provides several aggregators from the literature: :widths: 25 15 15 15 :header-rows: 1 - * - :doc:`Aggregator (abstract) ` + * - :doc:`Aggregator ` - :ref:`Non-conflicting ` - :ref:`Linear under scaling ` - :ref:`Weighted `