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

Add comment on multiprocessing. #4622

Merged
merged 8 commits into from
Sep 22, 2023
Merged

Conversation

vincentmr
Copy link
Contributor

@vincentmr vincentmr commented Sep 21, 2023

Before submitting

Please complete the following checklist when submitting a PR:

  • All new features must include a unit test.
    If you've fixed a bug or added code that should be tested, add a test to the
    test directory!

  • All new functions and code must be clearly commented and documented.
    If you do make documentation changes, make sure that the docs build and
    render correctly by running make docs.

  • Ensure that the test suite passes, by running make test.

  • Add a new entry to the doc/releases/changelog-dev.md file, summarizing the
    change, and including a link back to the PR.

  • The PennyLane source code conforms to
    PEP8 standards.
    We check all of our code against Pylint.
    To lint modified files, simply pip install pylint, and then
    run pylint pennylane/path/to/file.py.

When all the above are checked, delete everything above the dashed
line and fill in the pull request template.


Context:
Multiprocessing sometimes fails without much clue.

Description of the Change:
Add a warning in the DefaultQubit doc regarding potential erratic behaviour of multiprocessing and a possible to solve it.

Benefits:

Possible Drawbacks:

Related GitHub Issues:

@codecov
Copy link

codecov bot commented Sep 21, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (f56e4fe) 99.63% compared to head (adc14a7) 99.63%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4622   +/-   ##
=======================================
  Coverage   99.63%   99.63%           
=======================================
  Files         375      375           
  Lines       33547    33547           
=======================================
  Hits        33423    33423           
  Misses        124      124           
Files Changed Coverage Δ
pennylane/devices/default_qubit.py 100.00% <ø> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@vincentmr vincentmr marked this pull request as ready for review September 21, 2023 19:40
@vincentmr vincentmr requested review from timmysilv and a team September 21, 2023 19:40
Copy link
Contributor

@mudit2812 mudit2812 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, just one comment. I'll approve after it's addressed.

pennylane/devices/default_qubit.py Outdated Show resolved Hide resolved
pennylane/devices/default_qubit.py Outdated Show resolved Hide resolved
@timmysilv
Copy link
Contributor

content looks excellent, but I think DefaultQubit's intro section is getting a bit too lengthy. Can you move the multiprocessing stuff below the backprop stuff, and put it into a drop-down (ps: drop-downs can be made like this in sphinx)?

Copy link
Contributor

@timmysilv timmysilv left a comment

Choose a reason for hiding this comment

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

🎉 love it :shipit: :shipit:

@vincentmr vincentmr merged commit a05babb into master Sep 22, 2023
39 checks passed
@vincentmr vincentmr deleted the enhance/dq_multiprocessing_doc branch September 22, 2023 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants