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.

Sign up for GitHub

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

Jump to bottom

Add ENV variables to control GCS upload/download chunk size and timeouts #5438

Merged
merged 7 commits into from
Mar 5, 2022
Merged

Add ENV variables to control GCS upload/download chunk size and timeouts #5438

merged 7 commits into from
Mar 5, 2022

Conversation

mokrueger
Copy link
Contributor

Add ENV variables to control GCS upload/download chunk size and timeouts
(fixes GCS timeouts for uploads/downloads with slow transfer speeds -> more info #3478 )

Partial fix to #3478

What changes are proposed in this pull request?

Add ENV variables to control GCS upload/download chunk size and timeouts. Implementation details are open for discussion.

How is this patch tested?

Not yet.

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.
  1. Check the status of the ci/circleci: build_doc check. If it's successful, proceed to the
    next step, otherwise fix it.
  2. Click Details on the right to open the job page of CircleCI.
  3. Click the Artifacts tab.
  4. Click docs/build/html/index.html.
  5. Find the changed pages / sections and make sure they render correctly.

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.

Environment variables MLFLOW_GCS_DEFAULT_TIMEOUT, MLFLOW_GCS_UPLOAD_CHUNK_SIZE, MLFLOW_GCS_DOWNLOAD_CHUNK_SIZE added to control GCS artifact storage

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/artifacts Artifact stores and artifact logging rn/bug-fix Mention under Bug Fixes in Changelogs. labels Mar 1, 2022
@github-actions
Copy link

github-actions bot commented Mar 1, 2022

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

@mokrueger
Added ENV variables to control GCS upload/download chunk size and tim…
ec499e3 
…eouts

(fixes GCS timeouts for uploads/downloads with slow transfer speeds)

Signed-off-by: Moritz Krüger <moritz.krueger@fn.de>
@dbczumar dbczumar marked this pull request as ready for review March 1, 2022 23:49
dbczumar
dbczumar reviewed Mar 1, 2022
View reviewed changes
docs/source/tracking.rst Outdated
Comment on lines 957 to 958
- ``MLFLOW_GCS_UPLOAD_CHUNK_SIZE`` - Set the standard upload chunk size for bigger files in KB (GCP Default: 104857600 ≙ 100MB), must be multiple of 256 KB
- ``MLFLOW_GCS_DOWNLOAD_CHUNK_SIZE`` - Set the standard download chunk size for bigger files in KB (GCP Default: 104857600 ≙ 100MB), must be multiple of 256 KB
Copy link
Collaborator

Choose a reason for hiding this comment

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

Would it be beneficial to most users if we reduced this chunk size (or increased the timeout) to reduce occurrences of #3478?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Errors would mostly occur if the upload speed is slower than 13.3 Mbit/s (~1.67 MB/s), so probably if experiments are run locally (eg. local testing) and not in cloud environments. A default increase of the timeout would definitely help that. On the other side it’s probably impossible to avoid errors like that for all users since some people (including myself) have really slow uploads locally which would require really high timeout settings, so maybe it’s enough for people to set it up themselves. But I’m by no means a timeout expert

@dbczumar
Copy link
Collaborator

dbczumar commented Mar 2, 2022

autoformat

mlflow-automation and others added 2 commits March 2, 2022 00:19
@mlflow-automation
Autoformat: https://github.com/mlflow/mlflow/actions/runs/1919460887
4518ea0 
Signed-off-by: mlflow-automation <mlflow-automation@users.noreply.github.com>
@mokrueger
Adjust side_effects in test_log_artifact and test_log_artifacts for n…
78c57c0 
…ew parameters.

Signed-off-by: Moritz Krüger <moritz.krueger@fn.de>
@mokrueger
Copy link
Contributor Author

Adjusted the tests. Should go through now.

@mokrueger
Adjust side_effects in test_log_artifact and test_log_artifacts for n…
866d61b 
…ew parameters.

Signed-off-by: Moritz Krüger <moritz.krueger@fn.de>
dbczumar
dbczumar approved these changes Mar 4, 2022
View reviewed changes
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! Thanks @mokrueger !

@mokrueger
Adjust for linting.
c6ba42a 
Signed-off-by: Moritz Krüger <moritz.krueger@fn.de>
@mokrueger
Minor clarification in docs
753c287 
Signed-off-by: Moritz Krüger <moritz.krueger@fn.de>
@mokrueger
Copy link
Contributor Author

Fixed the linting issues. Thanks for the help on this PR (and my first ever contribution), @dbczumar !

@dbczumar
Copy link
Collaborator

dbczumar commented Mar 5, 2022

Fixed the linting issues. Thanks for the help on this PR (and my first ever contribution), @dbczumar !

Awesome! No problem!

@mokrueger
autoformat
a2327e6 
Signed-off-by: Moritz Krüger <moritz.krueger@fn.de>
@mokrueger
Copy link
Contributor Author

@dbczumar, I fixed the linting again. Guess it didn't like it before for some reason.

@dbczumar dbczumar merged commit 9ad270c into mlflow:master Mar 5, 2022
@mokrueger mokrueger mentioned this pull request Mar 7, 2022
Open
27 tasks
mokrueger referenced this pull request in morkru/mlflow Mar 7, 2022
@morkru
Added ENV variables to control GCS upload/download chunk size and tim…
ce47e08 
…eouts

Signed-off-by: Moritz Krüger <moritz.krueger@witt-gruppe.eu>
@saichandrapandraju
Copy link

Hi,

Is there a similar ENV variable for Minio ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dbczumar dbczumar dbczumar approved these changes

Assignees
No one assigned
Labels
area/artifacts Artifact stores and artifact logging rn/bug-fix Mention under Bug Fixes in Changelogs.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mokrueger @dbczumar @saichandrapandraju @mlflow-automation