Add documentation request by David

VectorInstitute · Nov 25, 2024 · 426821e · 426821e
1 parent 660ad20
commit 426821e
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/fl4health/clients/nnunet_client.py b/fl4health/clients/nnunet_client.py
@@ -145,6 +145,7 @@ def __init__(
                 reporters which the client should send data to.
             nnunet_trainer_class (Type[nnUNetTrainer]): A nnUNetTrainer constructor.
                 Useful for passing custom nnUNetTrainer. Defaults to the standard nnUNetTrainer class.
+                Must match the nnunet_trainer_class passed to the NnunetServer.
             nnunet_trainer_class_kwargs (dict[str, Any]): Additonal kwargs to pass to nnunet_trainer_class.
                 Defaults to empty dictionary.
         """

diff --git a/fl4health/servers/nnunet_server.py b/fl4health/servers/nnunet_server.py
@@ -97,6 +97,7 @@ def __init__(
                 and throw an exception. Defaults to True.
             nnunet_trainer_class (Type[nnUNetTrainer]): nnUNetTrainer class.
                 Useful for passing custom nnUNetTrainer. Defaults to the standard nnUNetTrainer class.
+                Must match the nnunet_trainer_class passed to the NnunetClient.
         """
         FlServerWithCheckpointing.__init__(
             self,