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

Parse subdirectory with quotes #5117

Merged
merged 1 commit into from Nov 30, 2021
Merged

Parse subdirectory with quotes #5117

merged 1 commit into from Nov 30, 2021

Conversation

dinaldoap
Copy link
Contributor

@dinaldoap dinaldoap commented Nov 28, 2021

Signed-off-by: dinaldoap dinaldoap@gmail.com

What changes are proposed in this pull request?

Currently, mlflow.projects._parse_subdirectory splits uri by the character '#' and leaves unpaired quotes in parsed_uri and subdirectory. For example, uri = 'parsed_uri#subdirectory' becomes parsed_uri='parsed_uri and subdirectory=subdirectory'.

The proposed solution is to remove quotes from parsed_uri and subdirectory and add them back only when necessary.

How is this patch tested?

The test is located in tests/projects/test_utils.py, function test_parse_subdirectory.

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.

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

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/projects MLproject format, project running backends rn/bug-fix Mention under Bug Fixes in Changelogs. labels Nov 28, 2021
if subdirectory and "." in subdirectory:
raise ExecutionException("'.' is not allowed in project subdirectory paths.")
return parsed_uri, subdirectory


def _fix_quote(uri):
# Remove quotes and, if necessary, add new ones
return quote(uri.strip("'\""))
Copy link
Member

@harupy harupy Nov 29, 2021

Choose a reason for hiding this comment

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

@dinaldoap Thanks for the PR! Could you tell us why we need quote here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@harupy Thanks for the feedback! You question made me think in a better solution after reviewing mlflow's code. Since parsed_uri and subdirectory aren't used in command lines, they don't need to be quoted again. Besides that, I observed that removing quotes from uri instead of parsed_uri and subdirectory will allow "mlflow run" to work with quoted URIs without subdirectories. For example, mlflow run "'exam ples/sklearn_elasticnet_wine/'".
I will rewrite my commits in my branch and force push them in a minute.

if subdirectory and "." in subdirectory:
raise ExecutionException("'.' is not allowed in project subdirectory paths.")
return parsed_uri, subdirectory


def _remove_quotes(uri):
Copy link
Member

@harupy harupy Nov 30, 2021

Choose a reason for hiding this comment

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

Suggested change
def _remove_quotes(uri):
def _strip_quotes(uri):

nit: can we rename this function to indicate it only removes leading and trailing quotes? remove sounds like it removes all quotes in a given string.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the feedback! function _remove_quotes renamed to _strip_quotes. I've already done another force push.

Signed-off-by: dinaldoap <dinaldoap@gmail.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 987de02 into mlflow:master Nov 30, 2021
@dinaldoap dinaldoap deleted the fix_quote branch December 2, 2021 11:56
@dinaldoap
Copy link
Contributor Author

fix #5114

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/projects MLproject format, project running backends rn/bug-fix Mention under Bug Fixes in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants