3_optimization-design-ptn/03_prompt-optimization/promptwizard/glue/promptopt/utils.py

from ..common.exceptions import GlueValidaionException
from .constants import PromptOptimizationParams, PromptPool, SupportedPromptOpt
from .techniques.common_logic import PromptOptimizer
from .techniques.critique_n_refine.core_logic import CritiqueNRefine
from .techniques.critique_n_refine.base_classes import (
    CritiqueNRefineParams,
    CritiqueNRefinePromptPool,
)


def get_promptopt_class(
    prompt_technique_name: str,
) -> (PromptOptimizer, PromptOptimizationParams, PromptPool):
    """
    :params prompt_technique_name: Name of prompt optimization technique
    :return: Instance of class PromptRefinements, which is super class for all Prompt Optimization classes,
             Instance of class that holds all hyperparameters for that technique,
             Instance of class that holds all prompt strings for that techniques
    """
    prompt_technique_name = prompt_technique_name.lower()
    print(f"=== Prompt technique name: {prompt_technique_name} ===")
    if prompt_technique_name == SupportedPromptOpt.CRITIQUE_N_REFINE.value:
        return CritiqueNRefine, CritiqueNRefineParams, CritiqueNRefinePromptPool
    else:
        raise GlueValidaionException(
            f"Value provided for `prompt_technique_name` field in config yaml of "
            f"prompt manager is `{prompt_technique_name}`, which is not a valid name for "
            f"the prompt optimization techniques that we support. Please provide input as one "
            f"among the following:  {SupportedPromptOpt.all_values()}",
            None,
        )