parallel.Job
ジョブのプロパティおよび動作にアクセスする
コンテナー階層
親 | parallel.Cluster |
子 | parallel.Task |
説明
parallel.Job
オブジェクトは、ユーザーが作成、定義、実行用に投入したジョブへのアクセスを提供します。
タイプ
以下の表では、使用可能なジョブ オブジェクトのタイプについて説明します。ジョブ タイプはクラスターのタイプと、タスクが実行中に相互の通信を必要とするかどうかによって決まります。
ジョブ タイプ | 説明 |
---|---|
parallel.job.MJSIndependentJob | MATLAB® ジョブ スケジューラ クラスター上の独立タスクからなるジョブ |
parallel.job.MJSCommunicatingJob | MATLAB ジョブ スケジューラ クラスター上の通信タスクからなるジョブ |
parallel.job.CJSIndependentJob | CJS クラスター上の独立タスクからなるジョブ |
parallel.job.CJSCommunicatingJob | CJS クラスター上の通信タスクからなるジョブ |
メソッド
全ジョブ タイプ共通
以下のメソッドはすべてのジョブ オブジェクト タイプに共通です。
cancel | ジョブまたはタスクをキャンセルする |
createTask | ジョブに新しいタスクを作成する |
delete | クラスターおよびメモリからジョブまたはタスク オブジェクトを削除する |
diary | バッチ ジョブのコマンド ウィンドウ テキストを表示または保存する |
fetchOutputs | ジョブ内の全タスクから出力引数を取得する |
findTask | ジョブ オブジェクトに属するタスク オブジェクト |
listAutoAttachedFiles | ジョブ、タスクまたは並列プールに自動的に付加されるファイルのリスト |
load | バッチ ジョブからワークスペース変数を読み込む |
recreate | 既存のジョブから新規ジョブを作成する |
submit | ジョブをスケジューラでキューに入れる |
wait | ジョブの状態が変わるまで待機 |
プロパティ
全ジョブ タイプ共通
以下のプロパティはすべてのジョブ オブジェクト タイプに共通です。
プロパティ | 説明 |
---|---|
AdditionalPaths | ワーカーの MATLAB 検索パスに追加するフォルダー (文字ベクトル、string、string 配列、または文字ベクトルの cell 配列として指定) |
AttachedFiles | ワーカーに送信されるファイルおよびフォルダー (文字ベクトル、string、string 配列、または文字ベクトルの cell 配列として指定) |
AutoAddClientPath | クライアントのパスにユーザーが追加したエントリを各ワーカーのパスに自動的に追加するかどうかを指定 |
AutoAttachFiles | 依存コード ファイルを自動的にワーカーに送信するかどうかを指定 |
CreateDateTime | ジョブの作成日時 |
EnvironmentVariables | ワーカーに送信される環境変数の名前 |
FileStore | ジョブの実行中であってもアクセス可能な、ジョブのファイル ストレージ (FileStore オブジェクトとして指定) |
FinishDateTime | ジョブの実行完了日時 |
ID | ジョブの数値識別子 |
JobData | すべてのワーカーがジョブのタスクで使用できる情報 |
Name | ジョブの名前 |
Parent | このジョブが含まれているクラスター オブジェクト |
RunningDuration | ジョブの現在の継続時間 (duration オブジェクトとして指定) |
StartDateTime | ジョブの実行開始日時 |
State | ジョブの状態: 'pending' 、'queued' 、'running' 、'finished' または 'failed' |
SubmitDateTime | ジョブのキュー投入日時 |
Tag | ジョブに関連付けられているラベル |
Tasks | ジョブに含まれるタスク オブジェクトからなる配列 |
Type | ジョブ タイプ: 'independent' 、'pool' または 'spmd' |
UserData | ジョブ オブジェクトに関連付けられている情報 |
Username | ジョブの所有者であるユーザーの名前 |
ValueStore | ジョブの実行中であってもアクセス可能な、ジョブのデータ ストレージ (ValueStore オブジェクトとして指定) |
計算をワーカーにオフロードするときに、クライアント上での計算に必要なファイルもすべてワーカー上で使用可能でなければなりません。既定で、クライアントはそれらのファイルを検出して追加しようとします。自動検出をオフにするには、AutoAttachFiles
プロパティを false
に設定します。ソフトウェアがいずれかのファイルを検出できない場合や、クライアントからワーカーへのファイルの送信速度が遅い場合には、以下のいずれかのオプションを使用します。
ワーカー上でアクセスできないフォルダーにファイルが含まれている場合は、
AttachedFiles
プロパティを設定します。指定した各ファイルが、クラスターによってクライアントからワーカーにコピーされます。ワーカー上でアクセスできるフォルダーにファイルが含まれている場合は、代わりに
AdditionalPaths
プロパティを設定できます。AdditionalPaths
プロパティを使用して各ワーカーの MATLAB 検索パスにパスを追加し、クライアントからワーカーへの不必要なファイルのコピーを回避します。
MATLAB ジョブ スケジューラのジョブ
MATLAB ジョブ スケジューラの独立ジョブ オブジェクトと MATLAB ジョブ スケジューラの通信ジョブ オブジェクトには、共通のプロパティに加えて以下のプロパティがあります。
プロパティ | 説明 |
---|---|
AuthorizedUsers | ジョブへのアクセスを承認されたユーザー |
FinishedFcn | このジョブが完了するとクライアントで実行されるコールバック関数 |
NumWorkersRange | ジョブを実行するワーカー数の上下限 |
QueuedFcn | このジョブがキューに投入されるとクライアントで実行されるコールバック関数 |
RestartWorker | ワーカーがこのジョブの最初のタスクを評価する前に再起動される場合は true |
RunningFcn | このジョブが実行を開始するとクライアントで実行されるコールバック関数 |
Timeout | ジョブを完了するための制限時間 (秒単位) |
CJS ジョブ
CJS 独立ジョブ オブジェクトには、すべてのジョブ タイプに共通のプロパティ以外にプロパティはありません。
CJS 通信ジョブ オブジェクトには、共通のプロパティに加えて以下のプロパティがあります。
プロパティ | 説明 |
---|---|
NumWorkersRange | ジョブを実行するワーカー数の上下限 |
通信ジョブ
MATLAB ジョブ スケジューラの通信ジョブ オブジェクトと CJS の通信ジョブ オブジェクトには、共通のプロパティに加えて以下のプロパティがあります。
プロパティ | 説明 |
---|---|
SpmdEnabled | プール タイプのジョブで spmd コードを実行できるかどうかを示す指標 (R2024a 以降) |
ヘルプ
特定の種類の parallel.Job
オブジェクトの詳細なヘルプ (そのプロパティのヘルプへのリンク一覧など) を表示するには、「help parallel.job.<job-type>
」と入力します。以下に例を示します。
help parallel.job.MJSIndependentJob
バージョン履歴
R2012a で導入