# Tune v0.5.0 - API Reference

## Modules

- [Tune](Tune.md): Lazy evaluation and search pipelines for Elixir values and LLM programs.
- [Tune.Adapter](Tune.Adapter.md): A pure prompt format.
- [Tune.Adapter.Chat](Tune.Adapter.Chat.md): DSPy-style Chat format with `[[ ## field ## ]]` markers.
- [Tune.Adapter.JSON](Tune.Adapter.JSON.md): DSPy-style JSON format: marked inputs and a JSON object reply.
- [Tune.Adapter.XML](Tune.Adapter.XML.md): DSPy-style XML format with schema-directed field delimiters.
- [Tune.Artifact](Tune.Artifact.md): A versioned learned-value artifact with safe provenance.
- [Tune.Candidate](Tune.Candidate.md): A proposed value and its completed evaluation.
- [Tune.Case](Tune.Case.md): One normalized input and expected result.
- [Tune.Comparison](Tune.Comparison.md): The paired evidence for an original target and a search winner.
- [Tune.Demo](Tune.Demo.md): One demonstration: complete inputs and outputs for a signature.
- [Tune.Ensemble](Tune.Ensemble.md): A program that runs compatible member programs and reduces their outputs.
- [Tune.Error](Tune.Error.md): Structured errors owned by Tune.
- [Tune.Evaluation](Tune.Evaluation.md): The eager result of evaluating one target over one dataset.
- [Tune.Execution](Tune.Execution.md): Per-run state threaded through application program code.
- [Tune.Field](Tune.Field.md): One named, typed signature field.
- [Tune.KNN](Tune.KNN.md): A program that selects nearby training examples for each input.
- [Tune.ModelConfig](Tune.ModelConfig.md): One explicit, fixed model configuration: a ReqLLM model, a prompt adapter,
adapter options, and ReqLLM request options.
- [Tune.Observation](Tune.Observation.md): The scores and outcome for one evaluated case.
- [Tune.Optimizers.Anything](Tune.Optimizers.Anything.md): The Optimize.Anything target: GEPA-style search over one declared value.
- [Tune.Optimizers.Avatar](Tune.Optimizers.Avatar.md): Contrastive instruction improvement for one named predictor.
- [Tune.Optimizers.BootstrapFewShot](Tune.Optimizers.BootstrapFewShot.md): Builds demonstrations from successful teacher trajectories.
- [Tune.Optimizers.BootstrapFewShotWithOptuna](Tune.Optimizers.BootstrapFewShotWithOptuna.md): Searches example-set choices per predictor with categorical TPE.
- [Tune.Optimizers.BootstrapFewShotWithRandomSearch](Tune.Optimizers.BootstrapFewShotWithRandomSearch.md): Builds several seeded example sets and keeps the best validation result.
- [Tune.Optimizers.COPRO](Tune.Optimizers.COPRO.md): Coordinate instruction search over predictors.
- [Tune.Optimizers.Ensemble](Tune.Optimizers.Ensemble.md): Builds one compatible ensemble from the pipeline target and explicit members.
- [Tune.Optimizers.GEPA](Tune.Optimizers.GEPA.md): Reflective prompt evolution with Pareto selection and merge.
- [Tune.Optimizers.InferRules](Tune.Optimizers.InferRules.md): Derives natural-language rules from bootstrapped examples.
- [Tune.Optimizers.KNNFewShot](Tune.Optimizers.KNNFewShot.md): Returns a `Tune.KNN` program whose pool is the training set.
- [Tune.Optimizers.LabeledFewShot](Tune.Optimizers.LabeledFewShot.md): Uses up to `k` complete labeled training examples as demonstrations for each
predictor. Makes no model calls.
- [Tune.Optimizers.MIPROv2](Tune.Optimizers.MIPROv2.md): Joint search over instructions and example sets.
- [Tune.Optimizers.Playbook](Tune.Optimizers.Playbook.md): Learns a bounded list of lessons stored in a declared JSON parameter.
- [Tune.Optimizers.Proposals](Tune.Optimizers.Proposals.md): Typed internal predictors used by instruction, rule, and value optimizers.
- [Tune.Optimizers.Reflective](Tune.Optimizers.Reflective.md): The reflective evolutionary search shared by GEPA and Optimize.Anything.
- [Tune.Optimizers.SIMBA](Tune.Optimizers.SIMBA.md): Stochastic introspective mini-batch ascent.
- [Tune.Optimizers.SignatureOptimizer](Tune.Optimizers.SignatureOptimizer.md): Searches the instruction of one explicitly named predictor.
- [Tune.Optimizers.TPE](Tune.Optimizers.TPE.md): A categorical Tree-structured Parzen Estimator.
- [Tune.Parameter](Tune.Parameter.md): A tunable JSON value with a Zoi schema, such as a lesson list or candidate text.
- [Tune.Prediction](Tune.Prediction.md): The outcome of one target execution.
- [Tune.Predictor](Tune.Predictor.md): An immutable typed predictor: a signature and its demonstrations.
- [Tune.Prepared](Tune.Prepared.md): A rendered, inspectable request for one predictor call.
- [Tune.Program](Tune.Program.md): The contract for a typed Tune program.
- [Tune.Result](Tune.Result.md): The immutable result of a completed tuning run.
- [Tune.Runtime](Tune.Runtime.md): Runs a typed predictor or composed program on one input.
- [Tune.Score](Tune.Score.md): One named score declaration and its execution contract.
- [Tune.Score.Summary](Tune.Score.Summary.md): The aggregate for one named score.
- [Tune.Scores.ContextPrecision](Tune.Scores.ContextPrecision.md): A structured ReqLLM judge for retrieval-context precision.
- [Tune.Scores.Faithfulness](Tune.Scores.Faithfulness.md): A structured ReqLLM judge for grounded-response faithfulness.
- [Tune.Search.Program.Context](Tune.Search.Program.Context.md): Internal operations and program data for one search strategy.
- [Tune.Search.ProgramStrategy](Tune.Search.ProgramStrategy.md): An internal program-search algorithm.
- [Tune.Search.Study](Tune.Search.Study.md): Shared limits and accounting for Tune runs.
- [Tune.Signature](Tune.Signature.md): Ordered, typed input and output fields plus task instructions.
- [Tune.Space](Tune.Space.md): A value space used by search strategies.
- [Tune.Space.Choice](Tune.Space.Choice.md): A finite choice space.
- [Tune.Space.Float](Tune.Space.Float.md): A linear or logarithmic floating-point value space.
- [Tune.Space.Integer](Tune.Space.Integer.md): An integer value space.
- [Tune.Space.Subset](Tune.Space.Subset.md): A bounded subset of a finite list.
- [Tune.Space.Text](Tune.Space.Text.md): A bounded text space for simple evolutionary search.
- [Tune.Step](Tune.Step.md): One completed predictor call: its name, role, signature, actual inputs,
validated outputs, and the unchanged ReqLLM response.

