プロジェクトを操作するQ#

[アーティクル]
04/23/2024

Azure Quantum Development Kitのリリースでは、プロジェクトを定義Q#できます。プロジェクトは、互いのリソースにアクセスできる複数Q#のファイルを含むフォルダー構造です。プロジェクトは、再利用可能なライブラリを作成し、ソースコードを論理的に整理するのに役立ちます。

Q#プロジェクトには、qsharp.jsonという名前のマニフェストファイルと、指定したフォルダー構造内の 1 つ以上の *.qs ファイルが含まれていますQ#。ユーザーが VS Code で *.qs ファイルを開くか、Jupyter Notebookまたは Python ファイルでをproject_root設定すると、コンパイラはマニフェストファイルの周囲のフォルダー階層を検索し、プロジェクトのスコープを決定します。マニフェストファイルが見つからない場合、コンパイラは 1 つのファイルモードで動作します。プロジェクトは Q# 手動で作成することも、VS Code で直接作成することもできます。

前提条件

Azure サブスクリプションの Azure Quantum ワークスペース。ワークスペースを作成するには、Azure Quantum ワークスペースの作成に関する記事を参照してください。
Python と Pip がインストールされている Python 環境。
Azure Quantum Development Kit および Python 拡張機能がインストールされている Visual Studio Code。
Azure Quantum qsharp と azure-quantum パッケージ。

プロジェクトを定義するQ#

Q#プロジェクトは、qsharp.jsonマニフェストファイルと src フォルダー (ソースファイルを含むQ#) の存在によって定義されます。どちらもプロジェクトのルートフォルダーに存在する必要があります。プログラムの場合 Q# 、コンパイラは Q# プロジェクトフォルダーを自動的に検出します。 Python プログラムと Jupyter Notebook の場合は、呼び出しでプロジェクトフォルダーを Q# 指定する qsharp.init 必要があります。ただし、プロジェクトの Q# フォルダー構造は、すべての種類のプログラムで同じままです。

プロジェクトのフォルダー階層を Q# 示す図。

プログラムの Q# 使用
Python またはJupyter Notebookの使用

