nvflare.app_opt.pt.recipes.cyclic module¶

class CyclicRecipe(*, name: str = 'cyclic', initial_model: Any | None = None, num_rounds: int = 2, min_clients: int = 2, train_script: str, train_args: str = '', launch_external_process: bool = False, command: str = 'python3 -u', framework: FrameworkType = FrameworkType.PYTORCH, server_expected_format: ExchangeFormat = ExchangeFormat.NUMPY, params_transfer_type: TransferType = TransferType.FULL)[source]¶

Bases: CyclicRecipe

This is base class of a recipe. Recipes are implemented by jobs. A concrete recipe must provide the job for recipe implementation.

Parameters:: job – the job that implements the recipe.