ユーティリティー

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

funcの docstring に非推奨メッセージを動的に挿入する。

パラメーター

• func (Callable) – 変更する関数
• msg (str) – 非推奨メッセージの全文。
• since (str | None) – 非推奨が始まったバージョン。
• pending (bool) – 廃止はまだ保留ですか？

戻りの型

なし

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')

引数が何らかの形で非推奨になったことを示すデコレータ。

このデコレーターは、非推奨の引数1つにつき1回、同じ関数で複数回使うことができる。 @staticmethod 、不動産装飾家など他の装飾家の下に配置されるべきである。

パラメーター

• name (str) – 非推奨の引数の名前。
• since (str) – 非推奨が始まったバージョン。 もし非推奨が保留中であれば、その開始時のバージョンを設定する。しかしその後、保留から非推奨に切り替わるときには、それ以降を新しいバージョンに更新する。
• deprecation_description (str | None) – 何が非推奨なのか？ E.g. "my_func()のmy_arg引数をNoneに設定" 設定されていない場合、デフォルトは " {func_name} 'の引数 {name} " となる。
• additional_msg (str | None) – (new_aliasが設定されていない場合)代わりに何を使うかなどの追加情報をここに入れる。 例えば、"代わりに、似ているが回路のセットアップに影響を与えない引数new_argを使う。"
• pending (bool) – 非推奨がまだ保留中の場合はTrueに設定する。
• package_name (str) – 非推奨メッセージに表示されているパッケージ名（例： PyPI パッケージ名）。
• new_alias (str | None) – argの名前が変更されただけの場合は、新しい名前を設定する。 decoratorはkwargsを動的に更新し、ユーザが古いargを設定すると、それが新しいalias argとして渡されるようにする。
• predicate (Callable[[Any], bool] | None) – 述語が真を返す場合にのみ、実行時警告をログに記録する。 これは引数に対して特定の値や型を非推奨とするのに有用です。例：lambda my_arg: isinstance(my_arg, dict)。 述語が設定されているかどうかにかかわらず、実行時警告はユーザーが引数を指定した場合にのみログに記録されます。
• removal_timeline (str) – この非推奨措置はどのくらいで解除されるのか？ 最新リリースから6ヶ月以内」や「リリース時 9.99 」のような値を期待する。

戻り値

装飾された callable。

戻りの型

呼び出し可能

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)

関数が非推奨になったことを示すデコレータ。

staticmethodやpropertyデコレーターなど、他のデコレーターの下に配置する。

クラスを非推奨にする場合、このデコレータをそのクラスの ㊟_init ㊟_関数に設定します。

パラメーター

• since (str) – 非推奨が始まったバージョン。 もし非推奨が保留中であれば、その開始時のバージョンを設定する。しかしその後、保留から非推奨に切り替わったら、 since 、新しいバージョンに更新する。
• additional_msg (str | None) – 代わりに何を使うかなど、追加情報があればここに記入する。 例えば、"代わりに、モジュール <my_module>.<my_submodule> の関数 new_func を使ってください
• pending (bool) – 非推奨がまだ保留中の場合は True に設定する。
• package_name (str) – 非推奨メッセージに表示されているパッケージ名（例： PyPI パッケージ名）。
• removal_timeline (str) – この非推奨措置はどのくらいで解除されるのか？ 最新リリースから6ヶ月以内」や「リリース時 9.99 」のような値を期待する。
• is_property (bool) – 非推奨の関数が @property である場合は、生成されるメッセージで正しくその旨が記述されるように、これを True に設定してください。 （プロパティのセッターについては、 Python によってその docstring が無視されるため、これは必要ありません。）
• stacklevel (int) – に渡されるスタックレベル warnings.warn().

戻り値

装飾された callable。

戻りの型

呼び出し可能

qiskit.utils.apply_prefix(value, unit)

SI 単位の接頭辞と値が与えられた場合、接頭辞を適用して標準 SI 単位に変換する。

パラメーター

• value (float |ParameterExpression) – プレフィックスを適用する番号。
• unit (str) – 文字列の接頭辞。

戻り値

変換された値。

戻りの型

フロート ParameterExpression

レイズ

ValueError – が認識 unit されない場合。

パラメーター

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

戻りの型

フロート ParameterExpression

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

SI 単位の値が与えられた場合、その値をスケーリングするために最も適した接頭辞を見つけよ。

例えば、 value = 1.3e8 は、 (130.0, "M") のタプルに変換される。このタプルは、スケーリングされた値と、値の表示に使用できる補助単位を表す。 上記の例では、その値は 130 MHz （単位は任意）と表示されるかもしれない。

例

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

パラメーター

• value (float) – 接頭辞を探す番号。
• decimal (int | None) – オプションだ。 値の精度を表す任意の整数。 指定された場合、仮数を丸め、接頭辞を丸めた値に調整しようとする。 例えば、 999_999.91 は、 decimal=4 で 999.9999 k となり、 decimal=3 以下で 1.0 M となる。

戻り値