プロジェクトフォルダーの定義 (Q# プログラム)

VS Code で *.qs ファイルを開くと、 Q# コンパイラはフォルダー構造内で qsharp.jsonマニフェストファイル を上方向に検索します。マニフェストファイルが見つかると、コンパイラは src ディレクトリのすべてのサブフォルダーを検索して *.qs ファイルを検索し、すべての操作または関数をキャッシュし、マニフェストファイルの除外規則に従って、すべての *.qs ファイルでそれらの操作と関数を使用できるようにします。

たとえば、次のフォルダー構造を指定します。

Teleportation_project
- qsharp.json
- src
  - RunTeleport.qs
  - TeleportOperations
    - Teleport.qs
    - PrepareState
      - PrepareState.qs

ファイル /src/TeleportOperation/PrepareState/PrepareState.qs を開くと、コンパイラは次のようになりますQ#。

/src/TeleportOperation/PrepareState/ でqsharp.json ファイルを確認します。
/src/TeleportOperation でqsharp.jsonを確認します。
/src でqsharp.jsonを確認します。
qsharp.jsonを確認/します。
/プロジェクトのルートディレクトリとしてを確立し、マニフェストファイルの設定に従って、プロジェクトのルートの下にあるすべての *.qs ファイルを含めます。

プロジェクトフォルダーの定義 (Python およびJupyter Notebook プログラム)

Python プログラムまたは Jupyter Notebook セルを使用してリソースにアクセスQ#する場合は、ステートメントを使用してプロジェクトのルートディレクトリを直接設定するqsharp.init必要があります。前の例と同じフォルダー構造を使用する

Teleportation_project
- qsharp.json
- src
- MyPythonProgram.py
  - RunTeleport.qs
  - TeleportOperations
    - Teleport.qs
    - PrepareState
      - PrepareState.qs

を設定してから、任意Q#のproject_root操作を呼び出します。

Python プログラムがプロジェクトフォルダー内にある Q# と仮定する

import qsharp

qsharp.init(project_root = './Teleportation_project')

ルートフォルダーのパスは、それを設定しているファイルに対する相対パスです。つまり Q# 、プロジェクトフォルダーは任意の場所に配置でき、呼び出し元のプログラムが必ずしもプロジェクト内にある必要はありません。有効なパスには、または ../../Teleportation_projectを指定'./MyProjects/Teleportation_project'することもできます。

コンパイラは Q# 、指定したルートフォルダーに有効な qsharp.json ファイルがあることを確認し、マニフェストファイルの除外規則に従って 、src フォルダーの下にある *.qs リソースを参照可能にします。

マニフェストファイルの作成

マニフェストファイルは、必要に応じて author、license、.ints フィールドを含めることができる、qsharp.jsonという名前の単純な.json ファイルです。実行可能な最小マニフェストファイルは、文字列 {}です。 VS Code でプロジェクトを Q# 作成すると、最小限のマニフェストファイルが自動的に作成されます。

{}

マニフェストファイルの例

マニフェストファイルでプロジェクトのスコープを定義する方法の例を Q# 次に示します。

この例では、 author が指定された唯一のフィールドであるため、このディレクトリ内のすべての *.qs ファイルとそのすべてのサブディレクトリがプロジェクトに Q# 含まれます。

{
    "author":"Microsoft"
}

{
    "author":"Microsoft",
    "license":"MIT"
}

プロジェクト内では Q# 、マニフェストファイルを使用して VS Code Q# リンター設定を微調整することもできます。既定では、3 つのリンタールールは次のとおりです。

needlessParens: default = allow
divisionByZero: default = warn
redundantSemicolons: default = warn

マニフェストファイルを使用して、各ルールを、warn、または errorのいずれかにallow設定できます(例:

{
    "author":"Microsoft",
    "lints": [
        {
          "lint": "needlessParens",
          "level": "allow"
        },
        {
          "lint": "redundantSemicolons",
          "level": "warn"
        },
        {
          "lint": "divisionByZero",
          "level": "error"
        }
      ]
}

Q# プロジェクトの要件とプロパティ

次の要件と構成は、すべての Q# プロジェクトに適用されます。

プロジェクトに含める *.qs ファイルはすべて src という名前のフォルダーの下に存在する必要があります。このフォルダーは、プロジェクトのルートフォルダーの Q# 下にある必要があります。 VS Code でプロジェクトを Q# 作成すると、 /src フォルダーが自動的に作成されます。
qsharp.json マニフェストファイルは、src フォルダーと同じレベルにする必要があります。 VS Code でプロジェクトを Q# 作成すると、 qsharp.json ファイルが自動的に作成されます。
使用可能なソースファイル内の操作と関数には、ステートメントを使用して open アクセスできます。

open MyMathLib;
...
    Multiply(x,y);

または名前空間を使用して参照します。

MyMathLib.Multiply(x,y);

プログラムの場合 Q# のみ

定義できる *.qs ファイルは、 Q# プロジェクト内に @EntryPoint() 1 つだけです。
定義を含む @EntryPoint() *.qs ファイルは、マニフェストファイルの下の任意のレベルに配置できます。
プロジェクト内の任意の場所 Q# にある *.qs ファイルからキャッシュされた操作または関数は、VS Code の予測テキストに表示されます。
選択した操作または関数の名前空間がまだ追加されていない場合、VS Code は必要な open ステートメントを自動的に追加します。

プロジェクトを作成する Q# 手順

VS Code ファイルエクスプローラーで、プロジェクトのルートフォルダーに使用Q#するフォルダーを右クリックし、プロジェクトCreateQ#選択するか、フォルダーを開いて [コマンドパレット>Q#の表示] を選択します。>プロジェクトCreateQ#します。
VS Code は、 フォルダー内に最小限のqsharp.json マニフェストファイルを作成し、テンプレートファイルを /src 含むフォルダーを Main.qs 追加します。
必要に応じてマニフェストファイルを編集します。「マニフェストファイルの例」を参照してください。
フォルダーの下にソースファイルを Q# 追加して /src 整理します。
Python プログラムまたはJupyter NotebookからプロジェクトにQ#アクセスする場合は、を使用してルートフォルダーパスをqsharp.init設定します。この例では、プログラムがプロジェクトのルートフォルダーと同じフォルダー内にあると仮定します Q# 。
```
qsharp.init(project_root = './Teleportation_project')
```
VS Code でファイルのみを Q# 使用している場合、ファイルを Q# 開くと、コンパイラは qsharp.json マニフェストファイルを検索し、プロジェクトルートフォルダーを決定し、サブフォルダーで *.qs ファイルをスキャンします。

注意

手順 2 でマニフェストファイルとフォルダーを /src 手動で作成することもできます。

プロジェクトの例

この量子テレポートプログラムは、先ほど示したフォルダー構造に基づくプロジェクトの Q# 例であり、VS Code のローカルシミュレーターで実行されます。 Azure Quantum ハードウェアまたはサードパーティのシミュレーターでプログラムを実行するには、プログラムをコンパイルして Azure ワークスペースに接続する手順については、「プログラムの概要 Q# 」と「VSCode 」を参照してください。

この例では、次のディレクトリ構造を使用します。

Teleportation_project
- qsharp.json
- src
  - RunTeleport.qs
  - TeleportOperations
    - Teleport.qs
    - PrepareState
      - PrepareState.qs

qsharp.json マニフェストファイルには、作成者フィールドとライセンス フィールドが含まれています。

{
    "author":"Microsoft",
    "license":"MIT"
}

Q# ソースファイル

1 つの小さな違いがある場合、 @EntryPoint() ステートメント - ソースファイルは、プログラム、Python プログラム、またはJupyter Notebookで同じですQ#。

メインファイル RunTeleport.qs にはエントリポイントが含まれており、Teleport.qs の名前空間をTeleportLib参照します。

namespace RunTeleport {

    open TeleportLib;   // references the TeleportLib namespace in Teleport.qs

    @EntryPoint()       // @EntryPoint() not necessary for Python or Jupyter Notebook programs
    operation RunTeleportationExample() : Unit {
        use msg = Qubit();
        use target = Qubit();

        H(msg);
        Teleport(msg, target);    // calls the Teleport() operation from Teleport.qs
        H(target);

        if M(target) == Zero {
            Message("Teleported successfully!");
        
        Reset(msg);
        Reset(target);
        }
    }
}

Teleport.qs は、操作をTeleport()定義し、PrepareState.qs から操作をPrepareBellPair()呼び出します。

namespace TeleportLib {

    open PrepareBell;     // references the PrepareBell namespace in PrepareState.qs
 
    operation Teleport(msg : Qubit, target : Qubit) : Unit {
        use here = Qubit();

        PrepareBellPair(here, target);      // calls the PrepareBellPair() operation from PrepareState.qs
        Adjoint PrepareBellPair(msg, here);

        if M(msg) == One { Z(target); }
        if M(here) == One { X(target); }

        Reset(here);
    }
}

PrepareState.qs ファイルには、ベルペアを作成するための標準の再利用可能な操作が含まれています。

namespace PrepareBell {    
    
    operation PrepareBellPair(left : Qubit, right : Qubit) : Unit is Adj + Ctl {
        H(left);
        CNOT(left, right);
    }
}

プログラムの実行

プログラムを実行している環境のタブを選択します。

このプログラムを実行するには、VS Code で RunTeleport.qs ファイルを 開き、[実行] を選択 します。

Jupyter Notebook プログラムの場合、ソースファイルには属性は@EntryPoint()必要ありません。ファイルはソースライブラリとしてのみ機能します。

Juptyer Notebook でこのプログラムを実行するには、新しいノートブックを開き、次のセルを実行します。

import qsharp

# set the root folder for the Q# project
# make adjustments to the path depending on where your program is saved

# this example assumes your program is in the same folder as the root folder
qsharp.init(project_root = './Teleportation_project')

パスが有効な場合は、確認メッセージが表示されます。 Q# initialized with configuration: {'targetProfile': 'unrestricted'}

マジックコマンドを使用してメイン操作を呼び出してプログラムを%%qsharp実行する

%%qsharp
// call the main operation
RunTeleport.RunTeleportationExample();

またはステートメントを qsharp.eval() 使用して

print (qsharp.eval("RunTeleport.RunTeleportationExample()"));

Python プログラムの場合、ソースファイルには属性は @EntryPoint() 必要ありません。ファイルはソースライブラリとしてのみ機能します。

このプログラムを実行するには、次のコマンドを実行します。

import qsharp

# set the root folder for the Q# project
# make adjustments to the path depending on where your program is saved

# this example assumes your program is in the same folder as the root folder
qsharp.init(project_root = '/.Teleportation_project')

パスが有効な場合は、確認メッセージが表示されます。 Q# initialized with configuration: {'targetProfile': 'unrestricted'}

を使用してメイン操作を呼び出してプログラムを実行します。qsharp.eval()

print (qsharp.eval("RunTeleport.RunTeleportationExample()"));

プロジェクトを操作するQ#

前提条件

プロジェクトを定義するQ#

プロジェクトフォルダーの定義 (Q# プログラム)

プロジェクトフォルダーの定義 (Python およびJupyter Notebook プログラム)

マニフェストファイルの作成

マニフェストファイルの例

Q# プロジェクトの要件とプロパティ

プロジェクトを作成する Q# 手順

プロジェクトの例

Q# ソースファイル

プログラムの実行

フィードバック

フィードバック

その他のリソース

プロジェクトを操作するQ#

前提条件

プロジェクトを定義するQ#

プロジェクト フォルダーの定義 (Q# プログラム)

マニフェスト ファイルの作成

マニフェスト ファイルの例

Q# プロジェクトの要件とプロパティ

プロジェクトを作成する Q# 手順

プロジェクトの例

Q# ソース ファイル

プログラムの実行

フィードバック

フィードバック

その他のリソース

プロジェクトフォルダーの定義 (Q# プログラム)

マニフェストファイルの作成

マニフェストファイルの例

Q# ソースファイル