Command/Inst refactor: Pulses and Play (Qiskit#3936)

* Deprecate PulseCommands, create new Play Instruction-implementation. The Play instruction takes a Pulse and a PulseChannel. Pulse is a new class within the pulse library that is very close to the deprecated PulseCommand abstract class. The PulseCommand implementations (SamplePulse and the ParametricPulse subclasses) have been moved to the pulse library as well, subclassing from Pulse, and all valid arguments to Play.

* Update import statements in Pulse

* Fill in the implementation of some IP work like __call__

* Fill in and update documentation, complete import paths

* fixup cyclic imports

* IP updates to assemble_schedules for supporting Play instruction

* Give all pulses a name arg and update reno note

* Continue pulse_instruction conversion support for Play

* Add support for Play in assemble schedules, fix style

* Attempt to fix build error

* Add missing name field to Constant pulse

* To support __call__ from Pulse, I need to import Play, which means I can't import Pulse from Play (for typehints) for the timebeing

* Fixup bugs introduced in SamplePulse

* Update tests with new API

* Add tests and fixup missing name passing

* Fixup tests, remove deprecation warning from assemble execution, add hash and eq methods to pulses

* Fixup docs

* Update functional_pulse import path and Instruction type ref

* try again with the type hints

* Was missing updates to PulseCommand that needed to be migrated with the new Pulse class

* Was missing docstring type documentation for unresolvable type

* Was missing removal of PulseStyle in parametric pulses

* The changes from the sphinx warrnings pass hadn't been moved with the migrated ParametricPulses module. Moved the drag pulse docstring over finally

* Fix spacing in drag pulse docstring

* The docs should finally build now

* Update qiskit/pulse/instructions/play.py

Co-Authored-By: eggerdj <38065505+eggerdj@users.noreply.github.com>

* Update qiskit/pulse/pulse_lib/sample_pulse.py

Co-Authored-By: eggerdj <38065505+eggerdj@users.noreply.github.com>

* Apply suggestions from code review

Co-Authored-By: eggerdj <38065505+eggerdj@users.noreply.github.com>

* Documentation improvements

* Test change because linux python35 is failing

* Update releasenotes/notes/unify-instructions-and-commands-aaa6d8724b8a29d3.yaml

Co-Authored-By: eggerdj <38065505+eggerdj@users.noreply.github.com>

* Fix plotting Play instruction

* style, line length

* Attempt to fix failing test by comparing names directly

* Handle all instruction types in add_instruction

* Remove unused import

* Update releasenotes/notes/unify-instructions-and-commands-aaa6d8724b8a29d3.yaml

Co-Authored-By: Matthew Treinish <mtreinish@kortar.org>

* Separate note about Play feature into two notes: Play feature and Pulse movement

Co-authored-by: eggerdj <38065505+eggerdj@users.noreply.github.com>
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Author: 4 people

qiskit/assembler/assemble_schedules.py

@@ -17,9 +17,10 @@
 from typing import Any, Dict, List, Tuple
 
 from qiskit.exceptions import QiskitError
-from qiskit.pulse import Schedule, Delay, Acquire
+from qiskit.pulse import Schedule, Acquire, Delay, Play
+from qiskit.pulse.pulse_lib import ParametricPulse, SamplePulse
 from qiskit.pulse.commands import (Command, PulseInstruction, AcquireInstruction,
-                                   DelayInstruction, SamplePulse, ParametricInstruction)
+                                   DelayInstruction, ParametricInstruction)
 from qiskit.qobj import (PulseQobj, QobjHeader, QobjExperimentHeader,
                          PulseQobjInstruction, PulseQobjExperimentConfig,
                          PulseQobjExperiment, PulseQobjConfig, PulseLibraryItem)
@@ -170,15 +171,31 @@ def _assemble_instructions(
     acquire_instruction_map = defaultdict(list)
     for time, instruction in schedule.instructions:
 
-        if isinstance(instruction, ParametricInstruction):
+        if isinstance(instruction, Play) and isinstance(instruction.pulse, ParametricPulse):
+            pulse_shape = ParametricPulseShapes(type(instruction.pulse)).name
+            if pulse_shape not in run_config.parametric_pulses:
+                instruction = Play(instruction.pulse.get_sample_pulse(),
+                                   instruction.channel,
+                                   name=instruction.name)
+
+        if isinstance(instruction, ParametricInstruction):  # deprecated
             pulse_shape = ParametricPulseShapes(type(instruction.command)).name
             if pulse_shape not in run_config.parametric_pulses:
                 # Convert to SamplePulse if the backend does not support it
                 instruction = PulseInstruction(instruction.command.get_sample_pulse(),
                                                instruction.channels[0],
                                                name=instruction.name)
 
-        if isinstance(instruction, PulseInstruction):
+        if isinstance(instruction, Play) and isinstance(instruction.pulse, SamplePulse):
+            name = instruction.pulse.name
+            if instruction.pulse != user_pulselib.get(name):
+                name = "{0}-{1:x}".format(name, hash(instruction.pulse.samples.tostring()))
+                instruction = Play(SamplePulse(name=name, samples=instruction.pulse.samples),
+                                   channel=instruction.channel,
+                                   name=instruction.name)
+            user_pulselib[name] = instruction.pulse
+
+        if isinstance(instruction, PulseInstruction):  # deprecated
             name = instruction.command.name
             if name in user_pulselib and instruction.command != user_pulselib[name]:
                 name = "{0}-{1:x}".format(name, hash(instruction.command.samples.tostring()))

qiskit/pulse/__init__.py

@@ -132,13 +132,12 @@
 
 from .channels import (DriveChannel, MeasureChannel, AcquireChannel,
                        ControlChannel, RegisterSlot, MemorySlot)
-from .commands import (AcquireInstruction, FrameChange,
-                       PersistentValue, SamplePulse, ParametricPulse,
-                       ParametricInstruction, Gaussian,
-                       GaussianSquare, Drag, ConstantPulse, functional_pulse)
+from .commands import AcquireInstruction, FrameChange, PersistentValue
 from .configuration import LoConfig, LoRange, Kernel, Discriminator
 from .exceptions import PulseError
 from .instruction_schedule_map import InstructionScheduleMap
-from .instructions import Acquire, Instruction, Delay, ShiftPhase, Snapshot, SetFrequency
+from .instructions import Acquire, Instruction, Delay, Play, ShiftPhase, Snapshot, SetFrequency
 from .interfaces import ScheduleComponent
+from .pulse_lib import SamplePulse, Gaussian, GaussianSquare, Drag, ConstantPulse, ParametricPulse
+from .pulse_lib.samplers.decorators import functional_pulse
 from .schedule import Schedule

qiskit/pulse/commands/delay.py

@@ -15,14 +15,15 @@
 """Delay instruction. Deprecated path."""
 import warnings
 
+from ..channels import Channel
 from ..instructions import Delay
 from ..instructions import Instruction
 
 
 class DelayInstruction(Instruction):
     """Deprecated."""
 
-    def __init__(self, command: Delay, channel: Delay, name: str = None):
+    def __init__(self, command: Delay, channel: Channel, name: str = None):
         """Create a delay instruction from a delay command.
 
         Args: