-
Notifications
You must be signed in to change notification settings - Fork 15
Add RFC 0007: Scorer Presets with Customization and Persistence #13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 13 commits
3368d8e
38d98ef
00db80f
f42a950
4171a01
22f64f8
287c3cc
9710c79
040ecb7
4c6388c
6ab572e
5591ffa
6230d54
08619d7
58c2f72
fc7a127
1e9e87a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,282 @@ | ||||||
| --- | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [Not blocker for starting implementation] Can we also discuss UI surface for presets? Currently MLflow have It would be nice if the preset can also be listed and CRUD from UI, plus we list the three built-in presets are quickstart. It also help discoverability of the feature a lot. |
||||||
|
|
||||||
| ## start_date: 2026-04-23 | ||||||
|
|
||||||
| mlflow_issue: [https://github.com/mlflow/mlflow/issues/21445](https://github.com/mlflow/mlflow/issues/21445) | ||||||
| rfc_pr: | ||||||
|
|
||||||
| # Scorer Presets for Common Evaluation Patterns | ||||||
|
|
||||||
|
|
||||||
| | Author(s) | Nehanth | | ||||||
| | ---------------------- | ----------- | | ||||||
| | **Date Last Modified** | 2026-06-16 | | ||||||
| | **AI Assistant(s)** | Claude Code | | ||||||
|
|
||||||
|
|
||||||
| # Summary | ||||||
|
|
||||||
| > **Note:** This RFC is based on [mlflow/mlflow#21445](https://github.com/mlflow/mlflow/issues/21445). The motivation, proposed presets, and API examples are derived from that issue, with additional design details and implementation specifics added here. | ||||||
|
|
||||||
| MLflow provides 21 built-in scorers for evaluating GenAI outputs, but users have no way to select a coherent subset for a specific evaluation pattern. Today, evaluating an agent requires importing and instantiating 9+ individual scorer classes -- boilerplate that gets copy-pasted across teams and templates. | ||||||
|
|
||||||
| This RFC proposes a `Preset` class that packages a named collection of scorers with support for **customization** and **persistence**. MLflow ships three built-in preset subclasses (`Rag`, `Agent`, `ConversationalAgent`) as starting points. Users can create custom presets, persist them to the MLflow server, and share them across teams and sessions. Presets can be passed directly in the `scorers` list alongside individual scorers. | ||||||
|
|
||||||
| # Basic Example | ||||||
|
|
||||||
| ```python | ||||||
| import mlflow | ||||||
| from mlflow.genai.scorers import Agent | ||||||
|
|
||||||
| # Use a built-in preset directly | ||||||
| result = mlflow.genai.evaluate( | ||||||
| data=eval_dataset, | ||||||
| predict_fn=predict_fn, | ||||||
| scorers=[Agent()], | ||||||
| ) | ||||||
| ``` | ||||||
|
|
||||||
| ```python | ||||||
| # Mix presets and individual scorers | ||||||
| from mlflow.genai.scorers import Agent, Guidelines | ||||||
|
|
||||||
| result = mlflow.genai.evaluate( | ||||||
| data=eval_dataset, | ||||||
| predict_fn=predict_fn, | ||||||
| scorers=[Agent(), Guidelines(name="tone", guidelines=["Respond professionally"])], | ||||||
| ) | ||||||
| ``` | ||||||
|
|
||||||
| ```python | ||||||
| # Define a custom preset and persist it for team sharing | ||||||
| from mlflow.genai.scorers import Preset, Safety, Fluency | ||||||
|
|
||||||
| my_preset = Preset("my_team_eval", scorers=[Safety(), Fluency(), my_custom_scorer]) | ||||||
|
|
||||||
| # Register to MLflow server so the team can reuse it | ||||||
| my_preset.register() | ||||||
|
|
||||||
| # Later, another team member loads it | ||||||
| from mlflow.genai.scorers import get_preset | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
nit: to make API name self-explanatory |
||||||
|
|
||||||
| preset = get_preset(name="my_team_eval") | ||||||
| result = mlflow.genai.evaluate(data=eval_dataset, scorers=[preset]) | ||||||
| ``` | ||||||
|
|
||||||
| ## Motivation | ||||||
|
|
||||||
| ### The Problem | ||||||
|
|
||||||
| As described in [the original issue](https://github.com/mlflow/mlflow/issues/21445), the Databricks agent app template [evaluate_agent.py](https://github.com/databricks/app-templates/blob/main/agent-openai-agents-sdk/agent_server/evaluate_agent.py) imports and instantiates 9 separate scorers to evaluate a conversational agent: | ||||||
|
|
||||||
| ```python | ||||||
| from mlflow.genai.scorers import ( | ||||||
| Completeness, | ||||||
| ConversationalSafety, | ||||||
| ConversationCompleteness, | ||||||
| Fluency, | ||||||
| KnowledgeRetention, | ||||||
| RelevanceToQuery, | ||||||
| Safety, | ||||||
| ToolCallCorrectness, | ||||||
| UserFrustration, | ||||||
| ) | ||||||
|
|
||||||
| mlflow.genai.evaluate( | ||||||
| data=simulator, | ||||||
| predict_fn=predict_fn, | ||||||
| scorers=[ | ||||||
| Completeness(), | ||||||
| ConversationCompleteness(), | ||||||
| ConversationalSafety(), | ||||||
| KnowledgeRetention(), | ||||||
| UserFrustration(), | ||||||
| Fluency(), | ||||||
| RelevanceToQuery(), | ||||||
| Safety(), | ||||||
| ToolCallCorrectness(), | ||||||
| ], | ||||||
| ) | ||||||
| ``` | ||||||
|
|
||||||
| Every team building agent evaluation follows this same pattern. This creates three problems (from the [original issue](https://github.com/mlflow/mlflow/issues/21445)): | ||||||
|
|
||||||
| 1. **No built-in grouping.** `get_all_scorers()` returns all 19 default-constructible scorers. Users evaluating a RAG pipeline get `ToolCallCorrectness`; users evaluating an agent get `RetrievalGroundedness`. Each unnecessary scorer wastes an LLM API call. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. How would you feel about deferring the built-in groups and focus more on allowing custom presets to be persisted and optimize sharing? I feel like the built-in groups are somewhat subjective and the real benefit is from an organization's specific presets.
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Based on earlier feedback from @B-Step62, I already narrowed it down to just 3 (Rag, Agent, ConversationalAgent): these are just intro presets for new users getting started. Aside from that, the RFC is focused on customization and persistence as you suggested. |
||||||
| 2. **21 scorers to choose from.** Users must read documentation for each scorer to determine relevance. Session-level scorers (e.g., `KnowledgeRetention`) silently produce no results when passed to single-turn evaluation. | ||||||
| 3. **Copy-paste problem.** The same scorer lists get duplicated across templates, notebooks, and tutorials. When new scorers are added, existing lists don't pick them up. | ||||||
| 4. **No persistence or sharing.** Teams cannot save and share a curated set of scorers. Each team member independently assembles their own list, leading to drift across projects. | ||||||
|
|
||||||
| ### Who Benefits | ||||||
|
|
||||||
| - **New users** get a curated starting point without reading all 21 scorer docs | ||||||
| - **Teams** can define, persist, and share custom presets across sessions and team members | ||||||
| - **Template authors** replace hardcoded scorer lists with a single preset | ||||||
| - **MLflow maintainers** gain a single place to update when new scorers are added | ||||||
|
|
||||||
| ### Out of Scope | ||||||
|
|
||||||
| - **Third-party scorer presets.** Integrating presets for DeepEval, RAGAS, or TruLens scorers. | ||||||
|
|
||||||
| ## Detailed Design | ||||||
|
|
||||||
| ### The `Preset` Class | ||||||
|
|
||||||
| A `Preset` is a named, iterable container of scorers. It is **not** a `Scorer` subclass -- it is a grouping mechanism that gets flattened into individual scorers at validation time. | ||||||
|
|
||||||
| ```python | ||||||
| class Preset: | ||||||
| def __init__(self, name: str, scorers: list[Scorer]): ... | ||||||
| def register(self, *, experiment_id: str | None = None): ... | ||||||
| @property | ||||||
| def name(self) -> str: ... | ||||||
| @property | ||||||
| def scorers(self) -> tuple: ... | ||||||
| def __iter__(self): ... | ||||||
| def __len__(self): ... | ||||||
| def __repr__(self): ... | ||||||
| ``` | ||||||
|
|
||||||
| **Key design decisions:** | ||||||
|
|
||||||
| - **Immutable.** Scorers are stored as a tuple and exposed via a read-only property. | ||||||
| - **Blocks duplicates on construction.** `__init__` raises an error if duplicate scorers (same type and name) are passed. Users who need two scorers of the same type should give them different names. | ||||||
| - **Not a `Scorer` subclass.** A preset doesn't produce feedback -- it's a container. The evaluation loop assumes one scorer = one result column. | ||||||
| - **Stores instances, not classes.** Users pass already-configured scorer instances. | ||||||
|
|
||||||
| ### Built-in Presets as Subclasses | ||||||
|
|
||||||
| Each built-in preset is a subclass of `Preset` that hardcodes its scorer list. Each call creates **fresh scorer instances** (no shared mutable singletons) and supports preset-specific customization. See the Built-in Preset Summary table below for the scorers in each preset. | ||||||
|
|
||||||
| **Why subclasses over instances:** | ||||||
|
|
||||||
| - **Fresh instances every time.** `Agent()` creates new scorer instances on each call. No shared mutable state. | ||||||
| - **Preset-specific customization.** Each preset can accept its own parameters (e.g., `Agent(model="openai:/gpt-4o")` to set the judge model for all scorers). | ||||||
| - **Type checking.** `isinstance(preset, Agent)` works — code can distinguish which preset is being used. | ||||||
| - **Custom control flow.** Each preset can override methods for preset-specific validation or behavior. | ||||||
|
|
||||||
| ### Customization | ||||||
|
|
||||||
| Users can create custom presets with any combination of scorers: | ||||||
|
|
||||||
| ```python | ||||||
| my_preset = Preset("my_eval", scorers=[ | ||||||
| ToolCallCorrectness(), | ||||||
| Safety(), | ||||||
| Fluency(), | ||||||
| Guidelines(name="tone", guidelines=["Be professional"]), | ||||||
| my_custom_scorer, | ||||||
| ]) | ||||||
| ``` | ||||||
|
|
||||||
| ### Persistence | ||||||
|
|
||||||
| Presets can be registered to the MLflow server so teams can share them across sessions. This leverages the existing scorer registration infrastructure. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Persistence looks very useful to me. The API surface (
These don't need implementation details, just a description of the intended user experience.
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Added, I've addressed this from Line 232 |
||||||
|
|
||||||
| **Register a preset:** | ||||||
|
|
||||||
| ```python | ||||||
| my_preset = Preset("my_team_agent", scorers=[ | ||||||
| ToolCallCorrectness(), | ||||||
| Safety(), | ||||||
| Fluency(), | ||||||
| ]) | ||||||
|
|
||||||
| # Register to the active experiment | ||||||
| my_preset.register() | ||||||
|
|
||||||
| # Or register to a specific experiment | ||||||
| my_preset.register(experiment_id="123") | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we add a concept of versioning?
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, presets support versioning. Calling
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can I update a preset?
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes. Calling
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can I delete a preset?
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, added |
||||||
| ``` | ||||||
|
|
||||||
| **Preset CRUD API:** | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @Nehanth could you show the proposed API schema? How were you thinking of serializing the scorers and their config? |
||||||
|
|
||||||
| ```python | ||||||
| from mlflow.genai.scorers import get_preset, list_presets, delete_preset | ||||||
|
|
||||||
| # Load a preset | ||||||
| preset = get_preset(name="my_team_agent") | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What is the proposed return type of
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||||||
| preset = get_preset(name="my_team_agent", version=2) | ||||||
|
|
||||||
| # List all presets in the current experiment | ||||||
| presets = list_presets() | ||||||
|
|
||||||
| # Update a preset (registers a new version) | ||||||
| updated = Preset("my_team_agent", scorers=[Safety(), Fluency(), Completeness()]) | ||||||
| updated.register() | ||||||
|
|
||||||
| # Delete a preset | ||||||
| delete_preset(name="my_team_agent") | ||||||
|
|
||||||
| # Copy to another experiment | ||||||
| copy_preset(name="my_team_agent", from_experiment_id="123", to_experiment_id="456") | ||||||
|
|
||||||
| # Use in evaluation | ||||||
| result = mlflow.genai.evaluate(data=eval_dataset, scorers=[preset]) | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we do |
||||||
| ``` | ||||||
|
|
||||||
| **Why persistence matters:** | ||||||
|
|
||||||
| - **Version stability.** Persisted presets are snapshots — they don't change when MLflow upgrades. Built-in presets serve as starting points; teams persist their own versions for stability. | ||||||
| - **Team sharing.** A persisted preset is available to any team member with access to the experiment. | ||||||
| - **Customization without code.** Teams can customize and persist presets without modifying source code or templates. | ||||||
|
|
||||||
| **Persistence behavior:** | ||||||
|
|
||||||
| - **Scope.** Presets are scoped to experiments, consistent with how scorer registration already works in MLflow. This prevents name collisions across teams and ensures presets are organized alongside the experiments they evaluate. If no `experiment_id` is provided, the active experiment is used. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I see value with allow this to be scoped at the workspace level as well. At the very least, we should make it easy with the MLflow Python client to copy a preset to another experiment since an experiment typically maps to a single agent.
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Added
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: I guess we don't need Also one random thought - there are actually more entities that nice to be able to share across experiments (e.g. dataset, scorer itself, prompt, traces). I feel we can benefit from abstract |
||||||
| - **Custom scorer portability.** If a preset contains custom scorers, those scorers must be registered first. When a teammate loads the preset, the custom scorers are resolved from the registry. If a custom scorer is not registered, `preset.register()` will raise an error. | ||||||
| - **Discovery.** `list_presets()` returns all registered presets for the current experiment, allowing teams to discover what presets are available. This follows the same pattern as `list_scorers()`. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could you share more of the API shape you are thinking are get, list, and update?
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Added the full CRUD API: |
||||||
| - **Copying across experiments.** Since experiments typically map to a single agent, users should be able to copy a preset from one experiment to another via `copy_preset(name, from_experiment_id, to_experiment_id)`. | ||||||
| - **Versioning.** Presets support versioning, consistent with how scorer registration already works in MLflow. When a preset is updated, a new version is created. Users can load a specific version via `get_preset(name, version=N)` or default to the latest. | ||||||
| - **Return type.** `get_preset()` returns a `Preset` object with server-side metadata attached (experiment ID, version, created timestamp). The preset is fully functional — it can be iterated and passed to `evaluate()` like any other preset. | ||||||
|
|
||||||
| ### Built-in Preset Summary | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As mentioned previously, I think we can defer this section for now and focus on the persistence and versioning.
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same as above — keeping the three built-ins as starting points per @B-Step62's feedback, but the focus of the RFC is on the persistence and customization story.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yeah I think it's nice to have several built-in presets for educational purpose for this feature. |
||||||
|
|
||||||
| MLflow ships three built-in preset subclasses as starting points. Each call creates fresh scorer instances. Users can customize and persist their own presets. | ||||||
|
|
||||||
| | Preset | Scorers | Use Case | | ||||||
| | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | | ||||||
| | `Rag()` | RetrievalRelevance, RetrievalGroundedness, RelevanceToQuery, Safety, Completeness | Retrieval-augmented generation pipelines | | ||||||
| | `Agent()` | ToolCallCorrectness, ToolCallEfficiency, RelevanceToQuery, Safety, Completeness | Single-turn tool-calling agents | | ||||||
| | `ConversationalAgent()`| All of `Agent` + UserFrustration, ConversationCompleteness, ConversationalSafety, ConversationalToolCallEfficiency, KnowledgeRetention | Multi-turn conversational agents | | ||||||
|
|
||||||
|
|
||||||
| #### Design Rationale | ||||||
|
|
||||||
| - **Only three built-in presets** (Rag, Agent, ConversationalAgent) — these represent clear, distinct evaluation patterns. Users can create and persist their own groupings for specific needs. | ||||||
|
|
||||||
| ## Drawbacks | ||||||
|
|
||||||
| 1. **New class in the API.** Adds `Preset` to the public surface. Mitigation: it's a simple container with persistence support. | ||||||
| 2. **Opinionated defaults.** Not everyone will agree on which scorers belong in which preset. Mitigation: users can create and persist their own custom presets. | ||||||
| 3. **Persistence adds scope.** Supporting preset registration and retrieval increases implementation complexity. Mitigation: leverages the existing scorer registration infrastructure. | ||||||
|
|
||||||
| # Alternatives | ||||||
|
|
||||||
| ### 1. `get_preset()` function (no class) | ||||||
|
|
||||||
| Instead of a `Preset` class, provide a simple function that returns a plain list. Simpler to implement and can also support persistence via `register_preset()` / `get_preset()`. | ||||||
|
|
||||||
| ### 2. Tag-based filtering | ||||||
|
|
||||||
| Add `categories` to each scorer class and provide `get_scorers(categories=["rag"])`. More flexible but over-engineered for 21 scorers and requires modifying every existing class. | ||||||
|
|
||||||
| ### 3. Enum-based API | ||||||
|
|
||||||
| `ScorerPreset.RAG.get_scorers()`. Type-safe but heavier API surface. | ||||||
|
|
||||||
| ### 4. Do nothing | ||||||
|
|
||||||
| Users keep copy-pasting scorer lists. Does not scale as the scorer count grows. | ||||||
|
|
||||||
| # Adoption Strategy | ||||||
|
|
||||||
| This is an **additive, non-breaking change**. Existing code continues to work unchanged. | ||||||
|
|
||||||
| - Update documentation and templates to show `Preset` usage alongside the manual import pattern. | ||||||
| - Update the `validate_scorers()` error message to mention presets for discoverability. | ||||||
| - Databricks agent templates can simplify from 9 imports + 9 instantiations to `scorers=[ConversationalAgent()]`. | ||||||
| - Teams can persist their customized presets and share them across projects. | ||||||
|
|
||||||
| # Open Questions | ||||||
|
|
||||||
| 1. **Class-based vs function-based approach.** The class-based approach is proposed as the primary design for its ergonomics and customization support. The function-based approach is a viable alternative that may be more flexible for persistence. Both approaches were discussed during review. | ||||||
Uh oh!
There was an error while loading. Please reload this page.