flip.nvflare.controllers.fed_evaluation
=======================================

.. py:module:: flip.nvflare.controllers.fed_evaluation


Classes
-------

.. autoapisummary::

   flip.nvflare.controllers.fed_evaluation.ModelEval


Module Contents
---------------

.. py:class:: ModelEval(task_check_period=0.5, submit_model_timeout=600, validation_timeout: int = 6000, model_locator_id='', formatter_id='', submit_model_task_name=AppConstants.TASK_SUBMIT_MODEL, evaluation_task_name=PTConstants.EvalTaskName, cleanup_models=False, participating_clients=None, wait_for_clients_timeout=300, cleanup_timeout=600, fatal_error_delay=5, model_id='')

   Bases: :py:obj:`nvflare.apis.impl.controller.Controller`


   
   Model Evaluation workflow.

   :param task_check_period: How often to check for new tasks or tasks being finished.
                             Defaults to 0.5.
   :type task_check_period: float, optional
   :param submit_model_timeout: Timeout of submit_model_task. Defaults to 600 secs.
   :type submit_model_timeout: int, optional
   :param validation_timeout: Timeout for validate_model task. Defaults to 6000 secs.
   :type validation_timeout: int, optional
   :param model_locator_id: ID for model_locator component. Defaults to "".
   :type model_locator_id: str, optional
   :param formatter_id: ID for formatter component. Defaults to "".
   :type formatter_id: str, optional
   :param submit_model_task_name: Name of submit_model task. Defaults to "".
   :type submit_model_task_name: str, optional
   :param validation_task_name: Name of validate_model task. Defaults to "validate".
   :type validation_task_name: str, optional
   :param cleanup_models: Whether models should be deleted after run. Defaults to False.
   :type cleanup_models: bool, optional
   :param participating_clients: List of participating client names. If not provided, defaults
                                 to all clients connected at start of controller.
   :type participating_clients: list, optional
   :param wait_for_clients_timeout: Timeout for clients to appear. Defaults to 300 secs
   :type wait_for_clients_timeout: int, optional
   :param fatal_error_delay: Time in seconds to delay before calling 'system_panic'
                             if a task returns an error result and ignore_result_error is set to false
   :type fatal_error_delay: int, optional
   :param model_id: ID of the model that the training is being performed under.
   :type model_id: str, required


   .. py:attribute:: flip


   .. py:method:: start_controller(fl_ctx: nvflare.apis.fl_context.FLContext)


   .. py:method:: control_flow(abort_signal: nvflare.apis.signal.Signal, fl_ctx: nvflare.apis.fl_context.FLContext)


   .. py:method:: stop_controller(fl_ctx: nvflare.apis.fl_context.FLContext)


   .. py:method:: handle_event(event_type: str, fl_ctx: nvflare.apis.fl_context.FLContext)


   .. py:method:: process_result_of_unknown_task(client: nvflare.apis.client.Client, task_name: str, client_task_id: str, result: nvflare.apis.shareable.Shareable, fl_ctx: nvflare.apis.fl_context.FLContext)