parpool

クラスターでの並列プールの作成

ページ内をすべて折りたたむ

構文

parpool

parpool(poolsize)

parpool(resources)

parpool(resources,poolsize)

parpool(___,Name=Value)

poolobj = parpool(___)

説明

parpool は、既定のプロファイルを使用してワーカーの並列プールを起動します。既定の設定を使用すると、MATLAB^® はローカルマシン上で 1 つの物理 CPU コアにつき 1 つのワーカーをもつプール (既定のプロファイルで設定された上限まで) を起動します。並列設定の詳細については、並列設定の指定を参照してください。

通常、プールのサイズは既定のプロファイルの PreferredPoolNumWorkers プロパティで指定されます。プールサイズに影響を及ぼす可能性のあるすべての要因については、プールサイズに影響する要因を参照してください。

parpool はワーカーのプールに特別なジョブを作成し、MATLAB クライアントを並列プールに接続することで、MATLAB の並列言語機能をすべて使用可能にします。並列言語機能には parfor、parfeval、parfevalOnAll、spmd および distributed が含まれます。可能な場合には、ワーカーの作業フォルダーは MATLAB クライアントセッションの作業フォルダーと一致するように設定されます。

例

parpool(poolsize) は、指定されたワーカー数のプールを作成して返します。poolsize には正の整数か、または整数の 2 要素ベクトルとして指定された範囲を使用できます。poolsize が範囲の場合、結果のプールのサイズは要求された範囲で最大になります。

poolsize を指定すると、PreferredPoolNumWorkers プロパティで指定された値がオーバーライドされます。また、ワーカーが使用可能になるまで待機しなければならない場合でも、正確にその数のワーカーからなるプールが起動されます。大部分のクラスターでは、開始できるワーカーの最大数が決まっています。プロファイルで MATLAB ジョブスケジューラクラスターが指定されている場合、parpool は使用するワーカーを、既に実行中のワーカーとその MATLAB ジョブスケジューラで使用可能なワーカーから確保します。プロファイルでローカルまたはサードパーティ製スケジューラが指定されている場合、parpool はプールのワーカーを起動するようそのスケジューラに指示します。

例

parpool(resources) または parpool(resources,poolsize) は、resources で指定されたリソース上にあるワーカープールを起動します。

例

parpool(___,Name=Value) は、プールを起動する際に特定のプロパティに対して指定した値を適用します。

例

poolobj = parpool(___) はクラスターのプールを示す parallel.Pool オブジェクトをクライアントワークスペースに返します。このプールオブジェクトを使用すると、プールをプログラムにより削除したり、プールのプロパティにアクセスすることができます。並列プールをシャットダウンするには、delete(pool) を使用します。

例

すべて折りたたむ

既定のプロファイルからのプールの作成

ワーカー数を定義する既定のプロファイルを使用して並列プールを起動します。既定の設定で、既定のプールの場所はローカルマシンです。

parpool

ローカルマシン上のプールの作成

ローカルマシン上のさまざまなタイプの並列環境で、プールを作成できます。

プロセスワーカーの並列プールを起動します。
```
parpool("Processes")
```

4 つのスレッドワーカーからなる並列プールを起動します。
```
parpool("Threads",4)
```

並列環境の詳細については、スレッドベースの環境またはプロセスベースの環境の選択を参照してください。

指定したプロファイルからのプールの作成

myProf というプロファイルを使用して、16 個のワーカーからなる並列プールを起動します。

parpool("myProf",16)

指定したクラスターでのプールの作成

既定のプロファイルで特定されたクラスターを表すオブジェクトを作成し、このクラスターオブジェクトを使用して並列プールを起動します。プールのサイズは既定のプロファイルによって決定されます。

c = parcluster
parpool(c)

プールの作成とファイルの付加

既定のプロファイルを用いて並列プールを起動し、2 つのコードファイルをワーカーに渡します。

parpool(AttachedFiles=["mod1.m","mod2.m"])

並列プールにおける複数の GPU の使用

ライブスクリプトを開く

複数の GPU にアクセスできる場合、並列プールを使用して複数の GPU で並列計算を実行することができます。

MATLAB で使用可能な GPU の数を特定するには、関数gpuDeviceCountを使用します。

availableGPUs = gpuDeviceCount("available")

availableGPUs = 3

使用可能な GPU と同数のワーカーをもつ並列プールを起動します。最良のパフォーマンスを得るために、MATLAB は既定でワーカーごとに別々の GPU を割り当てます。

