From 149e2b8695b0732296464a080fafb31b0e5d6a63 Mon Sep 17 00:00:00 2001
From: Paul Andrey <paul.andrey@inria.fr>
Date: Thu, 18 Jul 2024 14:58:17 +0200
Subject: [PATCH] Fix some docstring typos.
---
declearn/fairness/fairbatch/__init__.py | 4 ++--
declearn/fairness/fairfed/__init__.py | 2 +-
declearn/fairness/fairfed/_server.py | 2 +-
declearn/optimizer/schedulers/__init__.py | 4 ++--
4 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/declearn/fairness/fairbatch/__init__.py b/declearn/fairness/fairbatch/__init__.py
index 31ba338..4cc03a7 100644
--- a/declearn/fairness/fairbatch/__init__.py
+++ b/declearn/fairness/fairbatch/__init__.py
@@ -52,10 +52,10 @@ More details may be found in the documentation of `FairbatchDataset`
Controllers
-----------
* [FairbatchControllerClient]
-[declearn.fairness.fairbatch.FairgradControllerClient]:
+[declearn.fairness.fairbatch.FairbatchControllerClient]:
Client-side controller to implement Fed-FairBatch or FedFB.
* [FairbatchControllerServer]
-[declearn.fairness.fairbatch.FairgradControllerServer]:
+[declearn.fairness.fairbatch.FairbatchControllerServer]:
Server-side controller to implement Fed-FairBatch or FedFB.
Backend
diff --git a/declearn/fairness/fairfed/__init__.py b/declearn/fairness/fairfed/__init__.py
index 0185d99..077601e 100644
--- a/declearn/fairness/fairfed/__init__.py
+++ b/declearn/fairness/fairfed/__init__.py
@@ -67,7 +67,7 @@ Messages
References
----------
- [1]
- Eszzeldin et al. (2021).
+ Ezzeldin et al. (2021).
FairFed: Enabling Group Fairness in Federated Learning
https://arxiv.org/abs/2110.00857
"""
diff --git a/declearn/fairness/fairfed/_server.py b/declearn/fairness/fairfed/_server.py
index 1d66a7e..8bb5625 100644
--- a/declearn/fairness/fairfed/_server.py
+++ b/declearn/fairness/fairfed/_server.py
@@ -74,7 +74,7 @@ class FairfedControllerServer(FairnessControllerServer):
References
----------
- [1]
- Eszzeldin et al. (2021).
+ Ezzeldin et al. (2021).
FairFed: Enabling Group Fairness in Federated Learning
https://arxiv.org/abs/2110.00857
"""
diff --git a/declearn/optimizer/schedulers/__init__.py b/declearn/optimizer/schedulers/__init__.py
index 624d08c..141782d 100644
--- a/declearn/optimizer/schedulers/__init__.py
+++ b/declearn/optimizer/schedulers/__init__.py
@@ -61,9 +61,9 @@ Cyclic rate rules
Warmup schedulers
-----------------
-* [Warmup][declearn.optimizers.schedulers.Warmup]:
+* [Warmup][declearn.optimizer.schedulers.Warmup]:
Scheduler (wrapper) setting up a linear warmup over steps.
-* [WarmupRounds][declearn.optimizers.schedulers.WarmupRounds]:
+* [WarmupRounds][declearn.optimizer.schedulers.WarmupRounds]:
Scheduler (wrapper) setting up a linear warmup over rounds.
"""
--
GitLab