Clean up the MLflow 3 docs content#18871
Conversation
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
|
Documentation preview for 626545a is available at: Changed Pages (8)
More info
|
docs/sidebarsGenAI.ts
Outdated
| { | ||
| type: 'category', | ||
| label: 'MLflow 3.0', | ||
| type: 'doc', |
There was a problem hiding this comment.
Can we move this to the bottom of the side bar? I don't think this should be the main page new ppl should see.
| ``` | ||
| pip install mlflow openai -U | ||
| ``` | ||
| - **Model Flavors**: The following flavors are no longer supported: |
There was a problem hiding this comment.
nit: Can we put a few more flavors we deprecated recently? It's not removed on 3.0, but probably it is helpful to have a comprehensive list.
docs/docs/genai/mlflow-3/index.mdx
Outdated
| result_1 = mlflow.evaluate(model_1, data) | ||
| result_2 = mlflow.evaluate(model_2, data) |
There was a problem hiding this comment.
| result_1 = mlflow.evaluate(model_1, data) | |
| result_2 = mlflow.evaluate(model_2, data) | |
| result_1 = mlflow.model.evaluate(model_1, data) | |
| result_2 = mlflow.model.evaluate(model_2, data) |
mlflow.model.evaluate should be used for classical ML. Also can we mention GenAI evaluation here and link to the dedicated migration guide here? https://mlflow.org/docs/latest/genai/eval-monitor/legacy-llm-evaluation/
Probably worth highlighting in the key changes section.
|
|
||
| ## What's New in MLflow 3? | ||
| ## Key Changes from MLflow 2.x | ||
|
|
There was a problem hiding this comment.
One common confusion I heard is that the "artifacts" tab in run page no longer shows model artifact, instead it is moved to logged model page. Can we add it to key changes.
|
|
||
| For detailed guidance on migrating specific code, please consult: | ||
|
|
||
| - [MLflow Documentation](https://mlflow.org/docs/latest) |
B-Step62
left a comment
There was a problem hiding this comment.
Overall looks good, let's move the sidebar position to prioritize getting started and main features first.
There was a problem hiding this comment.
@BenWilson2 Curious to hear your thoughts, but I realize most of this page is talking about classical ML side. Perhaps this should be surfaced within classical ML side and we don't really need it in GenAI side? Please don't take this as a strong suggestion, just popped up while reading through the contents:)
There was a problem hiding this comment.
I think that's how we originally had this presented anyway. I agree that the content here is irrelevant for GenAI. Redirect + removal from the GenAI sidebar SGTM
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com> Signed-off-by: Tian Lan <sky.blue266000@gmail.com>
🛠 DevTools 🛠
Install mlflow from this PR
For Databricks, use the following command:
Related Issues/PRs
#xxxWhat changes are proposed in this pull request?
Changes the MLflow 3 docs announcement content to more of a migration guide / FAQ.
How is this PR tested?
Does this PR require documentation update?
Release Notes
Is this a user-facing change?
What component(s), interfaces, languages, and integrations does this PR affect?
Components
area/tracking: Tracking Service, tracking client APIs, autologgingarea/models: MLmodel format, model serialization/deserialization, flavorsarea/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registryarea/scoring: MLflow Model server, model deployment tools, Spark UDFsarea/evaluation: MLflow model evaluation features, evaluation metrics, and evaluation workflowsarea/gateway: MLflow AI Gateway client APIs, server, and third-party integrationsarea/prompts: MLflow prompt engineering features, prompt templates, and prompt managementarea/tracing: MLflow Tracing features, tracing APIs, and LLM tracing functionalityarea/projects: MLproject format, project running backendsarea/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev serverarea/build: Build and test infrastructure for MLflowarea/docs: MLflow documentation pagesHow 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" sectionrn/breaking-change- The PR will be mentioned in the "Breaking Changes" sectionrn/feature- A new user-facing feature worth mentioning in the release notesrn/bug-fix- A user-facing bug fix worth mentioning in the release notesrn/documentation- A user-facing documentation change worth mentioning in the release notesShould this PR be included in the next patch release?
Yesshould be selected for bug fixes, documentation updates, and other small changes.Noshould 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?
Bug fixes, doc updates and new features usually go into minor releases.
Bug fixes and doc updates usually go into patch releases.