Interfaz del complemento Transpiler Stage

qiskit.transpiler.preset_passmanagers.plugin

Este módulo define la interfaz de plugin para proporcionar implementaciones de escenario personalizadas para los gestores de pases predefinidos y la función transpile() función Esto permite a los paquetes externos Python proporcionar PassManager objetos que se pueden utilizar para cada etapa nombrada.

Las interfaces de plugin se construyen utilizando puntos de entrada setuptools que permiten a los paquetes externos a Qiskit anunciar que incluyen una etapa(s) de transpilador.

Para obtener más información sobre cómo escribir plugins para los métodos de síntesis del transpilador, consulte qiskit.transpiler.passes.synthesis.plugin.

Etapas del complemento

Hay seis etapas en los gestores de pases predefinidos, todas las cuales cargan activamente plugins externos utilizando los puntos de entrada correspondientes. El siguiente cuadro resume cada etapa. Para más detalles sobre la descripción y las expectativas de cada etapa, siga el enlace que aparece en el nombre de las etapas para acceder a la documentación completa.

Escribir complementos

Para escribir un plugin pass manager stage hay 2 pasos principales. El primer paso es crear una subclase de la clase abstracta plugin PassManagerStagePlugin que se utiliza para definir cómo se construirá el PassManager del escenario. Por ejemplo, para crear un plugin de etapas layout que sólo ejecute VF2Layout (con un número creciente de pruebas, dependiendo del nivel de optimización) y vuelve a usar TrivialLayout si VF2Layout es incapaz de encontrar un diseño perfecto:

from qiskit.transpiler.preset_passmanagers.plugin import PassManagerStagePlugin
from qiskit.transpiler.preset_passmanagers import common
from qiskit.transpiler import PassManager
from qiskit.transpiler.passes import VF2Layout, TrivialLayout
from qiskit.transpiler.passes.layout.vf2_layout import VF2LayoutStopReason
from qiskit.passmanager import ConditionalController


def _vf2_match_not_found(property_set):
    return property_set.get("layout") is None or (
        property_set.get("VF2Layout_stop_reason") is not None
        and property_set.get("VF2Layout_stop_reason")
        is not VF2LayoutStopReason.SOLUTION_FOUND
    )


class VF2LayoutPlugin(PassManagerStagePlugin):
    def pass_manager(self, pass_manager_config, optimization_level):
        layout_pm = PassManager(
            [
                VF2Layout(
                    coupling_map=pass_manager_config.coupling_map,
                    max_trials=optimization_level * 10 + 1,
                    target=pass_manager_config.target,
                ),
                ConditionalController(
                    TrivialLayout(pass_manager_config.coupling_map),
                    condition=_vf2_match_not_found,
                ),
            ]
        )
        layout_pm += common.generate_embed_passmanager(pass_manager_config.coupling_map)
        return layout_pm

El segundo paso consiste en definir la PassManagerStagePlugin subclase como punto de entrada de setuptools en los metadatos del paquete. Esto se puede hacer en una entry-points tabla de pyproject.toml para el paquete del complemento, incluyendo los puntos de entrada necesarios bajo el espacio de nombres adecuado para la etapa a la que está destinado el complemento. Puedes consultar la lista de etapas, puntos de entrada y expectativas de cada etapa en «Etapas del complemento ». Por ejemplo, retomando el plugin del ejemplo anterior:

[project.entry-points."qiskit.transpiler.layout"]
"vf2" = "qiskit_plugin_pkg.module.plugin:VF2LayoutPlugin"

No hay límite en el número de plugins que puede incluir un mismo paquete, siempre que cada plugin tenga un nombre único. Así, un solo paquete puede exponer varios plugins si es necesario. Consulte Etapas del plugin para ver una lista de nombres reservados para cada etapa.

API del complemento

list_stage_plugins

passmanager_stage_plugins

from qiskit.transpiler.preset_passmanagers.plugin import passmanager_stage_plugins
routing_plugins = passmanager_stage_plugins('routing')
basic_plugin = routing_plugins['basic']
help(basic_plugin)

Help on BasicSwapPassManager in module ...preset_passmanagers.builtin_plugins object:

class BasicSwapPassManager(...preset_passmanagers.plugin.PassManagerStagePlugin)
 |  Plugin class for routing stage with :class:`~.BasicSwap`
 |
 |  Method resolution order:
 |      BasicSwapPassManager
 |      ...preset_passmanagers.plugin.PassManagerStagePlugin
 |      abc.ABC
 |      builtins.object
 ...