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

Fix batch scoring pipeline artifact writing on Databricks #6766

Merged
merged 12 commits into from
Sep 14, 2022

Conversation

jerrylian-db
Copy link
Collaborator

@jerrylian-db jerrylian-db commented Sep 12, 2022

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

This change fixes the artifact writing and reading logic for the batch scoring predict step.

How is this patch tested?

  • I have written tests (not required for typo or doc fix) and confirmed the proposed feature/bug-fix/change works.

I cloned the example MLP regression template repo. Updated the requirements.txt file to point to my fix branch. Ran the entire Databricks notebook in the example. Then, I added notebook cells and ran the ingest_scoring and predict steps. Both of which succeeded. Finally, I loaded the scored dataset artifact using the get_artifact API and it succeeded.

See screenshots:

Screen Shot 2022-09-13 at 2 28 21 PM

Screen Shot 2022-09-13 at 2 28 29 PM

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. Click the Details link on the Preview docs check.
  2. 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.

(Details in 1-2 sentences. You can just refer to another PR with a description if this PR is part of a larger change.)

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/pipelines: Pipelines, Pipeline APIs, Pipeline configs, Pipeline Templates
  • 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: Jerry Liang <jerry.liang@databricks.com>
Signed-off-by: Jerry Liang <jerry.liang@databricks.com>
Signed-off-by: Jerry Liang <jerry.liang@databricks.com>
Signed-off-by: Jerry Liang <jerry.liang@databricks.com>
Signed-off-by: Jerry Liang <jerry.liang@databricks.com>
".mlflow",
_get_execution_directory_basename(self.pipeline_root),
_SCORED_OUTPUT_FOLDER_NAME,
)
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

In Databricks, it seems like the spark writes parquet files as a folder. This makes it difficult for the get_artifact logic to work because when the artifact path has a .parquet file extension, it reads the folder as if it were a file. Thus, I've updated the scored_data artifact writing and reading logic to an artifact path that does not have a .parquet file extension.

@github-actions github-actions bot added the rn/none List under Small Changes in Changelogs. label Sep 12, 2022
Signed-off-by: Jerry Liang <jerry.liang@databricks.com>
Comment on lines 135 to 151
if databricks_utils.is_in_databricks_runtime():
dbfs_path = os.path.join(
".mlflow",
_get_execution_directory_basename(self.pipeline_root),
_SCORED_OUTPUT_FOLDER_NAME,
)
shutil.rmtree("/dbfs/" + dbfs_path, ignore_errors=True)
scored_sdf.coalesce(1).write.format("parquet").save(dbfs_path)
_logger.info("Moving artifact from DBFS to driver disk")
shutil.copytree(
"/dbfs/" + dbfs_path, os.path.join(output_directory, _SCORED_OUTPUT_FOLDER_NAME)
)
shutil.rmtree("/dbfs/" + dbfs_path)
else:
scored_sdf.coalesce(1).write.format("parquet").save(
os.path.join(output_directory, _SCORED_OUTPUT_FILE_NAME)
)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we abstract this logic into a util function e.g. in https://github.com/mlflow/mlflow/blob/master/mlflow/utils/file_utils.py? I can easily see it's used in other places in the future.

Signed-off-by: Jerry Liang <jerry.liang@databricks.com>
Signed-off-by: Jerry Liang <jerry.liang@databricks.com>
Signed-off-by: Jerry Liang <jerry.liang@databricks.com>
Copy link
Collaborator

@sunishsheth2009 sunishsheth2009 left a comment

Choose a reason for hiding this comment

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

Looks good to me :)

Copy link
Collaborator

@jinzhang21 jinzhang21 left a comment

Choose a reason for hiding this comment

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

Thanks for the quick fix, @jerrylian-db !

Signed-off-by: Jerry Liang <jerry.liang@databricks.com>
Signed-off-by: Jerry Liang <jerry.liang@databricks.com>
Signed-off-by: Jerry Liang <jerry.liang@databricks.com>
@jerrylian-db jerrylian-db merged commit 2b1d6be into master Sep 14, 2022
@jerrylian-db jerrylian-db deleted the fix_batch branch September 22, 2022 16:24
nnethery pushed a commit to nnethery/mlflow that referenced this pull request Feb 1, 2024
* wip

Signed-off-by: Jerry Liang <jerry.liang@databricks.com>

* wip

Signed-off-by: Jerry Liang <jerry.liang@databricks.com>

* wip

Signed-off-by: Jerry Liang <jerry.liang@databricks.com>

* wip

Signed-off-by: Jerry Liang <jerry.liang@databricks.com>

* wip

Signed-off-by: Jerry Liang <jerry.liang@databricks.com>

* wip

Signed-off-by: Jerry Liang <jerry.liang@databricks.com>

* wip

Signed-off-by: Jerry Liang <jerry.liang@databricks.com>

* wip

Signed-off-by: Jerry Liang <jerry.liang@databricks.com>

* wip

Signed-off-by: Jerry Liang <jerry.liang@databricks.com>

* wip

Signed-off-by: Jerry Liang <jerry.liang@databricks.com>

* wip

Signed-off-by: Jerry Liang <jerry.liang@databricks.com>

* wip

Signed-off-by: Jerry Liang <jerry.liang@databricks.com>

Signed-off-by: Jerry Liang <jerry.liang@databricks.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rn/none List under Small Changes in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants