flip.core.factory
=================

.. py:module:: flip.core.factory

.. autoapi-nested-parse::

   FLIP Factory.

   This module provides the FLIP() factory function that returns the appropriate
   FLIP implementation based on job type and environment.



Functions
---------

.. autoapisummary::

   flip.core.factory.FLIP


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

.. py:function:: FLIP(job_type: Union[flip.constants.job_types.JobType, flip.constants.job_types.JobTypeStr] = JobType.STANDARD, **kwargs) -> flip.core.base.FLIPBase

   Factory function to create appropriate FLIP instance based on job type.

   This is the main entry point for users to create FLIP instances.
   The factory automatically selects the correct implementation based on:

       1. The job type (standard, evaluation, fed_opt, diffusion_model)
       2. The environment (LOCAL_DEV or production)

   :param job_type: One of "standard", "evaluation", "fed_opt", "diffusion_model"
                    or a JobType enum value. Defaults to "standard".
   :param \*\*kwargs: Additional arguments passed to the constructor

   :returns: *FLIPBase* -- Appropriate FLIP instance for the job type and environment

   .. rubric:: Examples

   Create a standard FLIP instance:

   .. code-block:: python

       flip = FLIP()
       df = flip.get_dataframe(project_id, query)

   Create an evaluation-specific FLIP instance:

   .. code-block:: python

       flip = FLIP(job_type="evaluation")

   Use the enum-based job type:

   .. code-block:: python

       from flip.constants import JobType
       flip = FLIP(job_type=JobType.DIFFUSION)