このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

ProcessPool

ローカル マシン上のプロセス ワーカーの並列プール

説明

ローカル マシン上にプロセス ワーカーの並列プールを作成するには、parpool を使用します。プールを作成すると、parfor、parfeval などの並列プール機能がワーカーで実行されます。ProcessPool オブジェクトを使用して、並列プールを操作できます。

作成

ProcessPool オブジェクトにはいくつかの方法があります。

• 関数 parpool を使用して、ローカル マシン上にプロセス ワーカーの並列プールを作成します。

  pool = parpool("Processes")

• partition 関数を使用して、既存の並列プールからプールの分割を作成します。 (R2025a 以降)

プロパティ

AttachedFiles — ワーカーにコピーされるファイルおよびフォルダー

文字ベクトルの cell 配列

ワーカーにコピーされるファイルおよびフォルダー。文字ベクトルの cell 配列として指定します。ファイルおよびフォルダーをプールに付加するには、addAttachedFiles を使用します。

AutoAddClientPath — クライアントのパス上にユーザーが追加したエントリをワーカーのパスに追加するかどうかを示す指標

読み取り専用: true (既定値) | false

この プロパティ は読み取り専用です。

クライアントのパス上にユーザーが追加したエントリをワーカーのパスに追加するかどうかを示す指標。logical 値として指定します。

データ型: logical

Cluster — 並列プールが実行されているクラスター

読み取り専用: クラスター オブジェクト

この プロパティ は読み取り専用です。

並列プールが実行されているクラスター。parallel.Cluster オブジェクトとして指定します。

Connected — 並列プールが実行中かどうかを示すフラグ

読み取り専用: true | false

この プロパティ は読み取り専用です。

並列プールが実行中かどうかを示すフラグ。logical 値として指定します。

データ型: logical

EnvironmentVariables — ワーカーにコピーされる環境変数

読み取り専用: 文字ベクトルの cell 配列

この プロパティ は読み取り専用です。

ワーカーにコピーされる環境変数。文字ベクトルの cell 配列として指定します。

FevalQueue — 並列プールで実行する FevalFuture オブジェクトのキュー

読み取り専用: FevalQueue

この プロパティ は読み取り専用です。

並列プールで実行する FevalFutures のキュー。FevalQueue オブジェクトとして指定します。このプロパティを使用して、並列プールの保留中および実行中の future 変数を確認できます。future 変数を作成するには、parfeval および parfevalOnAll を使用します。future 変数の詳細については、Future を参照してください。

データ型: FevalQueue

FileStore — クライアントとワーカーの両方にアクセス可能なファイルのストア

FileStore

クライアントとワーカーの両方にアクセス可能なファイルのストア。FileStore オブジェクトとして指定します。

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

非負の整数

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

NumWorkers — 並列プールを構成するワーカーの数

読み取り専用: 整数

この プロパティ は読み取り専用です。

並列プールを構成するワーカーの数。整数として指定します。

Busy — 並列プールがビジー状態かどうかを示すフラグ

読み取り専用: true | false

この プロパティ は読み取り専用です。

並列プールがビジー状態かどうかを示すフラグ。true または false として指定します。完了すべき未処理の作業がある場合、そのプールはビジー状態になります。

SpmdEnabled — プールで spmd コードを実行できるかどうかを示す指標

読み取り専用: true (既定値) | false

この プロパティ は読み取り専用です。

プールで spmd コードを実行できるかどうかを示す指標。logical 値として指定します。

データ型: logical

ValueStore — クライアントとワーカーの両方にアクセス可能なデータのストア

ValueStore

クライアントとワーカーの両方にアクセス可能なデータのストア。ValueStore オブジェクトとして指定します。

Workers — 並列プールを構成するワーカーに関する情報

読み取り専用: parallel.Worker オブジェクトの配列

R2025a 以降

この プロパティ は読み取り専用です。

並列プールを構成するワーカーに関する情報。parallel.Worker オブジェクトの配列として返されます。

オブジェクト関数

addAttachedFiles	並列プールへのファイルやフォルダーの付加
Composite	クライアントから複数のワーカー上の非分散変数を作成およびアクセス
delete	並列プールのシャットダウン
listAutoAttachedFiles	ジョブ、タスクまたは並列プールに自動的に付加されるファイルのリスト
parfeval	並列プール ワーカーで関数を実行
parfevalOnAll	並列プールのすべてのワーカーで関数を非同期実行
partition	Partition parallel pool
parforOptions	parfor のオプション セット
ticBytes	並列プール内で転送されたバイト数のカウントを開始する
tocBytes	ticBytes の呼び出し後に転送されたバイト数を読み取る
updateAttachedFiles	並列プールでの付加ファイルまたはフォルダーの更新
spmd	並列プールのワーカーでコードを並列実行する

バージョン履歴

R2020a で導入

R2025a: ワーカーの情報をクエリするための新しいプロパティ

プール内のワーカーを識別するには、Workers プロパティを使用します。

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

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

参考

parpool

トピック

• 並列プールでのコードの実行
• スレッドベースの環境またはプロセスベースの環境の選択