- [Tune.UI](Tune.UI.md): Starts the optional local Tune workbench.
- [Tune.UI.Recipe](Tune.UI.Recipe.md): The application-code boundary used by the optional Tune UI.
- [Tune.UI.Recipes.SavedResponses](Tune.UI.Recipes.SavedResponses.md): Scores a saved single-turn dataset with both retrieval judges.
- [Tune.UI.Recipes.StructuredPrompt](Tune.UI.Recipes.StructuredPrompt.md): A UI-authored single-predictor Tune recipe.
- [Tune.UI.Registry](Tune.UI.Registry.md): Resolves workbench recipe IDs to trusted application modules.
- [Tune.UI.Router](Tune.UI.Router.md): The optional local workbench router.
- [Tune.UI.Run](Tune.UI.Run.md): An in-memory workbench run and its current outcome.
- [Tune.UI.Study](Tune.UI.Study.md): A data-only description of one workbench study.

- Exceptions
  - [Tune.Error.Execution](Tune.Error.Execution.md): Error class for runtime failures that retain partial results.
  - [Tune.Error.Execution.Callback](Tune.Error.Execution.Callback.md): Application code did not follow a Tune callback contract.
  - [Tune.Error.Execution.Failed](Tune.Error.Execution.Failed.md): A program run failed after it started.
  - [Tune.Error.Execution.LimitReached](Tune.Error.Execution.LimitReached.md): A managed limit stopped a call before dispatch.
  - [Tune.Error.Invalid](Tune.Error.Invalid.md): Error class for invalid definitions, options, and inputs.
  - [Tune.Error.Invalid.Dataset](Tune.Error.Invalid.Dataset.md): A dataset source failed while Tune was reading its rows.
  - [Tune.Error.Invalid.Definition](Tune.Error.Invalid.Definition.md): A signature, field, predictor, demonstration, or model configuration is invalid.
  - [Tune.Error.Invalid.Input](Tune.Error.Invalid.Input.md): Program inputs do not match the declared input fields.
  - [Tune.Error.Invalid.Option](Tune.Error.Invalid.Option.md): An option is unknown, forbidden, or has an invalid value.
  - [Tune.Error.Optimization.Failed](Tune.Error.Optimization.Failed.md): An optimization could not return an eligible program.
  - [Tune.Error.Output](Tune.Error.Output.md): Error class for model replies that cannot become a validated output.
  - [Tune.Error.Output.Invalid](Tune.Error.Output.Invalid.md): Parsed output values do not match the declared output schema.
  - [Tune.Error.Output.Parse](Tune.Error.Output.Parse.md): An adapter could not parse the reply into declared output fields.
  - [Tune.Error.Output.Rejected](Tune.Error.Output.Rejected.md): A ReqLLM response is not an acceptable completed reply.
  - [Tune.Error.Unknown](Tune.Error.Unknown.md): Error class for unexpected failures.
  - [Tune.Error.Unknown.Unknown](Tune.Error.Unknown.Unknown.md): An unexpected error.

## Mix Tasks

- [mix tune.ui](Mix.Tasks.Tune.Ui.md): Starts the optional local Tune workbench.

