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

Avoid using inspect.getfullargspec that doesn't work properly for a wrapped function #4956

Merged
merged 5 commits into from
Oct 28, 2021

Conversation

harupy
Copy link
Member

@harupy harupy commented Oct 28, 2021

Signed-off-by: harupy hkawamura0130@gmail.com

What changes are proposed in this pull request?

In dmlc/xgboost#6751, xgboost.train is wrapped by _deprecate_positional_args to deprecate the positional arguments. This change broke xgboost autologging because inspect.getfullargspec doesn't work properly for a wrapped function:

https://github.com/mlflow/mlflow/runs/4033126360?check_suite_focus=true#step:11:8877

        all_arg_names = inspect.getfullargspec(original)[0]  # `original` is `xgboost.train`
                              # ^^^^^^^^^^^^^^
                              # doesn't work for a wrapped function
        num_pos_args = len(args)
    
        # adding a callback that records evaluation results.
        eval_results = []
>       callbacks_index = all_arg_names.index("callbacks")
E       ValueError: 'callbacks' is not in list

This PR fixes the issue by using inspect.signature.

How is this patch tested?

Existing tests

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/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

@harupy harupy added the enable-dev-tests Enables cross-version tests for dev versions label Oct 28, 2021
@github-actions github-actions bot added the rn/none List under Small Changes in Changelogs. label Oct 28, 2021
@harupy harupy changed the title Avoid using inspect.getfullargspec that doesn't work for a wrapped function Avoid using inspect.getfullargspec that doesn't work properly for a wrapped function Oct 28, 2021
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
@@ -1158,7 +1158,6 @@ def fetch_logged_data(run_id):
_get_args_for_metrics,
_log_estimator_content,
_all_estimators,
_get_arg_names,
Copy link
Member Author

@harupy harupy Oct 28, 2021

Choose a reason for hiding this comment

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

_get_arg_names here isn't used at all.

Copy link
Member Author

Choose a reason for hiding this comment

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

pylint doesn't seem to check import statements in a function.

@harupy harupy requested a review from dbczumar October 28, 2021 11:38
Signed-off-by: harupy <hkawamura0130@gmail.com>
@@ -0,0 +1,13 @@
import inspect
Copy link
Member Author

Choose a reason for hiding this comment

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

@dbczumar Does the module name (arguments_utils) sound fine?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yep!

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 @harupy !

@harupy harupy merged commit 8e10fdb into mlflow:master Oct 28, 2021
@harupy harupy deleted the avoid-using-getfullargspec branch October 28, 2021 22:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enable-dev-tests Enables cross-version tests for dev versions rn/none List under Small Changes in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants