Skip to content

Deprecate model logging of OpenAI flavor#19325

Merged
B-Step62 merged 6 commits intomlflow:masterfrom
TomeHirata:deprecate/openai/log-model
Dec 12, 2025
Merged

Deprecate model logging of OpenAI flavor#19325
B-Step62 merged 6 commits intomlflow:masterfrom
TomeHirata:deprecate/openai/log-model

Conversation

@TomeHirata
Copy link
Collaborator

@TomeHirata TomeHirata commented Dec 11, 2025 •
edited by github-actions bot
Loading

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

# mlflow
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/19325/merge
# mlflow-skinny
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/19325/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/19325/merge

Related Issues/PRs

n/a

What changes are proposed in this pull request?

The model logging of the OpenAI flavor is essentially for saving the prompt templates. Since we now have prompt registry, we want to deprecate the model logging capability of OpenAI flavor to simplify our offerings.

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)

@TomeHirata
Remove OpenAI flavor documentation and related files from the MLflow …
0108b8f 
…project, including guides, tutorials, and autologging support.

Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
@TomeHirata
Remove additional OpenAI tutorial images from the documentation, incl…
604e291 
…uding autologging and RLHF architecture visuals.

Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
Copilot AI review requested due to automatic review settings December 11, 2025 06:13
@github-actions github-actions bot added area/docs Documentation issues rn/documentation Mention under Documentation Changes in Changelogs. v3.7.1 labels Dec 11, 2025
@TomeHirata TomeHirata requested a review from B-Step62 December 11, 2025 06:15
@TomeHirata
Remove prompt engineering image from documentation
4be2308 
Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
@TomeHirata TomeHirata added the team-review Trigger a team review request label Dec 11, 2025
Copilot AI reviewed Dec 11, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request deprecates the model logging capability of the OpenAI flavor in MLflow, directing users to use the prompt registry instead (mlflow.genai.register_prompt). This change simplifies MLflow's offerings by focusing on the prompt registry for managing OpenAI prompt templates.

Key Changes:

  • Added deprecation decorators to save_model() and log_model() functions in the OpenAI flavor
  • Removed comprehensive OpenAI documentation including guides, tutorials, and notebooks
  • Removed OpenAI from the sidebar navigation and flavor index page

Reviewed changes

Copilot reviewed 11 out of 15 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
mlflow/openai/model.py Added @deprecated decorators to save_model() and log_model() functions directing users to mlflow.genai.register_prompt
docs/sidebarsGenAI.ts Removed the entire OpenAI section from the GenAI sidebar navigation (including guide, autologging, and tutorials)
docs/docs/genai/flavors/openai/notebooks/openai-quickstart.ipynb Deleted introductory tutorial notebook for OpenAI flavor
docs/docs/genai/flavors/openai/notebooks/openai-embeddings-generation.ipynb Deleted embeddings tutorial notebook
docs/docs/genai/flavors/openai/notebooks/openai-code-helper.ipynb Deleted code helper tutorial notebook
docs/docs/genai/flavors/openai/notebooks/openai-chat-completions.ipynb Deleted chat completions tutorial notebook
docs/docs/genai/flavors/openai/notebooks/index.mdx Deleted tutorials index page
docs/docs/genai/flavors/openai/index.mdx Deleted main OpenAI flavor landing page
docs/docs/genai/flavors/openai/guide/index.mdx Deleted detailed OpenAI guide documentation
docs/docs/genai/flavors/openai/autologging/index.mdx Deleted autologging documentation
docs/docs/genai/flavors/index.mdx Removed OpenAI reference from the GenAI flavors overview and logo card

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@TomeHirata
comment
dfa57ca 
Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
serena-ruan
serena-ruan reviewed Dec 11, 2025
View reviewed changes
serena-ruan
serena-ruan reviewed Dec 11, 2025
View reviewed changes
@TomeHirata
Update OpenAI model logging redirects and documentation to point to t…
4897bd7 
…he new MLflow Prompt Registry. Deprecate the `mlflow.openai.log_model()` API in favor of improved prompt management features.

Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
@TomeHirata
Remove OpenAI integration tile from the getting started documentation…
5384721 
… and update related OpenAI tracing documentation to clarify the tracking capabilities of MLflow. Adjustments made to enhance clarity and focus on the current features.

Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
@TomeHirata
Copy link
Collaborator Author

TomeHirata commented Dec 12, 2025

Tagged with 3.8.0, but not a blocker for RC

@github-actions
Copy link
Contributor

github-actions bot commented Dec 12, 2025

Documentation preview for 5384721 is available at:

Changed Pages (7)
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.

serena-ruan
serena-ruan approved these changes Dec 12, 2025
View reviewed changes
Copy link
Collaborator

@serena-ruan serena-ruan left a comment

Choose a reason for hiding this comment

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

LGTM!

@B-Step62 B-Step62 added this pull request to the merge queue Dec 12, 2025
Merged via the queue into mlflow:master with commit 7e16da9 Dec 12, 2025
67 of 69 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@serena-ruan serena-ruan serena-ruan approved these changes

@B-Step62 B-Step62 Awaiting requested review from B-Step62

@BenWilson2 BenWilson2 Awaiting requested review from BenWilson2

@daniellok-db daniellok-db Awaiting requested review from daniellok-db

@harupy harupy Awaiting requested review from harupy

@kevin-lyn kevin-lyn Awaiting requested review from kevin-lyn

@WeichenXu123 WeichenXu123 Awaiting requested review from WeichenXu123

@xq-yin xq-yin Awaiting requested review from xq-yin

Assignees

@serena-ruan serena-ruan

Labels

area/docs Documentation issues rn/documentation Mention under Documentation Changes in Changelogs. team-review Trigger a team review request v3.7.1 v3.8.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@TomeHirata @serena-ruan @B-Step62