スケーリングされた値と接頭辞のタプル。

戻りの型

タプル[ float, str］

レイズ

• ValueError - value が範囲外の場合。
• ValueError - value が実数でない場合。

パラメーター

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

戻りの型

タプル[ float, str］

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

インスタンスメソッドまたはクラスメソッド cls.name の機能を、追加の振る舞い before と after でラップします。

これは cls を変異させ、属性 name を新しい機能で置き換える。 これはクラス・デコレーターを作るときに便利だ。 このメソッドは、代わりにどの親クラスにも定義できる。

before 、 after のいずれかが与えられた場合は、参照されるメソッドと互換性のあるシグネチャを持つcallableでなければならない。 これらのメソッドは、必要に応じてメソッドの直前または直後に呼び出され、戻り値は無視される。

パラメーター

• cls (type) – 変更するクラス。
• name (str) – ラップするクラスのメソッド名。
• before (Callable | None) – ラップされるメソッドの前に呼び出すべきコールバック関数。
• after (Callable | None) – ラップ対象のメソッドの実行後に呼び出されるべきコールバック関数。

レイズ

ValueError - 指定されたメソッドがクラスや親クラスで定義されていない場合。

qiskit.utils.default_num_processes()

マルチプロセッシング並列呼び出しがデフォルトで使用するプロセス数を取得する。

このような関数は通常、この関数から返される値よりも優先される num_processes キーワード引数も受け付ける。

優先順位の高い順（高い方から低い方）に、戻り値は次のようになる：

1. 設定されていれば、 QISKIT_NUM_PROCS 環境変数。
2. 設定されている場合、Qiskitユーザー設定ファイルの num_processes キー。
3. このプロセスで使用可能な論理CPUの半分（もしこれが決定できる場合）。 経験的に、Qiskitのマルチプロセッシング性能は、SMTコアを使おうとすると悪くなるようです。
4. 1、万策尽きたら

ユーザー設定値が1より小さい数値に設定されている場合、その値は1であるかのように扱われる。

戻りの型

int

qiskit.utils.is_main_process()

現在のプロセスがメインかどうかをチェックする。

Python 3.8、これは標準的な Python の計算方法と同じである：

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

この機能は後方互換性のために残されているが、 Python のビルトインツールを使わない理由はほとんどない。

戻りの型

bool

qiskit.utils.local_hardware_info()

ローカルマシンの基本的なハードウェア情報。

ハイパースレッディングがオンになっている場合でも、マシンの物理CPU数を推定しようとする。 CPUカウントは、真のカウントが決定できない場合、デフォルトで1になる。

戻り値

ハードウェア情報。

戻りの型

dict

qiskit.utils.should_run_in_parallel(num_processes=None)

マルチプロセッシング関数が並列化のためにサブプロセスを生成すべきかどうかを決定する。

特に parallel_map() がマルチプロセシングを使うかどうかを決定する方法である。 num_processes デフォルトでは、Qiskitは fork-like process spawning start methodが有効な場合にのみプロセスベースの並列性を使用します。 この決定 は、使用する開始方法を設定することで上書きできる。 multiprocessing を設定するか、環境変数 QISKIT_PARALLEL を "TRUE" に設定するか、ユーザー設定ファイルで parallel = true を設定することで、この決定を上書きすることができる。

この関数には、この関数の戻り値を一時的に変更するために使用できる2つのコンテキスト・マネージャーが含まれている：

override

ignore_user_settings

パラメーター

num_processes (int | None) – 使用するプロセスの最大数 (None がデフォルト)。

戻りの型

bool

例

構成された設定を一時的に上書きし、並列処理を無効にする：

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

関数タスクへの値のマッピングの並列実行。 これは機能的に同等である：

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

これは、 values の数が1より大きければ結果を並列化し、 を返す。 should_run_in_parallel() は True を返す。 そうでない場合は、シリアルで実行される。

パラメーター

• task (func) – values の各値に対して呼び出される関数。
• values (array_like) – task 関数の評価対象となる値のリストまたは配列。
• task_args (list) – task 関数へのオプションの追加引数。
• task_kwargs (dict) – task 関数へのオプションの追加キーワード引数。
• num_processes (int) – スポーンするプロセス数。 もし与えられなければ default_num_processes() の戻り値が使われる。

戻り値

結果リストには、 values の各値に対する task(value, *task_args, **task_kwargs) の値が含まれる。

戻りの型

結果

例

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

Qiskit Aerは、 Qiskit内で構築された量子回路向けに高性能なシミュレータを提供します。

Qiskit IBMQ Provider は、 IBM クラウド上の IBM 量子ハードウェアにアクセスするために使用される。

Qiskit Ignis は、量子ハードウェア検証、ノイズ特性評価、エラー訂正のためのツールを提供する。

Qiskit TOQMは、 時間最適Qubitマッピングアルゴリズム用のトランスパイラパスを提供します。

python-constraintは制約充足問題ソルバーです。 CSPLayout トランスパイラパスで使用されます。

IBM のCPLEXオプティマイザーは、線形計画法、混合整数計画法、および二次計画法に対応した高性能な数理計画法ソルバーです。 これはQiskitではもはや使用されていませんが、かつては使用されていたため、下位互換性を保つためにオプションとして残されています。

CVXPY は凸最適化問題を解くための Python パッケージです。 これは、ダイヤモンドのノルムを計算するために必要です。 quantum_info.diamond_norm().

IBM Decision Optimization CPLEX Modellingは、 処方分析のためのライブラリです。 CPLEXと同様、これはQiskitではもはや使用されていませんが、かつては使用されていたため、下位互換性を保つためにオプションとして残されています。

テスト・スイートには、オプションのフィクスチャ・モジュールがインストールされている場合に利用できる追加機能があります。 これも一般的には HAS_TESTTOOLS も必要である。 これは一般的にQiskit開発者のみに必要です。

IPythonカーネルが利用可能な場合は、特定の追加的な視覚化と行の魔法が利用可能になります。

ipywidgetsが利用可能であれば、外部バックエンドで実行されているジョブの監視ウィジェットを提供できる。

opflow.gradients 、勾配を計算するいくつかの方法は、自己微分するために JAXを必要とする。

一部のテストでは、インタラクティブ機能をテストするために Jupyterの完全なインストールが必要です。

Qiskitはいくつかの可視化ツールを visualization モジュールを提供しています。 これらのほとんどは Matplotlib を使用して構築されている。

Qiskitではもう使われていない。 Python 内部的には、Qiskitは高性能な rustworkx ライブラリをコア依存として使用するようになりました。 NetworkX 形式に変換するのが便利なことがありました。 Qiskit Natureのようなアプリケーション・モジュールのテストでは、まだ NetworkX を使用している。

NLoptは非線形最適化ライブラリで、 algorithms.optimizers モジュールのグローバル・オプティマイザで使用されます。

PIL は Python 画像操作ライブラリである。 Qiskitは、特定の可視化を生成する際にPILのピローフォークが利用可能であれば、それを実際に使用します。 QuantumCircuit と DAGCircuit の両方を生成する場合などです。

一部のグラフ可視化では、Qiskitは pydotを GraphViz ( HAS_GRAPHVIZ).

Pygmentsは、SphinxやJupyterなど、コードブロックをリッチに表示する多くの環境で使われているコードハイライターとフォーマッターです。 Qiskitは、このような環境向けにリッチな出力を生成する際にこれを使用する。

様々な LaTeX-based の可視化、特に回路ドロワーが正しく動作するためには、 pylatexenc プロジェクトにアクセスする必要がある。

機能 qasm3.load() そして qasm3.loads()OpenQASM 3プログラムをインポートするための QuantumCircuit インスタンスは外部インポーター パッケージを使用します。

Qiskitはいくつかの可視化ツールを visualization モジュールを提供しています。 これらの一部は Seaborn を使用して構築されており、使用するには Seaborn をインストールする必要があります。

opflow.gradients の勾配関数のいくつかは、 Scikit Learn の正則化メソッドを使用しています。

最適化ツールの中には algorithms.optimizers これらは Scikit Quant にあるものに基づいており、使用するにはインストールする必要があります。

SQSnobFit は、「ブランチ・アンド・フィットによる安定したノイズのない最適化」アルゴリズムのためのライブラリです。 これは、 SNOBFIT オプティマイザーによって使用される。

Symengine は記号操作ライブラリ Sympy の高速な C++ バックエンドです。 この依存関係は、レガシーQPYフォーマットのロードに使用される。 Parameters.

SymPy は、記号数学のための Python ライブラリです。 SymPy かつてはクラスの ParameterExpression 実装に使用されていましたが、現在は使用されていません。 ただし、. ParameterExpression.sympify()を使用する一部のレガシー機能ではこれが必要となります。 また、一部の可視化関数やテンプレートマッチングでも使用されています。

Qiskitのテストスイートは、オプションの testtools ライブラリがインストールされていれば、より高度な機能を利用できます。 これは一般的にQiskit開発者のみに必要です。

Tweedledumは、古典的なオラクルを含む可能性のある回路の合成と最適化のための拡張ライブラリである。 過去にQiskit's PhaseOracle はこれを使用していたが、現在はQiskitでは使用していない。

Z3 は定理証明器で、 CrosstalkAdaptiveSchedule と HoareOptimizer トランスパイラパスで使用されます。

一部のグラフの可視化では、Qiskit はその インターフェースを介して可視化ツール GraphVizpydot ビジュアライゼーションツールを使用します。 HAS_PYDOT).

サーキットドロワーなど、出力に LaTeX を使用する可視化ツールは、 pdflatex が利用可能であることを必要とする。 通常、 LaTeX のインストールと、 qcircuit.tex パッケージが利用可能であることを確認する必要があります。

LaTeX-generated ファイルをラスタライズ画像に変換する視覚化ツールは、 pdftocairo ツールを使用します。 これは PDFツールのPopplerスイートの一部です。