リファレンス: Visual Studio Code 用 Azure Quantum Development Kit 拡張機能
Azure Quantum Development Kit (QDK) では、Visual Studio (VS) コードのすべての標準機能と、.qs ファイルを操作する際の Q#固有の機能が使用されます。 この記事は、必要に応じて追加のコンテンツへのリンクを含む、すべての Q# 関連のコマンドと機能のリファレンス ガイドです。 一般的な VS Code ガイダンスについては、VS Code のドキュメントを 参照してください。
ヒント
Q# 関連のほとんどのコマンドには、[コマンド パレットの表示>] メニューからアクセスできます。 .qs ファイルで Ctrl + Shift + P (macOS の場合は Cmd - Shift + P) を選択し、「Q#」と入力して、フィルター処理されたコマンドの一覧を表示します。
すべての macOS キーボード ショートカットについては、「macOS のキーボード ショートカット」を参照してください。
コマンド
Q# 関連のほとんどのコマンドには、[コマンド パレットの表示>] メニューからアクセスできます。 Ctrl キーを押しながら Shift キーを押しながら P キーを押し、「Q#」と入力して、フィルター処理されたコマンドの一覧を表示します。 一部のコマンドは、.qs ファイルがアクティブな場合にのみ使用できます。
ヒント
キーボード ショートカットまたは Ctrl + K + S キーを使用して、VS Code コマンドのカスタム キーボード ショートカットを作成できます。 詳細については、「VS Code のキー バインド」を参照してください。
| command | アクション | メモ | 代替ユーザー アクション |
|---|---|---|---|
| Q#: Q# プロジェクトを作成する | 次のような Q# プロジェクトをアクティブ フォルダーに作成します。 * qsharp.json マニフェスト ファイル * 既定の main.qs ファイルを含む src サブフォルダー。 |
Q# プロジェクトの詳細については、「Q# プロジェクトの操作」を参照してください。 | エクスプローラーで、ターゲット フォルダーを右クリックし、[Q# プロジェクトの作成] を選択します。 |
| Q#: Azure Quantum ノートブックを作成する | Q# + Python プログラムを実行し、Azure Quantum にジョブを送信するサンプル Jupyter Notebook を開きます。 | Azure Quantum ノートブックの詳細については、「Azure Quantum ノートブックの操作」を参照してください。 | 該当なし |
| Q#: Azure Quantum ワークスペースに接続する | Azure アカウントまたは接続文字列を使用して Azure Quantum ワークスペースに接続します。 認証されると、ワークスペースが Quantum ワークスペースのエクスプローラーに表示されます。 | Azure Quantum 接続の詳細については、「Azure Quantum ワークスペースへの接続」を参照してください。 | エクスプローラーで、Quantum ワークスペースにカーソルを合わせ、"+" アイコンを選択します。 |
| Q#: Q# プレイグラウンドを開く | エクスプローラーで Q# サンプル プログラムのオンライン フォルダーを開きます。 ローカル量子シミュレーターでプログラムを編集して実行したり、ブレークポイントを設定したり、組み込みのデバッガーを使用してコードをステップ実行したりできます。 | 詳細については、サンプル フォルダーの README ファイルを参照してください。 | 該当なし |
| Q#: Azure Quantum ワークスペースを更新する | 接続された量子ワークスペースからの最新の変更を同期します。 | 接続の問題がある場合は、ワークスペース名の横にアラート アイコンが表示されます。 | エクスプローラーで、Quantum ワークスペースにカーソルを合わせ、更新アイコンを選択します。 |
| エクスプローラー: Quantum ワークスペース ビューにフォーカスする | エクスプローラーを開き、構成されている場合は、接続されている量子ワークスペースに焦点を当てます。 ワークスペースが構成されていない場合は、既存のワークスペースを追加するように求められます。 | Azure Quantum 接続の詳細については、「Azure Quantum ワークスペースへの接続」を参照してください。 | 該当なし |
.qs ファイルがアクティブな場合は、次のコマンドを使用できます。
| command | アクション | メモ | 代替ユーザー アクション |
|---|---|---|---|
| Q#: Azure Quantum QIR ターゲット プロファイルを設定する | Q# プログラムの QIR (量子中間表現) ターゲット プロファイルを設定します。 | ターゲット プロファイルの詳細については、「ターゲット プロファイル」を参照してください。 | 現在のターゲット プロファイルが下部のツール バーに表示されます。 ツール バーのターゲット プロファイルを選択して、選択ドロップダウンを開きます。 |
| Q#: 回線を表示する | Q# プログラムを実行する前に、そのプログラムの回路図を表示します。 | 詳細については、「量子回路図の視覚化」を参照してください。 | プログラム内のエントリ・ポイント操作の横または各ユーザー定義操作の上にあるメニューから、コード・レンズ・オプション 回線 を選択します。 |
| Q#: ファイルを実行してヒストグラムを表示する | 現在の Q# プログラムを実行し、結果のヒストグラムを右側のウィンドウに表示します。 | ヒストグラム表示の並べ替えオプションとフィルター オプションにアクセスするには、ヒストグラム ペインでフィルター アイコンを選択します。 | エントリ ポイント操作の横にあるメニューからコード レンズ オプション ヒストグラム を選択します。 |
| Q#: 現在の Q# プログラムの QIR を取得する | 新しい編集ウィンドウで、現在の Q# コードの QIR ソースを開きます。 QIR ソースをエクスポートするには、プログラムで Base または Adaptive RI ターゲット プロファイルを使用する必要があります。 | QIR の詳細については、量子中間表現と Q# 開発者ブログを参照してください。 | 該当なし |
| デバッグ: Q# ファイルをデバッグする | デバッガーで現在の Q# プログラムを開きます。 | 詳細については、「量子コードのデバッグとテスト」を参照してください。 | * F5 キーを押す *エントリポイント操作の横にあるメニューからコードレンズオプション デバッグ を選択します。 * 右上の [実行] アイコンを選択し、[Q# ファイルのデバッグ] を選択します。 |
| デバッグ: Q# ファイルを実行する | 既定の量子シミュレーターで現在の Q# プログラムを実行します。 | 詳細については、「Q# プログラムの概要」を参照してください。 | * Ctrl + F5 キーを押 す *入力ポイント操作の横にあるメニューからコードレンズオプション [実行 ]を選択します。 * 右上の [実行] アイコンを選択し、[Q# ファイルの実行] を選択します。 |
| Q#: リソース見積もりの計算 | Resource Estimator の組み込みバージョンを呼び出します。 | 詳細については、「Azure Quantum Resource Estimator の概要」を参照してください。 | 該当なし |
| Q#: ヘルプ | VS Code の QDK 拡張機能の簡単な概要。 | Azure Quantum の完全なドキュメントについては、Azure Quantum のドキュメントを参照してください。 | 該当なし |
| Q#: ファイルを実行して回路図を表示する | 現在の Q# プログラムを実行し、出力を含むプログラムの回路を表示します。 | 詳細については、「量子回路図の視覚化」を参照してください。 | 該当なし |
| Q#: API ドキュメントを表示する | 新しいウィンドウで API ドキュメントを開きます。 Ctrl キーを押しながら F キーを押して、このウィンドウを 検索します。 | 詳細については、Azure Quantum API リファレンスを 参照してください。 | 該当なし |
ターミナル
Q# プログラムでは、VS Code で次の 2 つのターミナル ウィンドウを使用します。
| ターミナル | アクション |
|---|---|
| デバッグ コンソール | 実行出力またはデバッグ出力を表示します |
| 問題 | コンパイル前のエラー チェックを表示します |
Q# コードの編集
VS Code の一般的なコード編集機能のほとんどは、Q# プログラムを使用するときに使用できます。 詳細については、VS Code ドキュメントの Intellisense を参照してください。
- エラー チェックをプリコンパイルする
- Go-to の定義
- 関連情報
- 関数シグネチャ
- パラメータ情報
- 入力候補
- Linting - Q# ファイルでは、マニフェスト ファイルでプロジェクトごとの linting を構成します。 詳細については、「Q# プロジェクトの操作」を参照してください。
一般的なタスク
Q# ファイルとプロジェクトの操作
| タスク | アクション | メモ |
|---|---|---|
| 新しい Q# ファイル | [ファイル>の新しいファイル>] テキスト ファイルを選択します。 拡張子が .qs のファイルを保存します。 | 設定した場合、新しいファイルは既定で Q# 形式に自動的に設定 Files: Default Language = qsharpされます。 |
| Q# プロジェクトを作成する | エクスプローラーで開いているフォルダーから、コマンド パレットから [Q# プロジェクトの作成] を選択するか、エクスプローラーのフォルダーを右クリックして [Q# プロジェクトの作成] を選択します。 | Q# プロジェクトの詳細については、「Q# プロジェクトの操作」を参照してください。 |
| サンプル ファイル | 空の .qs ファイルにサンプルを入力し、一覧からサンプル プログラムを選択します。 | コマンド パレットで [Q# プレイグラウンドを開く] を選択して、エクスプローラーで Q# サンプル プログラムのオンライン フォルダーを開くこともできます。 |
Azure Quantum への接続
| タスク | アクション | メモ | 代替ユーザー アクション |
|---|---|---|---|
| Azure Quantum ワークスペースに接続する | エクスプローラーで、[Quantum ワークスペース] を展開し、[既存のワークスペースの追加] を選択します。 プロンプトに従って、サブスクリプションとワークスペースを選択します。 | * 複数のワークスペースに接続できます。 Quantum ワークスペースの横にある [+] を選択して、別のワークスペースを接続します。 ワークスペース接続は VS Code セッション間で保持されます。 * ワークスペース接続を削除するには、ワークスペースを右クリックし、[ワークスペース接続の削除] を選択します。 |
コマンド パレットで、[Azure Quantum ワークスペースに接続] を選択 します。 |
| Python プログラムを使用してプログラムで接続する | 既存のワークスペース接続を右クリックし、[Python コードのコピー] を選択 してワークスペースに接続します。 結果のコードを Python プログラムに貼り付けます。 | 詳細については、「Q# ジョブを使用した Python の Azure Quantum への送信」を参照してください。 | 該当なし |
プログラムの実行
| タスク | アクション | メモ | 代替ユーザー アクション |
|---|---|---|---|
| ローカル量子シミュレーターで Q# プログラムを実行する | Q# プログラムで、右上にある [実行] アイコンを選択し、[Q# ファイルの実行] を選択します。 | 量子シミュレーターの詳細については、スパース量子シミュレーターを参照してください。 | * Ctrl キーを押しながら F5 キーを押 す * コマンド パレットから Q#: [ファイルの実行] を選択 し、ヒストグラム または Q# を表示します。ファイルを実行し、回路図を表示します *入力ポイント操作の横にあるメニューからコードレンズオプション [実行 ]を選択します。 |
| プログラムをデバッグする | Q# プログラムで、右上にある [実行] アイコンを選択し、[Q# ファイルのデバッグ] を選択します。 | VS Code の Q# デバッガーの詳細については、「量子コードのデバッグとテスト」を参照してください。 | * F5 キーを押す *エントリポイント操作の横にあるメニューからコードレンズオプション デバッグ を選択します。 |
| ワークスペース内のプロバイダーとターゲットを表示する | エクスプローラーで、Quantum ワークスペースを選択し、ワークスペースを展開してから [プロバイダー] を展開して、ワークスペースで使用可能なプロバイダーを表示します。 個々のプロバイダーを展開して、使用可能なターゲットを表示します。 | 注: ジョブを送信する前に、ターゲット名にカーソルを合わせると、その状態とキューの時刻が表示されます。 | 該当なし |
| Azure Quantum にジョブを送信する | Q# プログラムで、ワークスペース、プロバイダー、およびターゲットを選択します。 現在の Q# プログラムを送信するには、ターゲットの横にある矢印を選択します。 | 詳細については、「Azure Quantum への Q# ジョブの送信」を参照してください。 | 該当なし |
| ジョブの結果を表示する | ワークスペースを展開し、[ジョブ] を展開 します。 Azure Storage からのジョブ出力を開くには、ジョブ名の横にあるクラウド アイコンを選択します。 | 最新のジョブが一覧表示されます。 | 該当なし |