parpool("Processes",availableGPUs);

Starting parallel pool (parpool) using the 'Processes' profile ...
Connected to the parallel pool (number of workers: 3).

各ワーカーが使用している GPU を識別するために、spmd ブロック内で gpuDevice を呼び出します。spmd ブロックは各ワーカーで gpuDevice を実行します。

spmd
    gpuDevice
end

parforやparfevalなどの並列言語機能を使用して、並列プールのワーカーに計算を分散します。計算にgpuArray対応関数を使用すると、これらの関数はワーカーの GPU で実行されます。詳細については、GPU での MATLAB 関数の実行を参照してください。例は、複数の GPU での MATLAB 関数の実行を参照してください。

計算が完了したら、並列プールをシャットダウンします。関数gcpを使用して、現在の並列プールを取得できます。

delete(gcp("nocreate"));

他の GPU を選択して使用する場合は、gpuDevice で GPU デバイスインデックスを使用して、各ワーカーで特定の GPU を選択できます。関数 gpuDeviceCount を使用すると、システム内の各 GPU デバイスのインデックスを取得できます。

システム内に使用可能な GPU が 3 つあり、その中の 2 つだけを計算に使用するとします。デバイスのインデックスを取得します。

[availableGPUs,gpuIndx] = gpuDeviceCount("available")

availableGPUs = 3

gpuIndx = 1×3

     1     2     3

使用するデバイスのインデックスを定義します。

useGPUs = [1 3];

並列プールを起動します。spmd ブロックと gpuDevice を使用して、各ワーカーと使用する GPU のいずれかをデバイスインデックスにより関連付けます。関数 spmdIndex は各ワーカーのインデックスを識別します。

parpool("Processes",numel(useGPUs));

Starting parallel pool (parpool) using the 'Processes' profile ...
Connected to the parallel pool (number of workers: 2).

spmd
    gpuDevice(useGPUs(spmdIndex));
end

ベストプラクティスとして、また最良のパフォーマンスを得るには、各ワーカーに異なる GPU を割り当てます。

計算が完了したら、並列プールをシャットダウンします。

delete(gcp("nocreate"));

プールオブジェクトを返しプールを削除

既定のプロファイルを用いて並列プールを作成し、その後でプールを削除します。

poolobj = parpool;

delete(poolobj)

現在のプールのサイズを判定

現在の並列プールにあるワーカーの数を検出します。

poolobj = gcp("nocreate"); % If no pool, do not create new one.
if isempty(poolobj)
    poolsize = 0;
else
    poolsize = poolobj.NumWorkers
end

入力引数

すべて折りたたむ

`poolsize` — 並列プールのサイズ
正の整数 | 整数の 2 要素ベクトル

並列プールのサイズ。正の整数、または整数の 2 要素ベクトルで指定された範囲として指定します。poolsize が範囲の場合、結果のプールのサイズは要求された範囲で最大になります。クラスタープロファイルで既定の推奨されるワーカー数を設定します。

parpool は、最大 2000 個のワーカーをもつプールをサポートします。 (R2024a 以降)

例: parpool("Processes",2)

`resources` — 起動するプールがあるリソース
`"Processes"` (既定値) | `"Threads"` | プロファイル名 | クラスターオブジェクト

起動するプールがあるリソース。"Processes"、"Threads"、クラスタープロファイル名またはクラスターオブジェクトとして指定します。

"Processes" – ローカルマシン上でプロセスワーカーのプールを起動します。プロセスベースの環境の詳細については、スレッドベースの環境またはプロセスベースの環境の選択を参照してください。
"Threads" – ローカルマシン上でスレッドワーカーのプールを起動します。スレッドベースの環境の詳細については、スレッドベースの環境またはプロセスベースの環境の選択を参照してください。
プロファイル名 – プロファイルで指定されたクラスター上でプールを起動します。クラスタープロファイルの詳細については、クラスターの検出とクラスタープロファイルの使用を参照してください。
クラスターオブジェクト – クラスターオブジェクトで指定されたクラスター上でプールを起動します。クラスターオブジェクトを取得するには、parcluster を使用します。

例: parpool("Processes")

例: parpool("Threads")

例: parpool("myClusterProfile",16)

例: c = parcluster; parpool(c)

データ型: char | string | parallel.Cluster

名前と値の引数

すべて折りたたむ

オプションの引数のペアを Name1=Value1,...,NameN=ValueN として指定します。ここで、Name は引数名で、Value は対応する値です。名前と値の引数は他の引数の後に指定しなければなりませんが、ペアの順序は重要ではありません。

R2021a 以前は、名前と値をそれぞれコンマを使って区切り、Name を引用符で囲みました。

例: AttachedFiles="myFun.m"

`AdditionalPaths` — ワーカーに追加するパス
文字ベクトル | string スカラー | string 配列 | 文字ベクトルの cell 配列

R2025a 以降

プール作成時にワーカーの MATLAB 検索パスに追加するパス。文字ベクトル、string、string 配列、または文字ベクトルの cell 配列として指定します。

既定の検索パスは、ワーカー上とクライアント上で異なる場合があります。パスが異なる原因は、現在の作業フォルダー (cwd)、プラットフォームまたはネットワークファイルシステムへのアクセスが異なるためである可能性があります。名前と値の引数 AdditionalPaths を指定すると、ワーカーがコードファイル、データファイル、モデルファイルなどのファイルを正しい場所で検索するようになります。

AdditionalPaths を使用すると、共有ファイルシステムのファイルにアクセスできます。パスの表現は、ターゲットマシンによって異なります。AdditionalPaths は、クラスター内のマシンから見たパスでなければなりません。たとえば、ローカルの Windows^® マシンの Z:\data が、Linux^® クラスターでは /network/data と認識されている場合、AdditionalPaths には後者を追加します。データストアを使用している場合は、代わりに 'AlternateFileSystemRoots' を使用して、他の表現を処理します。詳細については、異なるマシンまたはクラスターで処理するためのデータストアの設定を参照してください。

AdditionalPaths は、相対パスまたはファイル名を使用してファイルを参照するためにファイルを検索する場合に使用します。絶対パスを使用する場合は使用しません。

例: "/network/data/"

データ型: char | string | cell

`AttachedFiles` — プールに付加するファイル
文字ベクトル | string スカラー | string 配列 | 文字ベクトルの cell 配列

プールに付加するファイル。文字ベクトル、string、string 配列、または文字ベクトルの cell 配列として指定します。

parpool は並列プールを起動し、指定されたファイルをプールのワーカーに渡します。ここで指定したファイルは、所定の並列プロファイルで指定された AttachedFiles プロパティに追加され、付加ファイルの完全なリストが生成されます。AttachedFiles のプロパティ名は大文字小文字を区別するため、表示どおりに指定しなければなりません。

例: ["myFun.m","myFun2.m"]

データ型: char | cell

`AutoAddClientPath` — クライアントのパスをワーカーのパスに追加するかどうかを指定するフラグ
`true` (既定値) | `false`

クライアントパスにユーザーが追加したエントリを、起動時に各ワーカーのパスに追加するかどうかを指定するフラグ。logical 値として指定します。

データ型: logical

`EnvironmentVariables` — ワーカーにコピーされる環境変数
文字ベクトル | string スカラー | string 配列 | 文字ベクトルの cell 配列

クライアントセッションからワーカーにコピーされる環境変数名。文字ベクトル、string、string 配列、または文字ベクトルの cell 配列として指定します。ここで指定した名前は、該当する並列プロファイルで指定された EnvironmentVariables プロパティに追加され、環境変数の完全なリストが生成されます。リストされているが設定されていない変数はすべて、ワーカーにコピーされません。これらの環境変数は、並列プールの存在期間にわたってワーカーで設定されています。

データ型: char | cell

`SpmdEnabled` — `spmd` がプールでサポートされるかどうかを指定するフラグ
`true` (既定値) | `false`

プールで spmd のサポートを有効にするかどうかを指定するフラグ。logical 値として指定します。サポートは、ローカルクラスターまたは MATLAB ジョブスケジューラクラスター上でのみ無効にできます。parfor の反復にワーカー間の通信は関与しません。したがって、SpmdEnabled が false の場合、1 つ以上のワーカーが parfor ループの実行中に中止となってもループは続行します。

データ型: logical

`IdleTimeout` — プールがアイドルの場合にシャットダウンするまでの時間
非負の整数

プールがアイドルの場合にシャットダウンするまでの時間 (分単位)。ゼロより大きい整数として指定します。プールのワーカー上でコードが実行されていない場合、プールはアイドルです。IdleTimeout プロパティの値は、既定で並列設定の値と同じになります。並列設定の詳細については、並列設定の指定を参照してください。

