Utilitaires

qiskit.utils.add_deprecation_to_docstring(func, msg, *, since, pending)

Insérer dynamiquement le message de dépréciation dans la docstring de func.

Paramètres

• func (Callable) – La fonction à modifier.
• msg (str) – Le message de dépréciation complet.
• since (str | None) – La version à laquelle la dépréciation a commencé.
• pending (bool) – La dépréciation est-elle toujours en cours?

Type de retour

Aucun

qiskit.utils.deprecate_arg(name, *, since, additional_msg=None, deprecation_description=None, pending=False, package_name='Qiskit', new_alias=None, predicate=None, removal_timeline='no earlier than 3 months after the release date')

Décorateur indiquant qu'un argument a été déprécié d'une manière ou d'une autre.

Ce décorateur peut être utilisé plusieurs fois sur la même fonction, une fois par argument déprécié. Il doit être placé en dessous d'autres décorateurs tels que @staticmethod et les décorateurs immobiliers.

Paramètres

• name (str) – Le nom de l'argument déprécié.
• since (str) – La version à laquelle la dépréciation a commencé. Si la dépréciation est en cours, fixez la version au moment où elle a commencé; mais plus tard, lorsque vous passerez de la catégorie "en cours" à la catégorie "dépréciée", mettez à jour "depuis" avec la nouvelle version.
• deprecation_description (str | None) – Qu'est-ce qui est déprécié? E.g. "Setting my_func()'s my_arg argument to None" Si elle n'est pas définie, la valeur par défaut sera " {func_name} 's argument {name} ".
• additional_msg (str | None) – Indiquez ici toute information supplémentaire, par exemple ce qu'il faut utiliser à la place (si new_alias n'est pas défini). Par exemple, "Utilisez plutôt l'argument new_arg, qui est similaire mais n'a pas d'impact sur la configuration du circuit"
• pending (bool) – Vrai si la dépréciation est toujours en cours.
• package_name (str) – Le nom du paquet indiqué dans le message de dépréciation (par exemple, le nom du paquet PyPI ).
• new_alias (str | None) – Si l'arg a simplement été renommé, il faut lui attribuer le nouveau nom. Le décorateur mettra dynamiquement à jour les kwargs de sorte que lorsque l'utilisateur définira l'ancien arg, celui-ci sera transmis en tant que nouvel arg d'alias.
• predicate (Callable[[Any], bool] | None) – Enregistrez l'avertissement d'exécution uniquement si le prédicat renvoie la valeur True. Cela est utile pour déprécier certaines valeurs ou certains types pour un argument, par exemple lambda my_arg : isinstance(my_arg, dict). Que le prédicat soit défini ou non, l'avertissement d'exécution ne sera consigné que lorsque l'utilisateur spécifie l'argument.
• removal_timeline (str) – Dans combien de temps cette dépréciation pourra-t-elle être supprimée? Attend une valeur telle que "au plus tôt 6 mois après la dernière version" ou "dans la version 9.99 ".

Retours

L'objet à appeler décoré.

Type de retour

Appelable

qiskit.utils.deprecate_func(*, since, additional_msg=None, pending=False, package_name='Qiskit', removal_timeline='no earlier than 3 months after the release date', is_property=False, stacklevel=2)

Décorateur indiquant qu'une fonction a été dépréciée.

Il doit être placé en dessous d'autres décorateurs comme @staticmethod et les décorateurs de propriété.

Lors de la dépréciation d'une classe, ce décorateur est appliqué à sa fonction \N_init_\N.

Paramètres

• since (str) – La version à laquelle la dépréciation a commencé. Si la dépréciation est en cours, fixez la version à la date de début de la dépréciation; mais plus tard, lorsque vous passerez de la catégorie "en cours" à la catégorie "dépréciée", mettez à jour since en fonction de la nouvelle version.
• additional_msg (str | None) – Indiquez ici toute information supplémentaire, par exemple ce qu'il convient d'utiliser à la place. Par exemple, "Utilisez plutôt la fonction new_func du module <my_module>.<my_submodule>, qui est similaire mais utilise l'accélération GPU"
• pending (bool) – Défini à True si la dépréciation est toujours en cours.
• package_name (str) – Le nom du paquet indiqué dans le message de dépréciation (par exemple, le nom du paquet PyPI ).
• removal_timeline (str) – Dans combien de temps cette dépréciation pourra-t-elle être supprimée? Attend une valeur telle que "au plus tôt 6 mois après la dernière version" ou "dans la version 9.99 ".
• is_property (bool) – Si la fonction obsolète est une @property, définissez cette option sur True afin que le message généré la présente correctement comme telle. (Cela n'est pas nécessaire pour les accesseurs de propriété, car leur chaîne de documentation est ignorée par Python.)
• stacklevel (int) – Niveau de pile transmis à warnings.warn().

Retours

L'objet à appeler décoré.

Type de retour

Appelable

qiskit.utils.apply_prefix(value, unit)

Étant donné le préfixe et la valeur d'une unité SI, appliquer le préfixe pour convertir en unité SI standard.

Paramètres

• value (float |ParameterExpression) – Le numéro auquel appliquer le préfixe.
• unit (str) – Préfixe de la chaîne.

Retours

Valeur convertie.

Type de retour

float | ParameterExpression

Augmentations

ValueError – Si le unit n'est pas reconnu.

Paramètres

• value (float |ParameterExpression)
• unit (str)

Type de retour

float | ParameterExpression

qiskit.utils.detach_prefix(value, decimal=None)

Étant donné la valeur d'une unité SI, trouver le préfixe le plus approprié pour mettre cette valeur à l'échelle.

Par exemple, le site value = 1.3e8 sera converti en un tuple de (130.0, "M"), qui représente une valeur mise à l'échelle et une unité auxiliaire pouvant être utilisée pour afficher la valeur. Dans l'exemple ci-dessus, cette valeur pourrait être affichée sous la forme 130 MHz (l'unité est ici arbitraire).

Exemple

>>> value, prefix = detach_prefix(1e4)
>>> print(f"{value} {prefix}Hz")
10 kHz

Paramètres

• value (float) – Le numéro de recherche du préfixe.
• decimal (int | None) – En option. Un nombre entier arbitraire pour représenter la précision de la valeur. Si elle est spécifiée, elle tente d'arrondir la mantisse et d'ajuster le préfixe à la valeur arrondie. Par exemple, 999_999.91 deviendra 999.9999 k avec decimal=4, tandis que 1.0 M avec decimal=3 ou moins.

Retours

Un tuple de la valeur mise à l'échelle et du préfixe.

Type de retour

tuple[ float, str ]

Augmentations

• ValueError - Si le site value est hors de portée.
• ValueError - Si le value n'est pas un nombre réel.

Paramètres

• value (float)
• decimal (int | None)

Type de retour

tuple[ float, str ]

qiskit.utils.wrap_method(cls, name, *, before=None, after=None)

Envelopper la fonctionnalité de la méthode d'instance ou de classe cls.name avec un comportement supplémentaire before et after.

Cette opération fait muter cls, en remplaçant l'attribut name par la nouvelle fonctionnalité. Ceci est utile lors de la création de décorateurs de classe. La méthode peut être définie dans n'importe quelle classe mère à la place.

Si before ou after sont fournis, ils doivent être des callables dont la signature est compatible avec la méthode à laquelle il est fait référence. Elles seront appelées immédiatement avant ou après la méthode, selon le cas, et toute valeur de retour sera ignorée.

Paramètres

• cls (type) – la classe à modifier.
• name (str) – le nom de la méthode de la classe à intégrer.
• before (Callable | None) – une fonction qui doit être appelée avant la méthode encapsulée.
• after (Callable | None) – une fonction qui doit être appelée après la méthode encapsulée.

Augmentations

ValueError - si la méthode nommée n'est pas définie dans la classe ou dans une classe parente.

qiskit.utils.default_num_processes()

Obtenir le nombre de processus qu'un appel parallèle multiprocessus utilisera par défaut.

Ces fonctions acceptent généralement un mot-clé num_processes qui remplacera la valeur renvoyée par cette fonction.

Par ordre de priorité (du plus élevé au plus bas), la valeur de retour sera la suivante :

1. La variable d'environnement QISKIT_NUM_PROCS , si elle est définie.
2. La clé num_processes du fichier de configuration utilisateur de Qiskit, si elle est définie.
3. La moitié des CPU logiques disponibles pour ce processus, si cela peut être déterminé. Il s'agit d'une approximation du nombre de CPU physiques, en supposant un double multithreading simultané (SMT); empiriquement, les performances de Qiskit en matière de multiprocessing semblent être moins bonnes lorsque l'on tente d'utiliser des cœurs SMT.
4. 1, si tout le reste échoue.

Si une valeur configurée par l'utilisateur est fixée à un nombre inférieur à 1, elle est traitée comme si elle était égale à 1.

Type de retour

int

qiskit.utils.is_main_process()

Vérifie si le processus en cours est le processus principal.

Puisque Python 3.8, ce calcul est identique à la méthode standard Python :

>>> import multiprocessing
>>> multiprocessing.parent_process() is None

Cette fonction est laissée pour la compatibilité ascendante, mais il y a peu de raisons de ne pas utiliser l'outillage intégré de Python.

Type de retour

booléen

qiskit.utils.local_hardware_info()

Informations matérielles de base sur la machine locale.

Tente d'estimer le nombre de CPU physiques dans la machine, même lorsque l'hyperthreading est activé. Le nombre de CPU est fixé par défaut à 1 lorsque le nombre réel ne peut être déterminé.

Retours

Les informations sur le matériel.

Type de retour

dict

qiskit.utils.should_run_in_parallel(num_processes=None)

Décider si une fonction multiprocessus doit générer des sous-processus pour la parallélisation.

En particulier, c'est ainsi que parallel_map() décide d'utiliser ou non le multiprocessing. L'argument num_processes seul n'impose pas le parallélisme; par défaut, Qiskit n'utilisera le parallélisme basé sur les processus que lorsqu'une méthode de démarrage de processus de type fork est en vigueur. Vous pouvez passer outre cette décision en définissant la méthode de démarrage que vous utilisez multiprocessing que vous utilisez, en définissant la variable d'environnement QISKIT_PARALLEL sur "TRUE", ou en définissant parallel = true dans votre fichier de paramètres utilisateur.

Cette fonction comprend deux gestionnaires de contexte qui peuvent être utilisés pour modifier temporairement la valeur de retour de cette fonction :

override

ignore_user_settings

Paramètres

num_processes (int | None) – le nombre maximal de processus à utiliser (None est la valeur par défaut).

Type de retour

booléen

Exemples

Remplacer temporairement les paramètres configurés pour désactiver le parallélisme :

>>> with should_run_in_parallel.override(True):
...     assert should_run_in_parallel(8)
>>> with should_run_in_parallel.override(False):
...     assert not should_run_in_parallel(8)

qiskit.utils.parallel_map(task, values, task_args=(), task_kwargs=None, num_processes=None)

Exécution parallèle d'un mappage de valeurs à la tâche de la fonction. Cela équivaut fonctionnellement à :

result = [task(value, *task_args, **task_kwargs) for value in values]

Les résultats seront parallélisés si le nombre d'adresses values est supérieur à un should_run_in_parallel() renvoie True. Si ce n'est pas le cas, il sera exécuté en série.

Paramètres

• task (func) – Fonction qui doit être appelée pour chaque valeur dans values.
• values (array_like) – Liste ou tableau de valeurs pour lesquelles la fonction task doit être évaluée.
• task_args (list) – Arguments supplémentaires facultatifs pour la fonction task .
• task_kwargs (dict) – Mot-clé supplémentaire facultatif pour la fonction task .
• num_processes (int) – Nombre de processus à lancer. Si elle n'est pas donnée, la valeur de retour de default_num_processes() est utilisée.

Retours

La liste des résultats contient la valeur de task(value, *task_args, **task_kwargs) pour chaque valeur de values.

Type de retour

résultat

Exemples

import time
from qiskit.utils import parallel_map
def func(_):
        time.sleep(0.1)
        return 0
parallel_map(func, list(range(10)));

Qiskit Aer propose des simulateurs hautement performants pour les circuits quantiques créés dans Qiskit.

Le site Qiskit IBMQ Provider est utilisé pour accéder au matériel IBM Quantum dans le nuage IBM.

Qiskit Ignis fournit des outils pour la vérification du matériel quantique, la caractérisation du bruit et la correction des erreurs.

Qiskit TOQM fournit des passes de transpilation pour l' algorithme de mappage Qubit optimal en temps.

python-constraint est un solveur de problèmes de satisfaction de contraintes, utilisé dans la CSPLayout passe de transcompilation.

L'optimiseur CPLEX d' IBM est un solveur de programmation mathématique hautement performant destiné à la programmation linéaire, mixte-entière et quadratique. Cette option n'est plus utilisée par Qiskit, mais elle l'était auparavant et est conservée à des fins de compatibilité ascendante.

CVXPY est un paquetage Python pour la résolution de problèmes d'optimisation convexe. Il est nécessaire pour calculer les normes de diamant avec quantum_info.diamond_norm().

IBM Decision Optimization CPLEX Modelling est une bibliothèque dédiée à l'analyse prescriptive. Tout comme CPLEX, cette option n'est plus utilisée par Qiskit, mais elle l'était auparavant et a été conservée à des fins de compatibilité ascendante.

La suite de tests comporte des fonctionnalités supplémentaires qui sont disponibles si le module de fixation optionnel est installé. En règle générale, il faut également HAS_TESTTOOLS également. Ceci n'est généralement nécessaire que pour les développeurs Qiskit.

Si le noyau IPython est disponible, certaines visualisations supplémentaires et certaines magies de ligne sont disponibles.

Des widgets de surveillance pour les travaux exécutés sur des serveurs externes peuvent être fournis si ipywidgets est disponible.

Certaines méthodes de calcul de gradient dans opflow.gradients nécessitent JAX pour l'autodifférenciation.

Certains tests nécessitent une installation complète de Jupyter pour tester les fonctions d'interactivité.

Qiskit fournit plusieurs outils de visualisation dans le module visualization module. La quasi-totalité d'entre eux sont construits à l'aide de Matplotlib qui doit être installé pour pouvoir les utiliser.

N'est plus utilisé par Qiskit. En interne, Qiskit utilise maintenant la bibliothèque haute performance rustworkx comme dépendance principale, et pendant la période de transition, il était parfois pratique de convertir les choses dans le format Python -only NetworkX uniquement. Certains tests de modules d'application, tels que Qiskit Nature, utilisent encore NetworkX.

NLopt est une bibliothèque d'optimisation non linéaire, utilisée par les optimiseurs globaux du module algorithms.optimizers .

PIL est une bibliothèque de manipulation d'images de type « Python ». Qiskit utilise en fait le fork « pillow » de PIL s’il est disponible lors de la génération de certaines visualisations, par exemple celles de QuantumCircuit et DAGCircuit dans certains modes.

Pour certaines visualisations de graphes, Qiskit utilise pydot comme interface avec GraphViz (voir HAS_GRAPHVIZ).

Pygments est un surligneur de code et un formateur utilisé par de nombreux environnements qui impliquent un affichage riche des blocs de code, y compris Sphinx et Jupyter. Qiskit l'utilise pour produire des documents riches pour ces environnements.

Diverses visualisations de LaTeX-based, en particulier les tiroirs de circuits, ont besoin d'un accès au projet pylatexenc pour fonctionner correctement.

Les fonctions qasm3.load() et qasm3.loads() pour importer les programmes OpenQASM 3 dans les instances QuantumCircuit instances utilisent un paquetage d'importateur externe.

Qiskit fournit plusieurs outils de visualisation dans le module visualization module. Certains d'entre eux sont construits à l'aide de Seaborn, qui doit être installé pour pouvoir les utiliser.

Certaines fonctions de gradient dans opflow.gradients utilisent des méthodes de régularisation de Scikit Learn.

Certains optimiseurs de algorithms.optimizers sont basés sur ceux de Scikit Quant, qui doit être installé pour les utiliser.

SQSnobFit est une bibliothèque pour l'algorithme "stable noisy optimization by branch and fit". Il est utilisé par l'optimiseur SNOBFIT .

Symengine est un backend C++ rapide pour la bibliothèque de manipulation symbolique Sympy. ParameterCette dépendance sert à charger les anciens formats QPY, pour lesquels ce paquet était utilisé.

SymPy est une bibliothèque d' Python s dédiée aux mathématiques symboliques. SymPy était autrefois utilisé pour l'implémentation de la ParameterExpression classe, mais ce n'est plus le cas aujourd'hui. Cependant, cela est nécessaire pour certaines fonctionnalités héritées qui utilisent ParameterExpression.sympify(). Il est également utilisé dans certaines fonctions de visualisation et dans la reconnaissance de formes.

La suite de tests de Qiskit dispose de fonctionnalités plus avancées si la bibliothèque optionnelle testtools est installée. Ceci n'est généralement nécessaire que pour les développeurs Qiskit.

Tweedledum est une bibliothèque d'extension dédiée à la synthèse et à l'optimisation de circuits pouvant faire appel à des oracles classiques. Par le passé, Qiskit PhaseOracle utilisait cette fonctionnalité, mais elle n'est plus utilisée par Qiskit.

Z3 est un démonstrateur de théorèmes, utilisé dans les CrosstalkAdaptiveSchedule étapes de compilation et HoareOptimizer .

Pour certaines visualisations de graphes, Qiskit utilise l'outil de visualisation GraphViz via son interface pydot (voir HAS_PYDOT).

Les outils de visualisation qui utilisent LaTeX dans leurs résultats, tels que les tiroirs de circuits, nécessitent que pdflatex soit disponible. Vous devrez généralement vous assurer que vous disposez d'une installation LaTeX fonctionnelle et du paquetage qcircuit.tex .

Les outils de visualisation qui convertissent les fichiers LaTeX-generated en images tramées utilisent l'outil pdftocairo . Il fait partie de la suite d'outils PDF Poppler.