Main Content

ClusterPool

マシンのクラスター上にあるワーカーの並列プール

R2020a 以降

説明

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

作成

関数 parpool を使用して、マシンのクラスター上に並列プールを作成します。

pool = parpool("myCluster")
ここで、myCluster はマシンのクラスターのクラスター プロファイル名です。

プロパティ

すべて展開する

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

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

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

データ型: logical

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

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

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

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

データ型: logical

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

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

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

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

データ型: FevalQueue

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

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

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

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

ClusterPool オブジェクトは、最大 2000 個のワーカーをもつプールをサポートします。 (R2024a 以降)

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

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

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

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

データ型: logical

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

オブジェクト関数

addAttachedFiles並列プールへのファイルやフォルダーの付加
delete並列プールのシャットダウン
listAutoAttachedFilesジョブ、タスクまたは並列プールに自動的に付加されるファイルのリスト
parfeval並列プール ワーカーで関数を実行
parfevalOnAll並列プールのすべてのワーカーで関数を非同期実行
ticBytes並列プール内で転送されたバイト数のカウントを開始する
tocBytesticBytes の呼び出し後に転送されたバイト数を読み取る
updateAttachedFiles並列プールでの付加ファイルまたはフォルダーの更新

バージョン履歴

R2020a で導入

すべて展開する