stop

Stop monitoring parallel pool activity

Since R2025a

collapse all in page

    Syntax

    monitorResults = stop(monitor)

    Description

    monitorResults = stop(monitor) stops collecting pool activity monitoring data and retrieves all pool activity monitoring results from the ActivityMonitor object, monitor.

    example

    Examples

    collapse all

    Open Live Script

    Create an ActivityMonitor object to start collecting pool monitoring data. With default settings, parallel.pool.ActivityMonitor automatically starts an interactive parallel pool using the default profile if one does not exist.

    monitor = parallel.pool.ActivityMonitor;
    Starting parallel pool (parpool) using the 'Processes' profile ...
Connected to parallel pool with 6 workers.

    Submit multiple parfeval computations to compute magic squares. Wait for all tasks to complete.

    f(1:100) = parallel.Future;
for idx = 1:100
    f(idx) = parfeval(@magic,1,idx);
end
wait(f);

    Use the stop function to stop collecting monitoring data and retrieve the monitoring results. Visualize the monitoring results in the Pool Dashboard.

    monitoringResults = stop(monitor);
parpoolDashboard(monitoringResults)

    Input Arguments

    collapse all

    Pool activity monitor, specified as an ActivityMonitor object.

    Example: monitor = parallel.pool.ActivityMonitor

    Output Arguments

    collapse all

    Pool activity monitoring results, returned as an ActivityMonitorResults object.

    If you have not previously started the ActivityMonitor object, the stop function returns a 0-by-0 ActivityMonitorResults object array with empty StartTime and EndTime object properties.

    To visualize the pool activity monitoring results in the Pool Dashboard, use the parpoolDashboard function.

    Version History

    Introduced in R2025a

    See Also

    Functions

    Objects

    Tools