Skip to content

Convert the records property in Evaluation Datasets to be private#19145

Merged
BenWilson2 merged 2 commits intomlflow:masterfrom
BenWilson2:fix-records
Dec 2, 2025
Merged

Convert the records property in Evaluation Datasets to be private#19145
BenWilson2 merged 2 commits intomlflow:masterfrom
BenWilson2:fix-records

Conversation

@BenWilson2
Copy link
Member

@BenWilson2 BenWilson2 commented Dec 1, 2025

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

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

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

The records property in evaluation datasets should be a private internal handler for managing the lazy loading of records from the DB. This PR removes the public aspect of this (it was never documented as it was intended to be an internal API shared between to_df and to_dict.

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)

Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
@github-actions github-actions bot added area/evaluation MLflow Evaluation rn/none List under Small Changes in Changelogs. labels Dec 1, 2025
@BenWilson2 BenWilson2 added the team-review Trigger a team review request label Dec 1, 2025
@BenWilson2 BenWilson2 added team-review Trigger a team review request and removed team-review Trigger a team review request labels Dec 1, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 1, 2025

Documentation preview for 48cc97a is available at:

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.

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.

LGTM! @BenWilson2 does this appear in our docs anywhere?

@BenWilson2
Copy link
Member Author

LGTM! @BenWilson2 does this appear in our docs anywhere?

No, it was never exposed in the docs (other than 2 small locations in 'listing properties' in the API docs buried in a parenthetical - I don't think anyone would have noticed it). In the full eval dataset / evaluation docs there were no mentions of this property - everything used to_dict() or to_df() (the intended public APIs) @dbczumar

@BenWilson2 BenWilson2 added this pull request to the merge queue Dec 2, 2025
Merged via the queue into mlflow:master with commit 1122338 Dec 2, 2025
46 checks passed
@BenWilson2 BenWilson2 deleted the fix-records branch December 2, 2025 16:13
BenWilson2 added a commit to BenWilson2/mlflow that referenced this pull request Dec 4, 2025
…flow#19145)

Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
BenWilson2 added a commit that referenced this pull request Dec 4, 2025
…9145)

Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
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. team-review Trigger a team review request v3.7.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants