Skip to content

[DOC] Fix typos in ML documentation main page#19048

Merged
harupy merged 2 commits intomasterfrom
copilot/fix-typos-in-ml-docs
Nov 26, 2025
Merged

[DOC] Fix typos in ML documentation main page#19048
harupy merged 2 commits intomasterfrom
copilot/fix-typos-in-ml-docs

Conversation

Copy link
Contributor

Copilot AI commented Nov 26, 2025

Related Issues/PRs

Resolve #issue_number

What changes are proposed in this pull request?

Fixes two typos in docs/docs/classic-ml/index.mdx:

  • Model Deployment tab: "containerized - enronments" → "containerized environments"
  • Model Evaluation tab: "regression, and - mo" → "regression, and more"

How is this PR tested?

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

Pre-commit hooks (typo checker, linting) verified.

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.

Fixed typos in ML documentation main page that affected readability.

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/uixx: 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)
Original prompt

This section details on the original issue you should resolve

<issue_title>[DOC-FIX] Variable undefined in quickstart guide, typos in ML docs main page</issue_title>
<issue_description>### Willingness to contribute

Yes. I would be willing to contribute a document fix with guidance from the MLflow community.

URL(s) with the issue

https://mlflow.org/docs/latest/ml/getting-started/quickstart/#step-5---log-a-model-and-metadata-manually
https://mlflow.org/docs/latest/ml/#traditional-ml-and-deep-learning-with-mlflow

Description of proposal (what needs changing)

In the MLflow Tracking Quickstart, model_info should be defined in step 5 in order to be used in step 6

Fix typos in ML docs main page:

  • under Model Deployment tab, "- enronments" -> "environments"
  • under Model Evaluation tab, "- mo" -> "more"</issue_description>

<agent_instructions>The undefined variable issue has been already fixed. Let's fix the typos</agent_instructions>

Comments on the Issue (you are @copilot in this section)

@serena-ruan Thanks for finding the issue! Are you willing to file a doc fix? The model_info should be the result of `log_model`. @harupy https://github.com//pull/18671 fixed undefined `model_info`

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: harupy <17039389+harupy@users.noreply.github.com>
@harupy harupy marked this pull request as ready for review November 26, 2025 10:11
@github-actions
Copy link
Contributor

@Copilot Thank you for the contribution! Could you fix the following issue(s)?

⚠ Invalid PR template

This PR does not appear to have been filed using the MLflow PR template. Please copy the PR template from here and fill it out.

Copilot AI changed the title [WIP] Fix typos in ML documentation pages [DOC] Fix typos in ML documentation main page Nov 26, 2025
Copilot AI requested a review from harupy November 26, 2025 10:14
@github-actions github-actions bot added v3.6.1 area/docs Documentation issues rn/documentation Mention under Documentation Changes in Changelogs. labels Nov 26, 2025
@harupy harupy enabled auto-merge November 26, 2025 10:27
@github-actions
Copy link
Contributor

Documentation preview for 16d418e is available at:

Changed Pages (1)

  • ml (modified)
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.

@harupy harupy added this pull request to the merge queue Nov 26, 2025
Merged via the queue into master with commit 929f783 Nov 26, 2025
55 of 75 checks passed
@harupy harupy deleted the copilot/fix-typos-in-ml-docs branch November 26, 2025 10:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Documentation issues rn/documentation Mention under Documentation Changes in Changelogs. v3.6.1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC-FIX] Variable undefined in quickstart guide, typos in ML docs main page

3 participants