Skip to content

Commit

Permalink
ENH+TST: ensure that no warning is given when the number of cores is …
Browse files Browse the repository at this point in the history 
…not specified
  • Loading branch information
@nno
nno committed Jan 20, 2017
1 parent b407f8d commit a05a48e
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 77 deletions.
135 changes: 58 additions & 77 deletions mvpa/cosmo_parallel_get_nproc_available.m
View file
Expand Up @@ -5,7 +5,8 @@
%
% Input:
% 'nproc',nproc_wanted Number of desired processes
% default: Inf
% If not provided, then the number of
% available cores is returned.
%
% Output:
% nproc_available Number of available parallel processes.
Expand All @@ -23,105 +24,85 @@
% # For CoSMoMVPA's copyright information and license terms, #
% # see the COPYING file distributed with CoSMoMVPA. #

default=struct();
default.nproc=Inf;

opt=cosmo_structjoin(default,varargin{:});
defaults=struct();
opt=cosmo_structjoin(defaults,varargin{:});
check_inputs(opt);

max_nproc_available_query_func=get_max_nproc_available_func();
[max_nproc_available,msg]=max_nproc_available_query_func();

nproc_wanted=opt.nproc;
wants_multithreaded = nproc_wanted>1;

if wants_multithreaded
if cosmo_wtf('is_matlab')
nproc_available=get_nproc_available_matlab(nproc_wanted);

elseif cosmo_wtf('is_octave')
nproc_available=get_nproc_available_octave(nproc_wanted);
if ~isfield(opt,'nproc')
nproc_available=max_nproc_available;
return;
end

else
assert(false,'this should not happen');
nproc_wanted=opt.nproc;
if nproc_wanted>max_nproc_available
nproc_available=max_nproc_available;
full_msg=sprintf(['''nproc''=%d requested, but %s. '...
'Using ''nproc''=%d'],...
nproc_wanted,msg,nproc_available);
warning(msg);
nproc_available=max_nproc_available;
end

end

nproc_available=min(nproc_available,nproc_wanted);

if nproc_available==1 && isfinite(nproc_wanted);
cosmo_warning(['Parallel computing not available, using '...
'single thread']);
end
function func=get_max_nproc_available_func()
if cosmo_wtf('is_matlab')
func=@matlab_get_max_nproc_available;
elseif cosmo_wtf('is_octave')
func=@octave_get_max_nproc_available;
else
nproc_available=1;
assert(false,'this should not happen');
end


function check_inputs(opt)
assert(isfield(opt,'nproc'));
nproc=opt.nproc;
if ~(isnumeric(nproc) && ...
isscalar(nproc) && ...
nproc>=1 && ...
round(nproc)==nproc)
error('nproc must be a positive scalar');
if isfield(opt,'nproc')
nproc=opt.nproc;
if ~(isnumeric(nproc) && ...
isscalar(nproc) && ...
nproc>=1 && ...
round(nproc)==nproc)
error('nproc must be a positive scalar');
end
end


function nproc_available=get_nproc_available_matlab(nproc_wanted)
function [nproc_available,msg]=matlab_get_max_nproc_available
msg='';
nproc_available=1;

matlab_parallel_functions={'gcp','parpool'};
if ~(usejava('jvm') && ...
platform_has_functions(matlab_parallel_functions))
msg='java or parallel functions not available';
return;
end

if usejava('jvm') && platform_has_functions(matlab_parallel_functions)
pool = gcp();
pool = gcp();

if isempty(pool)
cosmo_warning(['Parallel toolbox is available, but '...
'unable to open pool; using nproc=1']);
nproc_available=1;
else
nworkers=pool.NumWorkers();
if isempty(pool)
msg=['Parallel toolbox is available, but '...
'unable to open pool'];
return;
end

if nproc_wanted>nworkers && isfinite(nproc_wanted);
cosmo_warning(['nproc=%d requested but only %d '...
'workers available; setting '...
'nproc=%d'],...
nproc_wanted,nworkers,nworkers);
end
nproc_available=pool.NumWorkers();

nproc_available=nworkers;
end
else
nproc_available=1;
if nproc_wanted>nproc_available
cosmo_warning(['nproc=%d requested but parallel toolbox '...
'or java not available; using nproc=%d'], ...
nproc_wanted, nproc_available);
end
end

function nproc_available=get_nproc_available_octave(nproc_wanted)
% return nproc_wanted if the Octave 'parallel' package is available, or 1
% otherwise
% (the parallel package does not support returning the number
% of CPUs available)
if cosmo_check_external('octave_pkg_parallel',false)
nworkers=nproc('overridable');

if nproc_wanted>nworkers
cosmo_warning(['nproc=%d requested but only %d '...
'workers available; setting '...
'nproc=%d'],...
nproc_wanted,nworkers);
end
function [nproc_available,msg]=octave_get_max_nproc_available
msg='';
nproc_available=1;

nproc_available=nworkers;
else
nproc_available=1;
if nproc_wanted>nproc_available && isfinite(nproc_wanted)
cosmo_warning(['nproc=%d requested but parallel toolbox '...
'not available; setting nproc=%d'], ...
nproc_wanted, nproc_available);
end
if ~cosmo_check_external('octave_pkg_parallel',false)
msg='parallel toolbox is not available';
return;
end

nproc_available=nproc_available('overridable');


function tf=platform_has_functions(function_names)
tf=all(cellfun(@(x)~isempty(which(x)),function_names));
18 changes: 18 additions & 0 deletions tests/test_parcellfun.m
View file
Expand Up @@ -14,6 +14,24 @@ function test_parcellfun_single_proc()
nproc=1;
helper_test_parcellfun(nproc);

function test_cosmo_parallel_get_nproc_available()
warning_state=cosmo_warning();
cleaner=onCleanup(@()cosmo_warning(warning_state));
cosmo_warning('reset');
cosmo_warning('off');

nproc=cosmo_parallel_get_nproc_available();
assert(nproc>=1);

% should not have shown any warnings
w=cosmo_warning();
assert(isempty(w.shown_warnings),sprintf('warning shown: %s',...
w.shown_warnings{:}));





function test_parcellfun_multi_proc()
nproc=cosmo_parallel_get_nproc_available();
if nproc==1
Expand Down

0 comments on commit a05a48e

Please sign in to comment.