Skip to content

Add simulation_guidelines field to conversation simulation#20449

Merged
smoorjani merged 5 commits intomlflow:masterfrom
smoorjani:simulation_guidelines
Feb 11, 2026
Merged

Add simulation_guidelines field to conversation simulation#20449
smoorjani merged 5 commits intomlflow:masterfrom
smoorjani:simulation_guidelines

Conversation

@smoorjani
Copy link
Collaborator

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

How is this PR tested?

  • Existing unit/integration tests
  • New unit/integration tests
  • Manual tests

Does this PR require documentation update?

  • No. You can skip the rest of this section.
  • Yes. I've updated:
    • Examples
    • API references
    • Instructions

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release notes for MLflow users.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

  • area/tracking: Tracking Service, tracking client APIs, autologging
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/scoring: MLflow Model server, model deployment tools, Spark UDFs
  • area/evaluation: MLflow model evaluation features, evaluation metrics, and evaluation workflows
  • area/gateway: MLflow AI Gateway client APIs, server, and third-party integrations
  • area/prompts: MLflow prompt engineering features, prompt templates, and prompt management
  • area/tracing: MLflow Tracing features, tracing APIs, and LLM tracing functionality
  • area/projects: MLproject format, project running backends
  • area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
  • area/build: Build and test infrastructure for MLflow
  • area/docs: MLflow documentation pages

How should the PR be classified in the release notes? Choose one:

  • rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
  • rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • rn/feature - A new user-facing feature worth mentioning in the release notes
  • rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
  • rn/documentation - A user-facing documentation change worth mentioning in the release notes

Should this PR be included in the next patch release?

Yes should be selected for bug fixes, documentation updates, and other small changes. No should be selected for new features and larger changes. If you're unsure about the release classification of this PR, leave this unchecked to let the maintainers decide.

What is a minor/patch release?
  • Minor release: a release that increments the second part of the version number (e.g., 1.2.0 -> 1.3.0).
    Bug fixes, doc updates and new features usually go into minor releases.
  • Patch release: a release that increments the third part of the version number (e.g., 1.2.0 -> 1.2.1).
    Bug fixes and doc updates usually go into patch releases.
  • Yes (this PR will be cherry-picked and included in the next patch release)
  • No (this PR will be included in the next minor release)

@github-actions
Copy link
Contributor

🛠 DevTools 🛠

Install mlflow from this PR

# mlflow
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/20449/merge
# mlflow-skinny
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/20449/merge#subdirectory=libs/skinny

For Databricks, use the following command:

%sh curl -LsSf https://raw.githubusercontent.com/mlflow/mlflow/HEAD/dev/install-skinny.sh | sh -s pull/20449/merge

@github-actions github-actions bot added area/evaluation MLflow Evaluation rn/none List under Small Changes in Changelogs. labels Jan 29, 2026
@smoorjani smoorjani force-pushed the simulation_guidelines branch 2 times, most recently from bd57847 to 56f534d Compare January 30, 2026 00:57
@smoorjani smoorjani requested a review from xsh310 January 30, 2026 00:58
@github-actions
Copy link
Contributor

github-actions bot commented Jan 30, 2026

Documentation preview for 288a4d8 is available at:

Changed Pages (2)

More info
  • Ignore this comment if this PR does not change the documentation.
  • The preview is updated when a new commit is pushed to this PR.
  • This comment was created by this workflow run.
  • The documentation was built by this workflow run.

persona: str
conversation_history: list[dict[str, Any]]
turn: int
simulation_guidelines: str | None = None
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm reading this example in slack:

"simulation_guidelines": [
  "In the first user turn, you should not specify any time period of your query.",
  "In the first user turn, you should not specify whether you want percentages or absolutes.",
]

Do we prefer list of strings or strings for simulation_guidelines? And also in this example, I'm not sure the user agent directly have information of which turn is the current turn (maybe it is able to infer it from conversation history). But we need to worry about the case where guideline is specific to the turn number or other metadata?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call! I think list of strings makes most sense, but we can support str as syntactic sugar.

Copy link
Collaborator

@xsh310 xsh310 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good, left a few comments. It might be good to have some feedback from @dbczumar on this as well?

Copy link
Collaborator

@dbczumar dbczumar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@smoorjani LGTM once:

  • Comments are addressed
  • We add an example of how to use this field to the MLflow GenAI docs

@smoorjani smoorjani force-pushed the simulation_guidelines branch 2 times, most recently from d2a608a to 5e71f29 Compare February 10, 2026 06:17
smoorjani and others added 4 commits February 10, 2026 14:24
Signed-off-by: Samraj Moorjani <samraj.moorjani@databricks.com>
- Add simulation_guidelines field to generate_test_cases distillation
- Add guidance in simulator prompts clarifying guidelines describe user
  behavior, not assistant behavior (fixes role confusion)
- Update distillation prompt to extract information withholding patterns,
  implicit expectations, and pacing from conversations

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Samraj Moorjani <samraj.moorjani@databricks.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Samraj Moorjani <samraj.moorjani@databricks.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Samraj Moorjani <samraj.moorjani@databricks.com>
@smoorjani smoorjani force-pushed the simulation_guidelines branch from 8198bfa to 1167447 Compare February 10, 2026 22:33
…st_cases description

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Samraj Moorjani <samraj.moorjani@databricks.com>
@smoorjani smoorjani added this pull request to the merge queue Feb 11, 2026
Merged via the queue into mlflow:master with commit a66a9dd Feb 11, 2026
48 checks passed
@smoorjani smoorjani deleted the simulation_guidelines branch February 11, 2026 07:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/evaluation MLflow Evaluation rn/none List under Small Changes in Changelogs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants