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

pyfunc.spark_udf: conda env dir / cache dir isolation and NFS optimization #5561

Merged
merged 59 commits into from
Apr 8, 2022

Conversation

WeichenXu123
Copy link
Collaborator

@WeichenXu123 WeichenXu123 commented Mar 30, 2022

What changes are proposed in this pull request?

For pyfunc.spark_udf:

  1. Make conda env dir / cache dir isolated for different python processes.
  2. NFS optimization: Create conda env once in driver side (write env dir into NFS mounted directory), and executor side directly read the env set up in driver side.

How is this patch tested?

Manually:

  1. NFS enabled: https://e2-dogfood.staging.cloud.databricks.com/?o=6051921418418893#notebook/2674920562695789/command/2674920562695795

  2. NFS disabled: https://e2-dogfood.staging.cloud.databricks.com/?o=6051921418418893#notebook/2674920562695847/command/2674920562695848

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.

For pyfunc.spark_udf:

Make conda env dir / cache dir isolated for different python processes.
NFS optimization: Create conda env once in driver side (write env dir into NFS mounted directory), and executor side directly read the env set up in driver side.

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

Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
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.

@WeichenXu123 Looks great! Tried it out on Databricks & it seemed to work well! Left a few small comments.

Comment on lines 902 to 903
# Create individual package cache dir "pkgs" under the conda_env_root_dir
# for each python process.
Copy link
Collaborator

Choose a reason for hiding this comment

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

If the user forks a new process after running this method, _CONDA_ENV_ROOT_DIR will still be defined and the same cache dir will be reused. Shall we handle this case?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good question... This might be hard to address.
But what's the case user need to fork a process ? Is it a common case ?

Copy link
Collaborator

@dbczumar dbczumar Apr 5, 2022

Choose a reason for hiding this comment

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

Could be! Can't we store and check the process id? https://docs.python.org/3/library/os.html#os.getpid. If the pid doesn't match the one used to configure _CONDA_ENV_ROOT_DIR the first time, can we overwrite it?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Addressed! See cache_return_value_per_process decorator and it is applied on get_or_create_nfs_tmp_dir, get_or_create_tmp_dir, _get_or_create_env_root_dir

mlflow/pyfunc/__init__.py Outdated Show resolved Hide resolved
mlflow/pyfunc/__init__.py Outdated Show resolved Hide resolved
mlflow/utils/conda.py Outdated Show resolved Hide resolved
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
mlflow/utils/process.py Outdated Show resolved Hide resolved
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
mlflow/utils/conda.py Outdated Show resolved Hide resolved
mlflow/utils/conda.py Outdated Show resolved Hide resolved
mlflow/utils/conda.py Outdated Show resolved Hide resolved
mlflow/utils/file_utils.py Outdated Show resolved Hide resolved
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
mlflow/pyfunc/backend.py Outdated Show resolved Hide resolved
mlflow/utils/conda.py Outdated Show resolved Hide resolved
mlflow/pyfunc/backend.py Outdated Show resolved Hide resolved
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
mlflow/utils/conda.py Outdated Show resolved Hide resolved
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 once the remaining comments are addressed.

Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
mlflow/utils/conda.py Outdated Show resolved Hide resolved
mlflow/utils/conda.py Outdated Show resolved Hide resolved
mlflow/utils/conda.py Outdated Show resolved Hide resolved
mlflow/utils/process.py Outdated Show resolved Hide resolved
mlflow/utils/file_utils.py Outdated Show resolved Hide resolved
mlflow/utils/file_utils.py Outdated Show resolved Hide resolved
mlflow/pyfunc/__init__.py Outdated Show resolved Hide resolved
mlflow/pyfunc/__init__.py Outdated Show resolved Hide resolved
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
@WeichenXu123 WeichenXu123 merged commit 191ce70 into mlflow:master Apr 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/scoring MLflow Model server, model deployment tools, Spark UDFs rn/feature Mention under Features in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants