Skip to content

[Workspace] Add REST store and fluent workspace APIs#19449

Merged
B-Step62 merged 4 commits intomlflow:orgnization-supportfrom
mprahl:rest-store
Dec 20, 2025
Merged

[Workspace] Add REST store and fluent workspace APIs#19449
B-Step62 merged 4 commits intomlflow:orgnization-supportfrom
mprahl:rest-store

Conversation

@mprahl
Copy link
Collaborator

@mprahl mprahl commented Dec 17, 2025

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

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

Related Issues/PRs

#1464
#5844
Design document: https://docs.google.com/document/d/1IbFfceCmWV3knJfc0ninn58EXLVbHUh1meV_pknOM40/edit

What changes are proposed in this pull request?

This adds workspace support to the tracking and model registry REST stores. It also adds the workspace related fluent APIs, and addresses some of the optional feedback from #19319.

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)

Tracking and model registry REST stores now detect if the server
has workspaces enabled if a user specifies a workspace.

When a workspace is set and the servers support it, the REST store
passes an X-MLFLOW-WORKSPACE header to the HTTP request.

Signed-off-by: mprahl <mprahl@users.noreply.github.com>
Signed-off-by: mprahl <mprahl@users.noreply.github.com>
@github-actions github-actions bot added area/model-registry Model registry, model registry APIs, and the fluent client calls for model registry area/tracking Tracking service, tracking client APIs, autologging rn/none List under Small Changes in Changelogs. labels Dec 17, 2025
@mprahl
Copy link
Collaborator Author

mprahl commented Dec 17, 2025

/cc @B-Step62 @BenWilson2

Signed-off-by: mprahl <mprahl@users.noreply.github.com>
Copy link
Collaborator

@B-Step62 B-Step62 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 small comments

_verify_model_registry_store_workspace_support(registry_store)


def _store_supports_workspaces(store: object) -> bool:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
def _store_supports_workspaces(store: object) -> bool:
def _store_supports_workspaces(store: AbstractStore) -> bool:

self._workspace_support = supported
return supported

def _enforce_workspace_support(self) -> None:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
def _enforce_workspace_support(self) -> None:
def _validate_workspace_support_if_specified(self) -> None:

nit: enforce sounds like it has some side effect.

raise


@experimental(version="3.8.0")
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
@experimental(version="3.8.0")
@experimental(version="3.9.0")

3.8.0 was just cut last week

if exc.error_code == databricks_pb2.ErrorCode.Name(databricks_pb2.ENDPOINT_NOT_FOUND):
raise MlflowException(
"The configured tracking server does not expose workspace APIs. "
"Ensure multi-tenancy is enabled.",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
"Ensure multi-tenancy is enabled.",
"Ensure workspace is enabled.",

Let's avoid the term 'multi-tenancy' as discussed offline.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 18, 2025

Documentation preview for 53875b5 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.

Signed-off-by: mprahl <mprahl@users.noreply.github.com>
@mprahl mprahl requested a review from B-Step62 December 18, 2025 22:10
@B-Step62 B-Step62 merged commit dbb043b into mlflow:orgnization-support Dec 20, 2025
47 checks passed
mprahl added a commit to mprahl/mlflow that referenced this pull request Jan 16, 2026
Signed-off-by: mprahl <mprahl@users.noreply.github.com>
B-Step62 pushed a commit to B-Step62/mlflow that referenced this pull request Jan 19, 2026
Signed-off-by: mprahl <mprahl@users.noreply.github.com>
B-Step62 pushed a commit to B-Step62/mlflow that referenced this pull request Feb 3, 2026
Signed-off-by: mprahl <mprahl@users.noreply.github.com>
mprahl added a commit to mprahl/mlflow that referenced this pull request Feb 3, 2026
Signed-off-by: mprahl <mprahl@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/model-registry Model registry, model registry APIs, and the fluent client calls for model registry area/tracking Tracking service, tracking client APIs, autologging rn/none List under Small Changes in Changelogs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants