Interfaccia plugin Transpiler Stage

qiskit.transpiler.preset_passmanagers.plugin

Questo modulo definisce l'interfaccia del plugin per fornire implementazioni personalizzate delle fasi per i gestori dei passaggi predefiniti e per transpile() la funzione. Ciò consente ai pacchetti esterni di Python di fornire PassManager oggetti che possono essere utilizzati per ciascuna fase specificata.

Le interfacce dei plugin sono costruite utilizzando i punti di ingresso di setuptools che consentono ai pacchetti esterni a Qiskit di pubblicizzare l'inclusione di uno o più stadi del transpiler.

Per i dettagli su come scrivere invece i plugin per i metodi di sintesi del transpiler, vedere qiskit.transpiler.passes.synthesis.plugin.

Fasi del plugin

Ci sono sei stadi nei gestori dei passaggi di preselezione, che caricano attivamente i plugin esterni utilizzando i punti di ingresso corrispondenti. La tabella seguente riassume ogni fase. Per maggiori dettagli sulla descrizione e sulle aspettative di ogni fase, seguite il link al nome della fase per accedere alla documentazione completa.

Scrittura dei plugin

Per scrivere un plugin per la fase di gestione dei pass sono necessari due passaggi principali. Il primo passo consiste nel creare una sottoclasse della classe PassManagerStagePlugin astratta del plugin, che viene utilizzata per definire come verrà costruito il plugin PassManager per lo stage. Ad esempio, per creare un layout plugin di fase che si limiti a eseguire VF2Layout (con un numero crescente di tentativi, a seconda del livello di ottimizzazione) e che ricorra all'uso TrivialLayout di qualora VF2Layout non riesca a trovare una disposizione perfetta:

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

Il secondo passo consiste nell'indicare la PassManagerStagePlugin sottoclasse come punto di accesso di setuptools nei metadati del pacchetto. Questo può essere fatto in una entry-points tabella in pyproject.toml per il pacchetto del plugin, con i punti di ingresso necessari nel namespace appropriato per lo stadio a cui è destinato il plugin. È possibile visualizzare l'elenco delle fasi, dei punti di ingresso e delle aspettative relative a ciascuna fase nella sezione " Fasi del plugin ". Ad esempio, riprendendo l'esempio del plugin riportato sopra:

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

Non c'è limite al numero di plugin che un singolo pacchetto può includere, purché ogni plugin abbia un nome unico. Quindi un singolo pacchetto può esporre più plugin, se necessario. Per un elenco dei nomi riservati per ogni fase, fare riferimento a Fasi del plugin.

API del plugin

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
 ...