例: pool = parpool(IdleTimeout=120)

出力引数

すべて折りたたむ

`poolobj` — クライアントから並列プールへのアクセス
`parallel.Pool` オブジェクト

parallel.Pool オブジェクトとして返される、クライアントから並列プールへのアクセス。

ヒント

デスクトップの左下隅にあるプールステータスインジケーターは、プールへのクライアントセッション接続とプールのステータスを表します。アイコンをクリックすると、サポートされているプール操作のメニューが表示されます。
プールが実行中の場合: プールが実行中でない場合:
並列設定で、必要に応じて並列プールを自動作成するよう設定されている場合、parpool コマンドを明示的に呼び出す必要はありません。プールセットアップ時のオーバーヘッド時間が発生するタイミングを制御する場合は、プールを明示的に作成し、そのプールを以降の並列言語構成で使用できます。
delete(poolobj) は並列プールをシャットダウンします。並列プールがない場合、spmd と parfor はクライアント内でシングルスレッドとして実行されます。ただし、並列設定で並列プールが自動起動するよう設定されている場合を除きます。
MATLAB エディターを使用して、並列プールに付加されているファイルをクライアント上で更新すると、更新内容は自動的にプール内のワーカーに伝播されます(この自動更新は Simulink^® モデルファイルには適用されません。更新されたモデルファイルをワーカーに伝播するには、関数 updateAttachedFiles を使用します)。
可能な場合、ワーカーの作業フォルダーは MATLAB クライアントセッションの作業フォルダーと一致するように MATLAB で最初に設定されます。以降にクライアントで以下のコマンドを実行すると、そのコマンドも MATLAB によってプールのすべてのワーカーで実行されます。
これによって、全ワーカー上で作業フォルダーとコマンド検索パスを設定でき、これ以降、parfor ループなどのプールのアクティビティが適切なコンテキストで実行されるようになります。
Windows オペレーティングシステムを使用するクライアントで cd でフォルダーを変更したり、addpath でパスを追加したりする際にワーカーに送信される値は可能な限りフォルダーの UNC パスです。これは、Linux オペレーティングシステムを使用するクライアントではフォルダーの絶対位置になります。
これらのコマンドがクライアントで機能しない場合、ワーカー上で実行されることはありません。たとえば、addpath でクライアントがアクセスできないフォルダーを指定した場合、この addpath コマンドはワーカーで実行されません。ただし、作業フォルダーがクライアント上では設定できても、いずれかのワーカーで指定どおりには設定できないという場合は、クライアントのコマンドウィンドウにエラーメッセージは表示されません。
クライアントとワーカーのプラットフォームが同じではない、クライアントのローカルフォルダーまたはクライアントからマッピングされたフォルダーがワーカーからは同じ方法で使用できない、あるいはフォルダーが非共有ファイルシステムにあるといった混合プラットフォーム環境では、このわずかな動作の違いに注意してください。たとえば、MATLAB クライアントを Microsoft^® Windows オペレーティングシステムで実行している一方で、MATLAB ワーカーはすべて Linux オペレーティングシステムで実行している場合、addpath の同じ引数は両方のオペレーティングシステムでは機能しません。このような場合には、関数 pctRunOnAll を使用してコマンドがすべてのワーカーで実行されるようにできます。
クライアントとワーカーのもう 1 つの違いは、matlabroot フォルダーの下位フォルダーを表す addpath 引数がワーカーには設定されないということです。MATLAB インストールベースは既にワーカーのパスに含まれているということが、ここでは仮定されています。プール内のワーカーに関する addpath のルールは以下のとおりです。
- matlabroot フォルダーのサブフォルダーはワーカーに送信されない。
- matlabroot フォルダーの最初の出現箇所より前に現れるすべてのフォルダーは、ワーカーのパスの先頭に追加される。
- matlabroot フォルダーの最初の出現箇所より後に現れるすべてのフォルダーは、ワーカーのパス上で matlabroot グループのフォルダーの後に追加される。
たとえば、クライアントの matlabroot が C:\Applications\matlab\ であるとします。開いている並列プールに対して以下を実行し、クライアントとすべてのワーカーにパスを設定します。
```
addpath("P1",
        "P2",
        "C:\Applications\matlab\T3",
        "C:\Applications\matlab\T4",
        "P5",
        "C:\Applications\matlab\T6",
        "P7",
        "P8");
```
T3、T4 および T6 は matlabroot のサブフォルダーであるためワーカーのパスには設定されません。したがって、ワーカーに対し、このコマンドによって設定されるパスの該当部分は以下のとおりです。
```
P1
P2
<worker original matlabroot folders...>
P5
P7
P8
```
Macintosh または Linux を使用していて、大規模な並列プールの作成時に問題が発生した場合は、Macintosh と Linux で推奨されるシステムの制限を参照してください。

