Rename plugins folder #726

mariaschuld · 2020-07-29T06:36:50Z

This PR renames the plugins folders in core PennyLane to "devices", to avoid confusion for developers (since what they contain are devices). It also updates some outdated docstrings here and there.

It is part of an overall effort to clarify our device ecosystem for users and developers.

NOTE:

After merging this PR, every developer would need to pip install -e . How can we communicate this to external developers?
At some later stage, it would be great to also update the "entry_points" string 'pennylane.plugins', which is used to load all installed devices. However, this requires changes to the setup file of all devices, and since only very few developers know about this string in the first place, this PR just adds a TODO.

pennylane/__init__.py

pennylane/devices/__init__.py

codecov · 2020-07-29T06:41:09Z

Codecov Report

Merging #726 into master will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master     #726   +/-   ##
=======================================
  Coverage   95.62%   95.62%           
=======================================
  Files         111      111           
  Lines        6944     6944           
=======================================
  Hits         6640     6640           
  Misses        304      304

Impacted Files	Coverage Δ
pennylane/__init__.py	`64.19% <ø> (ø)`
pennylane/beta/devices/__init__.py	`100.00% <ø> (ø)`
pennylane/beta/devices/numpy_ops.py	`100.00% <ø> (ø)`
pennylane/devices/__init__.py	`100.00% <ø> (ø)`
pennylane/devices/autograd_ops.py	`97.29% <ø> (ø)`
pennylane/devices/default_gaussian.py	`98.93% <ø> (ø)`
pennylane/devices/default_qubit.py	`98.31% <ø> (ø)`
pennylane/devices/default_qubit_tf.py	`86.95% <ø> (ø)`
pennylane/devices/tf_ops.py	`97.72% <ø> (ø)`
pennylane/qnodes/jacobian.py	`97.27% <ø> (ø)`
... and 3 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c2d27cc...fd54985. Read the comment docs.

pennylane/__init__.py

setup.py

… into rename_plugins_folder

antalszava

Looks good to me @mariaschuld! Thanks!

One important spot would be updating the Makefile too (here and once later):

pennylane/Makefile

Line 6 in 51dd8b4

PLUGIN_TESTRUNNER := -m pytest pennylane/plugins/tests --tb=native --no-flaky-report
Going for renaming the entry points could occur right before release for example.

mariaschuld · 2020-08-04T12:53:08Z

Going for renaming the entry points could occur right before release for example.

Great, thanks for pointing out the MakeFile!

mariaschuld · 2020-08-04T12:56:02Z

@josh146 I think the device tests are failing because CI needs to change the file path with this PR?

josh146 · 2020-08-04T13:14:55Z

@josh146 I think the device tests are failing because CI needs to change the file path with this PR?

@mariaschuld yep! You'll need to update the corresponding .github/workflow file to use the new directory structure when running the device tests

trbromley

Thanks @mariaschuld!

You mentioned

It is part of an overall effort to clarify our device ecosystem for users and developers.

I just wanted to ask roughly what the next steps will be? I noticed "plugin" is mentioned a lot still in the docs, could there be any occurrences there that warrant changing to "device"? Maybe that is for a follow up PR.

Makefile

trbromley · 2020-08-04T17:09:02Z

.github/CHANGELOG.md

@@ -64,6 +64,10 @@

 <h3>Improvements</h3>

+* The `pennylane.plugins` and `pennylane.beta.plugins` folders have been renamed to 


Do we want to update "Adds a device test suite, located at pennylane/plugins/tests"? This is for the current release so think it makes sense.

Also noticed that previously there are some links (line 140 and 143) that might be nice to update - I don't think we should change everything in the history, but it would be good for links to work

Would be better to do in separate PR? I am trying to be more disciplined with such things :)

codecov.yml

pennylane/devices/default_gaussian.py

pennylane/devices/default_qubit.py

.github/CHANGELOG.md

codecov.yml

josh146 · 2020-08-05T04:51:19Z

doc/code/qml_devices.rst

@@ -1,7 +1,7 @@
-qml.plugins
+qml.devices


I know it's a bit late to point this out, but I suddenly wonder if we will be introducing confusion between

qml.device

qml.Device

qml.devices

I suppose only option is to be really clear in the docs

pennylane/devices/__init__.py

pennylane/devices/default_qubit.py

setup.py

mariaschuld · 2020-08-05T15:17:19Z

