ClusterPool - Parallel pool of workers on a cluster of machines - MATLAB (original) (raw)
Parallel pool of workers on a cluster of machines
Description
Use parpool to create a parallel pool of workers on a cluster of machines. After you create the pool, parallel pool features, such asparfor or parfeval, run on the workers. With theClusterPool object, you can interact with the parallel pool.
Creation
- Create a parallel pool on a cluster of machines by using the parpool function.
pool = parpool("myCluster")
wheremyClusteris the name of a cluster profile for a cluster of machines. - Create a pool partition from an existing parallel pool using the partition function. (since R2025a)
Properties
Files and folders copied to workers, specified as a cell array of character vectors. To attach files and folders to the pool, use addAttachedFiles.
This property is read-only.
Indication whether user-added entries on client path are added to worker paths, specified as a logical value.
Data Types: logical
This property is read-only.
Cluster on which the parallel pool is running, specified as a parallel.Cluster object.
This property is read-only.
Flag that indicates whether the parallel pool is running, specified as a logical value.
Data Types: logical
This property is read-only.
Environment variables copied to the workers, specified as a cell array of character vectors.
This property is read-only.
Queue of FevalFutures to run on the parallel pool, returned as anFevalQueue object. You can use this property to check the pending and running future variables of the parallel pool. To create future variables, use parfeval and parfevalOnAll. For more information on future variables, see Future.
Data Types: FevalQueue
Store of files accessible to both client and workers, specified as a FileStore object.
Time in minutes after which the pool shuts down if idle, specified as an integer greater than zero. A pool is idle if it is not running code on the workers. By default'IdleTimeout' is the same as the value in your parallel settings. For more information on parallel settings, see Specify Your Parallel Settings.
This property is read-only.
Number of workers comprising the parallel pool, specified as an integer.
ClusterPool objects support pools with up to 2000 workers. (since R2024a)
This property is read-only.
Flag that indicates whether the parallel pool is busy, specified astrue or false. The pool is busy if there is outstanding work for the pool to complete.
This property is read-only.
Indication if pool can run spmd code, specified as a logical value.
Data Types: logical
Store of data accessible to both client and workers, specified as a ValueStore object.
Since R2025a
This property is read-only.
Information about workers comprising the parallel pool, returned as an array ofparallel.Worker objects.
Object Functions
| addAttachedFiles | Attach files or folders to parallel pool |
|---|---|
| Composite | Create and access nondistributed variables on multiple workers from client |
| delete | Shut down parallel pool |
| listAutoAttachedFiles | List of files automatically attached to job, task, or parallel pool |
| parfeval | Run function on parallel pool worker |
| parfevalOnAll | Run function asynchronously on all workers in parallel pool |
| parforOptions | Options set for parfor |
| partition | Partition parallel pool |
| ticBytes | Start counting bytes transferred within parallel pool |
| tocBytes | Read how many bytes have been transferred since callingticBytes |
| updateAttachedFiles | Update attached files or folders on parallel pool |
| spmd | Execute code in parallel on workers of parallel pool |
Version History
Introduced in R2020a
To identify the workers in a pool, use the Workers property.
Starting in R2024a, ClusterPool objects support pools with up to 2000 workers. Before R2024a, ClusterPool supports pools with up to 1000 workers.