バージョン履歴

R2013b で導入

すべて展開する

R2025a: ワーカーの検索パスへのフォルダーの追加

並列プールのワーカーがファイルを正しい場所で検索するようにするには、名前と値の引数 AdditionalPaths を使用してワーカーの MATLAB 検索パスにフォルダーを追加します。

R2024a: 最大 2000 個のワーカーをもつプールのサポート

R2024a 以降では、parpool は最大 2000 個のワーカーをもつプールをサポートします。R2024a より前では、parpool は最大 1000 個のワーカーをもつプールをサポートします。

R2022b: `local` プロファイルは非推奨

R2022b 以降、local プロファイルの名前が Processes に変更されました。local を削除する予定はありません。ローカルマシン上のプロセスワーカーの並列プールを起動するには、代わりに Processes を使用してください。

R2022b: スレッドワーカー数の指定

R2022b 以降、parpool(poolsize) 構文を使用してスレッドベースの並列プールのプールサイズを指定できるようになりました。

参考

parpool

構文

説明

例

既定のプロファイルからのプールの作成

ローカル マシン上のプールの作成

指定したプロファイルからのプールの作成

指定したクラスターでのプールの作成

プールの作成とファイルの付加

並列プールにおける複数の GPU の使用

プール オブジェクトを返しプールを削除

現在のプールのサイズを判定

入力引数

poolsize — 並列プールのサイズ 正の整数 | 整数の 2 要素ベクトル

resources — 起動するプールがあるリソース "Processes" (既定値) | "Threads" | プロファイル名 | クラスター オブジェクト

名前と値の引数

AdditionalPaths — ワーカーに追加するパス 文字ベクトル | string スカラー | string 配列 | 文字ベクトルの cell 配列

AttachedFiles — プールに付加するファイル 文字ベクトル | string スカラー | string 配列 | 文字ベクトルの cell 配列

AutoAddClientPath — クライアントのパスをワーカーのパスに追加するかどうかを指定するフラグ true (既定値) | false

EnvironmentVariables — ワーカーにコピーされる環境変数 文字ベクトル | string スカラー | string 配列 | 文字ベクトルの cell 配列

SpmdEnabled — spmd がプールでサポートされるかどうかを指定するフラグ true (既定値) | false

IdleTimeout — プールがアイドルの場合にシャットダウンするまでの時間 非負の整数

出力引数

poolobj — クライアントから並列プールへのアクセス parallel.Pool オブジェクト

ヒント

バージョン履歴

R2025a: ワーカーの検索パスへのフォルダーの追加

R2024a: 最大 2000 個のワーカーをもつプールのサポート

R2022b: local プロファイルは非推奨

R2022b: スレッド ワーカー数の指定

参考

トピック

ローカルマシン上のプールの作成

プールオブジェクトを返しプールを削除

`poolsize` — 並列プールのサイズ
正の整数 | 整数の 2 要素ベクトル

`resources` — 起動するプールがあるリソース
`"Processes"` (既定値) | `"Threads"` | プロファイル名 | クラスターオブジェクト

`AdditionalPaths` — ワーカーに追加するパス
文字ベクトル | string スカラー | string 配列 | 文字ベクトルの cell 配列

`AttachedFiles` — プールに付加するファイル
文字ベクトル | string スカラー | string 配列 | 文字ベクトルの cell 配列

`AutoAddClientPath` — クライアントのパスをワーカーのパスに追加するかどうかを指定するフラグ
`true` (既定値) | `false`

`EnvironmentVariables` — ワーカーにコピーされる環境変数
文字ベクトル | string スカラー | string 配列 | 文字ベクトルの cell 配列

`SpmdEnabled` — `spmd` がプールでサポートされるかどうかを指定するフラグ
`true` (既定値) | `false`

`IdleTimeout` — プールがアイドルの場合にシャットダウンするまでの時間
非負の整数

`poolobj` — クライアントから並列プールへのアクセス
`parallel.Pool` オブジェクト

R2022b: `local` プロファイルは非推奨

R2022b: スレッドワーカー数の指定