Skip to content

Commit 70e0f7d

Browse files
committed
Fixed some of the docstrings that I forgot to update
1 parent bc6771a commit 70e0f7d

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

fl4health/clients/basic_client.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ def _log_header_str(
377377
) -> None:
378378
"""
379379
Logs a header string. By default this is logged at the beginning of each local
380-
epoch or at the beginning of training if
380+
epoch or at the beginning of the round if training by steps
381381
382382
Args:
383383
current_round (Optional[int], optional): The current FL round. (Ie current
@@ -442,7 +442,8 @@ def get_client_specific_logs(
442442
This function can be overridden to provide any client specific
443443
information to the basic client logging. For example, perhaps a client
444444
uses an LR scheduler and wants the LR to be logged each epoch. Called at the
445-
beginning or each round/epoch and at the end of each step.
445+
beginning and end of each server round or local epoch. Also called at the end
446+
of validation/testing.
446447
447448
Args:
448449
current_round (Optional[int]): The current FL round (i.e., current
@@ -454,12 +455,12 @@ def get_client_specific_logs(
454455
Returns:
455456
Optional[str]: A string to append to the header log string that
456457
typically announces the current server round and current epoch at the
457-
beginning of each round/epoch.
458+
beginning of each round or local epoch.
458459
Optional[List[Tuple[LogLevel, str]]]]: A list of tuples where the
459460
first element is a LogLevel as defined in fl4health.utils.
460461
typing and the second element is a string message. Each item
461-
in the list will be logged at the end of each step when
462-
self._log_results is called
462+
in the list will be logged at the end of each server round or epoch.
463+
Elements will also be logged at the end of validation/testing.
463464
"""
464465
return "", []
465466

research/picai/fl_nnunet/nnunet_client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -615,7 +615,7 @@ def get_properties(self, config: Config) -> Dict[str, Scalar]:
615615
self.maybe_extract_fingerprint()
616616

617617
# Create experiment planner and plans. Plans name must be temp_plans so that we
618-
# can safely delete the plans file generate by the experiment planner
618+
# can safely delete the plans file generated by the experiment planner
619619
planner = ExperimentPlanner(dataset_name_or_id=self.dataset_id, plans_name="temp_plans")
620620
with contextlib.redirect_stdout(None): # Prevent print statements from experiment planner
621621
plans = planner.plan_experiment()

0 commit comments

Comments
 (0)