I just wanted to ask roughly what the next steps will be? I noticed "plugin" is mentioned a lot still in the docs, could there be any occurrences there that warrant changing to "device"? Maybe that is for a follow up PR.

The next steps would be more about capabilities of devices that we need to standarise: Some don't have the attribute analytic, which we then also want to rename, and the capabilities dictionary must be updated to allow us to automatically showcase device capabilities on the webpage...But I'll put "docs" on the todo list :)

mariaschuld added 2 commits July 28, 2020 19:36

do refactor

2c8c139

reverse rename of entry point (introduces device load error)

5c3f903

mariaschuld commented Jul 29, 2020

View reviewed changes

pennylane/__init__.py Outdated Show resolved Hide resolved

mariaschuld commented Jul 29, 2020

View reviewed changes

pennylane/devices/__init__.py Show resolved Hide resolved

update docstrings

cbaa8fd

mariaschuld commented Jul 29, 2020

View reviewed changes

pennylane/__init__.py Show resolved Hide resolved

mariaschuld commented Jul 29, 2020

View reviewed changes

setup.py Show resolved Hide resolved

mariaschuld added 2 commits July 29, 2020 10:48

add todo

32dfeb1

changelog

0709394

mariaschuld requested review from josh146 and antalszava July 29, 2020 08:54

mariaschuld changed the title ~~[WIP] Rename plugins folder~~ Rename plugins folder Jul 29, 2020

mariaschuld added 7 commits July 29, 2020 12:47

Merge branch 'master' into rename_plugins_folder

0a4b8a5

rename instances in docs

6b63d9d

delete cov files

308da4b

Merge branch 'master' into rename_plugins_folder

4197080

Merge branch 'rename_plugins_folder' of github.com:XanaduAI/pennylane…

d77b4cd

… into rename_plugins_folder

Merge branch 'master' into rename_plugins_folder

4837226

Merge branch 'master' into rename_plugins_folder

2e82831

antalszava approved these changes Jul 31, 2020

View reviewed changes

change makefile and fix conflicts

262aded

mariaschuld added 2 commits August 4, 2020 14:58

Move autograd devices

f62b1cb

minor fix

5fcff97

mariaschuld added 2 commits August 4, 2020 17:43

update workflow

10e31a6

backup

86cc239

trbromley reviewed Aug 4, 2020

View reviewed changes

josh146 approved these changes Aug 5, 2020

View reviewed changes

fix conflicts

52ee330

mariaschuld added 4 commits August 5, 2020 17:18

polish

68a47b7

Tom's suggestions

33dac83

more code review items

088e3dc

docs clean up

fd54985

josh146 merged commit 378467c into master Aug 5, 2020

josh146 deleted the rename_plugins_folder branch August 5, 2020 16:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename plugins folder #726

Rename plugins folder #726

mariaschuld commented Jul 29, 2020 •

edited

Loading

codecov bot commented Jul 29, 2020 •

edited

Loading

antalszava left a comment

mariaschuld commented Aug 4, 2020

mariaschuld commented Aug 4, 2020

josh146 commented Aug 4, 2020

trbromley left a comment

trbromley Aug 4, 2020

trbromley Aug 4, 2020

mariaschuld Aug 5, 2020

josh146 Aug 5, 2020

mariaschuld commented Aug 5, 2020

		@@ -64,6 +64,10 @@

		<h3>Improvements</h3>

		* The `pennylane.plugins` and `pennylane.beta.plugins` folders have been renamed to

		@@ -1,7 +1,7 @@
		qml.plugins
		qml.devices

Rename plugins folder #726

Rename plugins folder #726

Conversation

mariaschuld commented Jul 29, 2020 • edited Loading

codecov bot commented Jul 29, 2020 • edited Loading

Codecov Report

antalszava left a comment

Choose a reason for hiding this comment

mariaschuld commented Aug 4, 2020

mariaschuld commented Aug 4, 2020

josh146 commented Aug 4, 2020

trbromley left a comment

Choose a reason for hiding this comment

trbromley Aug 4, 2020

Choose a reason for hiding this comment

trbromley Aug 4, 2020

Choose a reason for hiding this comment

mariaschuld Aug 5, 2020

Choose a reason for hiding this comment

josh146 Aug 5, 2020

Choose a reason for hiding this comment

mariaschuld commented Aug 5, 2020

mariaschuld commented Jul 29, 2020 •

edited

Loading

codecov bot commented Jul 29, 2020 •

edited

Loading