Skip to content

docs: Improve Aggregator contribution guidelines #642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ValerianRey wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −3
Open

docs: Improve Aggregator contribution guidelines #642

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,9 +208,15 @@ the context of Jacobian descent, it is used to reduce a Jacobian matrix into a v
used to update the parameters. In TorchJD, an `Aggregator` subclass should be a faithful
implementation of a mathematical aggregator.

> [!WARNING]
> Currently, we only accept aggregators that have the same interface as the `Aggregator` base class.
> We do not support stateful aggregators yet, so the proposed aggregators **must be immutable**.
> [!NOTE]
> We now also accept stateful aggregators, whose output depends both on the Jacobian and on some
> internal state (which can be affected for example by previous Jacobians).

> [!NOTE]
> Some aggregators may depend on something else than the Jacobian. To implement them, please add
> setters so that any extra information can be given by the user to the aggregator before it is
> actually used. For example, if your aggregator needs to take the loss values, this can be given
> at every iteration through a `set_losses` setter.

> [!NOTE]
> Before working on the implementation of a new aggregator, please contact us via an issue or a
Expand Down
Loading