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

Merely define preferred backend for joblib instead of hard-coding it #476

Merged
merged 2 commits into from Feb 14, 2022

Conversation

heiderich
Copy link
Contributor

Proposed changes

This fixes #475 by merely indicating a preference for the backend instead of hardcoding it. This way users can specify the backend using joblib.parallel_backend (see https://joblib.readthedocs.io/en/latest/parallel.html#parallel) according to their circumstances.

Types of changes

What types of changes does your code introduce to CausalML?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the CONTRIBUTING doc
  • I have signed the CLA
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Further comments

Related: #468

Reason: According to [1] hard-coding `backend` is discouraged:

   It is not recommended to hard-code the backend name in a call to
   Parallel in a library. Instead it is recommended to set soft hints
   (prefer) or hard constraints (require) so as to make it possible for
   library users to change the backend from the outside using the
   parallel_backend context manager.

[1] https://joblib.readthedocs.io/en/latest/generated/joblib.Parallel.html
@heiderich heiderich changed the title Joblib parallel backend Merely define preferred backend for joblib instead of hard-coding it Feb 13, 2022
@jeongyoonlee jeongyoonlee self-assigned this Feb 14, 2022
@jeongyoonlee jeongyoonlee added bug Something isn't working enhancement New feature or request and removed bug Something isn't working labels Feb 14, 2022
Copy link
Collaborator

@jeongyoonlee jeongyoonlee left a comment

Choose a reason for hiding this comment

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

Thanks @heiderich for the contribution! It seems that prefer is indeed the right way to specify the backend in joblib instead of backend.

Could you share in which environment (e.g. OS, Python version, joblib version, etc.) you ran into the issue as a reference? Thanks!

@heiderich
Copy link
Contributor Author

@jeongyoonlee I already mentioned some of the relevant versions in #475. I just added the joblib version there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

fitting UpliftRandomForestClassifier uses more RAM in causalml 0.12.1 than in 0.12.0
2 participants