Fix `download_artifacts` ignoring `tracking_uri` parameter by harupy · Pull Request #16461 · mlflow/mlflow

harupy · 2025-06-26T09:46:34Z

🛠 DevTools 🛠

Install mlflow from this PR

# mlflow
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/16461/merge
# mlflow-skinny
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/16461/merge#subdirectory=skinny

For Databricks, use the following command:

%sh curl -LsSf https://raw.githubusercontent.com/mlflow/mlflow/HEAD/dev/install-skinny.sh | sh -s pull/16461/merge

Related Issues/PRs

Resolve #16412
Close #16423

What changes are proposed in this pull request?

Fix a regression in download_artifacts where the tracking_uri parameter was being ignored when both run_id and artifact_path were specified. This caused the function to look for artifacts in the wrong location (typically the current working directory's mlruns folder) instead of using the provided tracking URI.

The fix ensures that the tracking_uri parameter is properly passed through to all relevant artifact repository and download functions:

_download_artifact_from_uri() now accepts and uses the tracking_uri parameter
get_artifact_repository() calls now pass the tracking_uri parameter
RunsArtifactRepository.get_underlying_uri() now accepts and properly uses the tracking URI
Fixed client method calls to use self.download_artifacts() instead of mlflow.artifacts.download_artifacts()

How is this PR tested?

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

The issue included a reproduction case that now works correctly with these changes. The fix ensures that both scenarios in the reproduction case work:

download_artifacts(run_id=run_id, artifact_path=None, tracking_uri=tracking_uri) - already worked
download_artifacts(run_id=run_id, artifact_path="my_subdir", tracking_uri=tracking_uri) - now works with the fix

Does this PR require documentation update?

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.

Fix download_artifacts function to properly respect the tracking_uri parameter when both run_id and artifact_path are specified. This resolves a regression introduced in v3.1.0 where the function would ignore the tracking URI and look for artifacts in the default location.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

Interface

area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
area/docker: Docker use across MLflow's components, such as MLflow Projects and MLflow Models
area/sqlalchemy: Use of SQLAlchemy in the Tracking Service or Model Registry
area/windows: Windows support

Language

language/r: R APIs and clients
language/java: Java APIs and clients
language/new: Proposals for new client languages

Integrations

integrations/azure: Azure and Azure ML integrations
integrations/sagemaker: SageMaker integrations
integrations/databricks: Databricks integrations

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 (this PR will be cherry-picked and included in the next patch release)
No (this PR will be included in the next minor release)

When both run_id and artifact_path are specified, download_artifacts was ignoring the tracking_uri parameter and looking for artifacts in the wrong location. This fix ensures the tracking_uri is properly passed through to all artifact repository functions. Fixes mlflow#16412 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>

github-actions · 2025-06-26T09:47:17Z

Documentation preview for c5a27c1 will be available when this CircleCI job
completes successfully. You may encounter a {"message":"not found"} error when reloading
a page. If so, add /index.html to the URL.

Top page
Changed pages (⚠️ only MDX file changes are detected ⚠️)

More info

Ignore this comment if this PR does not change the documentation.
It takes a few minutes for the preview to be available.
The preview is updated when a new commit is pushed to this PR.
This comment was created by https://github.com/mlflow/mlflow/actions/runs/15961814752.

Copilot

Pull Request Overview

This PR fixes a regression in download_artifacts where the tracking_uri argument was not forwarded when both run_id and artifact_path were provided. It ensures tracking_uri is passed through all artifact repository lookups and download paths.

Propagate tracking_uri into _download_artifact_from_uri, download_artifacts, and list_artifacts calls.
Switch internal client calls to use self.download_artifacts for tracking URI consistency.
Extend RunsArtifactRepository.get_underlying_uri to accept and prioritize tracking_uri.

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
tests/tracking/test_rest_tracking.py	Removed redundant `mlflow.set_tracking_uri` in test fixture
mlflow/tracking/client.py	Replaced global artifact download calls with `self.download_artifacts`
mlflow/tracking/artifact_utils.py	Added `tracking_uri` parameter and forwarded it to repository lookup
mlflow/store/artifact/runs_artifact_repo.py	Updated `get_underlying_uri` signature; adjusted constructor to use it and fixed client instantiation
mlflow/artifacts/init.py	Forwarded `tracking_uri` in high-level `download_artifacts` and `list_artifacts`

mlflow/store/artifact/runs_artifact_repo.py

Ensure that the tracking_uri is passed to get_artifact_repository when initializing the repository in RunsArtifactRepository.__init__. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>

harupy · 2025-06-26T09:58:14Z

tests/tracking/test_rest_tracking.py

        ]

    with _init_server(backend_uri, root_artifact_uri=tmp_path.as_uri()) as url:
-        mlflow.set_tracking_uri(backend_uri)


To address #16423 (review)

Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>

- Update mock function in test_cli.py to accept tracking_uri parameter - Fix test assertions in test_runs_artifact_repo.py to use keyword arguments - Ensure RunsArtifactRepository preserves profile info from runs URI This fixes the test failures that occurred after adding tracking_uri parameter support to download_artifacts and related functions. Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>

harupy · 2025-06-27T06:16:58Z

tests/tracing/test_fluent.py::test_mlflow_trace_isolated_from_other_otel_processors failure is unrelated.

mlflow/store/artifact/runs_artifact_repo.py

Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>

serena-ruan · 2025-06-27T08:58:28Z

mlflow/store/artifact/runs_artifact_repo.py

+        uri = get_artifact_uri(
+            run_id=run_id,
+            artifact_path=artifact_path,
+            tracking_uri=tracking_uri_from_run or tracking_uri,


What if both tracking_uri_from_run and tracking_uri exist? 🤔

Good point. To be conservative, I chose to use the return value of get_databricks_profile_uri_from_artifact_uri to avoid behavior changes.

serena-ruan

Overall LGTM!

Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>

rdotsch · 2025-06-27T12:26:58Z

list_artifacts has the identical issue. Will the changes in this PR fix that as well, or should I file that as a separate issue?

harupy · 2025-06-27T12:35:17Z

@rdotsch This PR should also fix list_artifacts. Can you verify?

# mlflow
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/16461/merge
# mlflow-skinny
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/16461/merge#subdirectory=skinny

harupy · 2025-06-27T13:33:31Z

@rdotsch Can you file a separate issue and link this PR?

Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>

harupy · 2025-06-27T13:38:07Z

tests/artifacts/test_artifacts.py

+def test_list_artifacts_with_client_and_tracking_uri(tmp_path: pathlib.Path):
+    tracking_uri = f"sqlite:///{tmp_path}/mlflow-{uuid.uuid4().hex}.db"
+    assert mlflow.get_tracking_uri() != tracking_uri
+    client = mlflow.MlflowClient(tracking_uri)
+    experiment_id = client.create_experiment("my_experiment")
+    run = client.create_run(experiment_id)
+    tmp_dir = tmp_path / "subdir"
+    tmp_dir.mkdir()
+    tmp_file = tmp_dir / "file.txt"
+    tmp_file.touch()
+    client.log_artifacts(run.info.run_id, tmp_dir, "subdir")
+
+    artifacts = mlflow.artifacts.list_artifacts(
+        run_id=run.info.run_id,
+        tracking_uri=tracking_uri,
+    )
+    assert [p.path for p in artifacts] == ["subdir"]
+
+    artifacts = mlflow.artifacts.list_artifacts(
+        run_id=run.info.run_id,
+        artifact_path="subdir",
+        tracking_uri=tracking_uri,
+    )
+    assert [p.path for p in artifacts] == ["subdir/file.txt"]


@rdotsch Added a test for list_artifacts (which fails on master but doesn't on this branch).

Thank you so much @harupy -- I verified in our setup and indeed this test passes. However, when I use our remote tracking_uri over https instead of a local sqlite database, this part without the artifact_path parameter passes:

artifacts = mlflow.artifacts.list_artifacts( run_id=run.info.run_id, tracking_uri=tracking_uri, ) assert [p.path for p in artifacts] == ["subdir"]

But the last assertion using the artifact_path parameter does not pass:

artifacts = mlflow.artifacts.list_artifacts( run_id=run.info.run_id, artifact_path="subdir", tracking_uri=tracking_uri, ) assert [p.path for p in artifacts] == ["subdir/file.txt"]

It throws an exception at list_artifacts:

raise MlflowException( mlflow.exceptions.MlflowException: API request to endpoint /api/2.0/mlflow/logged-models/search failed with error code 404 != 200. Response body: '<!doctype html> <html lang=en> <title>404 Not Found</title> <h1>Not Found</h1> <p>The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again.</p> '

@rdotsch I think your tracking server uses mlflow 2.x. /api/2.0/mlflow/logged-models/search is a new endpoint added in mlflow 3.x.

We had already updated the tracking server to 3.1.1 this morning.

I'll look into whether I can find something wrong with our setup on Monday. Otherwise I'll file a new issue referencing this PR.

Also, wouldn’t the first assertion fail as well if that were the case? Or does it use a different endpoint when not supplying an artifact path?

The first case doesn't call search models. Only the second case does.

I see. Thank you.

Can you call mlflow.search_logged_models? Does it fail with 404?

I'll merge this PR to unblock my other work.

…king-URI

guybartal · 2025-07-02T13:57:20Z

When is the next release which include this fix is planned to?

) Signed-off-by: harupy <17039389+harupy@users.noreply.github.com> Co-authored-by: Claude <noreply@anthropic.com>

Signed-off-by: harupy <17039389+harupy@users.noreply.github.com> Co-authored-by: Claude <noreply@anthropic.com>

Copilot AI review requested due to automatic review settings June 26, 2025 09:46

github-actions bot added area/artifacts Artifact stores and artifact logging area/tracking Tracking service, tracking client APIs, autologging rn/bug-fix Mention under Bug Fixes in Changelogs. labels Jun 26, 2025

Copilot AI reviewed Jun 26, 2025

View reviewed changes

mlflow/store/artifact/runs_artifact_repo.py Outdated Show resolved Hide resolved

harupy changed the title ~~Fix download_artifacts ignoring tracking_uri parameter~~ Fix download_artifacts ignoring tracking_uri parameter Jun 26, 2025

harupy commented Jun 26, 2025

View reviewed changes

harupy requested a review from TomeHirata June 26, 2025 09:59

harupy changed the title ~~Fix download_artifacts ignoring tracking_uri parameter~~ Fix download_artifacts ignoring tracking_uri parameter Jun 26, 2025

harupy and others added 3 commits June 26, 2025 19:21

test

e8d4c79

Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>

Fix download_artifacts calls

b59e28b

Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>

harupy added the team-review Trigger a team review request label Jun 27, 2025

github-actions bot requested review from B-Step62, BenWilson2, WeichenXu123, daniellok-db, serena-ruan and xq-yin June 27, 2025 06:22

serena-ruan reviewed Jun 27, 2025

View reviewed changes

mlflow/store/artifact/runs_artifact_repo.py Show resolved Hide resolved

Pass tracking_uri

cd4858f

Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>

serena-ruan reviewed Jun 27, 2025

View reviewed changes

serena-ruan approved these changes Jun 27, 2025

View reviewed changes

Rename for clarity

7dd7a52

Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>

Test for list_artifacts

cc97381

Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>

harupy commented Jun 27, 2025

View reviewed changes

Merge branch 'mlflow:master' into fix-download_artifacts-ignores-trac…

c5a27c1

…king-URI

harupy enabled auto-merge June 30, 2025 02:35

harupy added this pull request to the merge queue Jun 30, 2025

Merged via the queue into mlflow:master with commit 4d66c30 Jun 30, 2025
47 checks passed

harupy deleted the fix-download_artifacts-ignores-tracking-URI branch June 30, 2025 02:37

harupy added the v3.1.2 label Jul 2, 2025

B-Step62 pushed a commit to B-Step62/mlflow that referenced this pull request Jul 8, 2025

Fix download_artifacts ignoring tracking_uri parameter (mlflow#16461

269a5e9

) Signed-off-by: harupy <17039389+harupy@users.noreply.github.com> Co-authored-by: Claude <noreply@anthropic.com>

B-Step62 pushed a commit that referenced this pull request Jul 8, 2025

Fix download_artifacts ignoring tracking_uri parameter (#16461)

76fc61a

Signed-off-by: harupy <17039389+harupy@users.noreply.github.com> Co-authored-by: Claude <noreply@anthropic.com>

This was referenced Sep 30, 2025

[BUG] fluent/global dependencies in MlflowClient api (artifact repo) #14931

Closed

Pass tracking URI #18023

Merged

Conversation

harupy commented Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Install mlflow from this PR

Related Issues/PRs

What changes are proposed in this pull request?

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?

How should the PR be classified in the release notes? Choose one:

Should this PR be included in the next patch release?

Uh oh!

github-actions bot commented Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

harupy commented Jun 27, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

serena-ruan left a comment

Choose a reason for hiding this comment

Uh oh!

rdotsch commented Jun 27, 2025

Uh oh!

harupy commented Jun 27, 2025

Uh oh!

harupy commented Jun 27, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rdotsch Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

harupy Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

harupy Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

guybartal commented Jul 2, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

harupy commented Jun 26, 2025 •

edited

Loading

github-actions bot commented Jun 26, 2025 •

edited

Loading

rdotsch Jun 27, 2025 •

edited

Loading

harupy Jun 27, 2025 •

edited

Loading

harupy Jun 27, 2025 •

edited

Loading