flip_api.fl_services.initiate_training
======================================

.. py:module:: flip_api.fl_services.initiate_training


Attributes
----------

.. autoapisummary::

   flip_api.fl_services.initiate_training.router


Functions
---------

.. autoapisummary::

   flip_api.fl_services.initiate_training.initiate_training


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

.. py:data:: router

.. py:function:: initiate_training(model_id: uuid.UUID, payload: flip_api.domain.interfaces.fl.IInitiateTrainingInputPayload, request: fastapi.Request, db: sqlmodel.Session = Depends(get_session), user_id: uuid.UUID = Depends(verify_token)) -> None

   Initiate training for a model by adding it to the queue.

   This endpoint allows a user to initiate training for a specified model by adding it to the training queue.
   It checks if the user has access to the model and updates the model status accordingly.

   :param model_id: The ID of the model to initiate training for.
   :type model_id: UUID
   :param payload: The payload containing the ids of the trusts to train on.
   :type payload: IInitiateTrainingInputPayload
   :param request: The FastAPI request object.
   :type request: Request
   :param db: Database session.
   :type db: Session
   :param user_id: User ID from authentication.
   :type user_id: UUID

   :returns: None

   :raises HTTPException: If the user is not allowed, if the model does not exist, or if there is an
       error during the initiation process.