Main Content

parallel.defaultProfile

Examine or set default cluster profile

    Description

    p = parallel.defaultProfile returns the name of the default cluster profile.

    example

    oldProfile = parallel.defaultProfile(newProfile) sets the default profile to newProfile and returns the previous default profile.

    If you delete or have not set the default profile, parallel.defaultProfile returns 'Processes' as the previous default profile.

    You can save modified profiles by using the saveProfile or saveAsProfile functions on a cluster object. You can create, delete, import, and modify profiles with the Cluster Profile Manager. To access the Cluster Profile manager, in the Environment area of the MATLAB® desktop Home tab, click Parallel and then click Create and Manage Clusters.

    Examples

    collapse all

    Display the names of all the available profiles and set the first in the list as the default.

    allProfiles = parallel.listProfiles
    oldProfile = parallel.defaultProfile(allProfiles{1});

    Set the profile named 'MyProfile' as the default.

    parallel.defaultProfile('MyProfile');
    

    Set the profile named 'Profile2' as the new default. Backup the old default profile using the name 'OldDefault'.

    oldDefault = parallel.defaultProfile('Profile2');
    strcmp(oldDefault,'MyProfile') 
    ans =
    
      logical
    
       1

    Tips

    • If you set a new default profile, you can keep the old profile in your MATLAB workspace in case you need to reset the default profile.

    Version History

    Introduced in R2022b