Tune Experiment
===============

TuneExperiment
---------------

.. _tune-experiment-class:
.. autoclass:: ibm_watsonx_ai.experiment.fm_tune.TuneExperiment
   :members:
   :exclude-members:
   :undoc-members:
   :show-inheritance:

Tune Runs
---------

.. autoclass:: ibm_watsonx_ai.experiment.fm_tune.TuneRuns
   :members:
   :exclude-members:
   :undoc-members:
   :show-inheritance:

Prompt Tuner
------------

.. autoclass:: ibm_watsonx_ai.foundation_models.PromptTuner
   :members:
   :exclude-members: id
   :undoc-members:
   :show-inheritance:

Enums
-----

.. autoclass:: ibm_watsonx_ai.foundation_models.utils.enums.PromptTuningTypes
    :members:
    :undoc-members:
    :show-inheritance:

.. autoclass:: ibm_watsonx_ai.foundation_models.utils.enums.PromptTuningInitMethods
    :members:
    :undoc-members:
    :show-inheritance:

.. autoclass:: ibm_watsonx_ai.foundation_models.utils.enums.TuneExperimentTasks
    :members:
    :undoc-members:
    :show-inheritance:

.. class:: PromptTunableModels

    Bases: ``StrEnum``

    This represents a dynamically generated Enum for Prompt Tunable Models.

    **Example of getting PromptTunableModels:**

    .. code-block:: python

        # GET PromptTunableModels ENUM
        client.foundation_models.PromptTunableModels

        # PRINT dict of Enums
        client.foundation_models.PromptTunableModels.show()

    **Example Output:**

    .. code-block::

        {'FLAN_T5_XL': 'google/flan-t5-xl',
        'GRANITE_13B_INSTRUCT_V2': 'ibm/granite-13b-instruct-v2',
        'LLAMA_2_13B_CHAT': 'meta-llama/llama-2-13b-chat'}