​
run_experiment

def run_experiment(experiment_name: str,
                   *,
                   prompt_template: Optional[PromptTemplate] = None,
                   prompt_settings: Optional[PromptRunSettings] = None,
                   project: Optional[str] = None,
                   dataset: Optional[Union[Dataset, list[dict[str, str]],
                                           str]] = None,
                   dataset_id: Optional[str] = None,
                   dataset_name: Optional[str] = None,
                   metrics: Optional[list[Union[GalileoScorers, Metric,
                                                LocalMetricConfig,
                                                str]]] = None,
                   function: Optional[Callable] = None) -> Any
Run an experiment with the specified parameters. There are two ways to run an experiment:
  1. Using a prompt template, prompt settings, and a dataset
  2. Using a runner function and a dataset
When using a runner function, you can also pass a list of dictionaries to the function to act as a dataset. Arguments:
  • experiment_name: Name of the experiment
  • prompt_template: Template for prompts
  • prompt_settings: Settings for prompt runs
  • project: Project name
  • dataset: Dataset object, list of records, or dataset name
  • dataset_id: ID of the dataset
  • dataset_name: Name of the dataset
  • metrics: List of metrics to evaluate
  • function: Optional function to run with the experiment
Raises:
  • ValueError: If required parameters are missing or invalid
Returns: Experiment run results