Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do not modify tags dict on start_run() #5191

Merged
merged 4 commits into from Dec 23, 2021

Conversation

matheusMoreno
Copy link
Contributor

@matheusMoreno matheusMoreno commented Dec 21, 2021

What changes are proposed in this pull request?

On the start_run() function, make a deep copy of the tags dictionary and do not redefine the dictionary. Fixes #5190.

How is this patch tested?

Installed MLflow from my branch, and ran the sample code in #5190. It did not raise any errors.

Does this PR change the documentation?

  • No. You can skip the rest of this section.
  • Yes. Make sure the changed pages / sections render correctly by following the steps below.

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.

Fixes bug where dictionary variables for tags were being altered, causing runs to be incorrectly considered nested.

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

Components

  • area/artifacts: Artifact stores and artifact logging
  • area/build: Build and test infrastructure for MLflow
  • area/docs: MLflow documentation pages
  • area/examples: Example code
  • area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • area/projects: MLproject format, project running backends
  • area/scoring: MLflow Model server, model deployment tools, Spark UDFs
  • area/server-infra: MLflow Tracking server backend
  • area/tracking: Tracking Service, tracking client APIs, autologging

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/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • 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/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

@github-actions github-actions bot added area/tracking Tracking service, tracking client APIs, autologging rn/bug-fix Mention under Bug Fixes in Changelogs. labels Dec 21, 2021
@github-actions
Copy link

@matheusMoreno Thanks for the contribution! The DCO check failed. Please sign off your commits by following the instructions here: https://github.com/mlflow/mlflow/runs/4599678833. See https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.rst#sign-your-work for more details.

Signed-off-by: Matheus Moreno <matheus.moreno@hurb.com>
@harupy
Copy link
Member

harupy commented Dec 22, 2021

@matheusMoreno Thanks for the PR! Can we also fix this line?

tags = tags if tags else {}

mlflow/tracking/fluent.py Outdated Show resolved Hide resolved
@harupy harupy self-requested a review December 22, 2021 00:52
Matheus Moreno added 2 commits December 22, 2021 15:26
Signed-off-by: Matheus Moreno <matheus.moreno@hurb.com>
Signed-off-by: Matheus Moreno <matheus.moreno@hurb.com>
@matheusMoreno matheusMoreno force-pushed the bugfix/nested_tags branch 2 times, most recently from 32aeb41 to f4679c6 Compare December 22, 2021 18:31
@matheusMoreno
Copy link
Contributor Author

@matheusMoreno Thanks for the PR! Can we also fix this line?

tags = tags if tags else {}

Fixed on 355fcd4. Did not use deep copy because the function only reads the dict, with no modifications.

Also renamed the variable on start_run() as suggested, and did not remove the deepcopy() call.

@harupy
Copy link
Member

harupy commented Dec 22, 2021

Did not use deep copy because the function only reads the dict, with no modifications.

Ah, you're right. I didn't look at the code carefully.

tags = tags if tags else {}
run_tags = tags if tags else {}
Copy link
Member

Choose a reason for hiding this comment

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

Do we need this change?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

At first I thought so, since it could rewrite the parameter, but it does seem unnecessary. Will undo the commit!

This reverts commit 355fcd4.

Signed-off-by: Matheus Moreno <matheus.moreno@hurb.com>
Copy link
Member

@harupy harupy left a comment

Choose a reason for hiding this comment

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

LGTM!

@harupy harupy merged commit 4c5bdaa into mlflow:master Dec 23, 2021
@matheusMoreno matheusMoreno deleted the bugfix/nested_tags branch December 23, 2021 01:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/tracking Tracking service, tracking client APIs, autologging rn/bug-fix Mention under Bug Fixes in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] start_run() modifies tags dictionary
3 participants