Mentions légales du service

Skip to content
Snippets Groups Projects
Commit 1c18e7c6 authored by hhakim's avatar hhakim
Browse files

Document SIGINT stop of palm4msa and hierarchical in matfaust/pyfaust.

parent cac637ad
Branches
Tags
No related merge requests found
......@@ -10,6 +10,15 @@
%> @param 'backend',int (optional) the backend to use (the C++ implementation). Must be 2016 (the default) or 2020 (which should be faster for most of the factorizations).
%> @param 'gpu', bool (optional) set to true to execute the algorithm using the GPU implementation. This option is only available when backend==2020.
%>
%>
%> @note - If backend parameter is 2020 and independently to the StoppingCriterion-s defined in p,
%> it is possible to stop any internal call to PALM4MSA manually at any iteration
%> by the key combination CTRL-C.
%> The last Faust computed in the PALM4MSA instance will be used to continue
%> the hierarchical factorization.
%> A typical use case is when the verbose mode is enabled and you see that the error
%> doesn't change anymore or only slightly, you might stop iterations by typing CTRL-C.
%>
%> @note - The fully defined parameters (ParamsHierarchical instance) used/generated by the function are available in the return result (so one can consult what precisely mean the simplified parameterizations and possibly adjust the attributes to factorize again).
%> @note - This function has its shorthand matfaust.faust_fact(). For convenience you might use it like this:
%> @code
......
......@@ -7,6 +7,13 @@
%> @param 'backend',int (optional) the backend to use (the C++ implementation). Must be 2016 (the default) or 2020 (which should be faster for most of the factorizations).
%> @param 'gpu', bool (optional) set to true to execute the algorithm using the GPU implementation. This option is only available when backend==2020.
%>
%> @note If backend parameter is 2020 and independently to the StoppingCriterion defined in p,
%> it is possible to stop the algorithm manually at any iteration by the key
%> combination CTRL-C.
%> The last Faust computed in the factorization process will be returned.
%> A typical use case is when the verbose mode is enabled and you see that the error
%> doesn't change anymore or only slightly, you might stop iterations by typing CTRL-C.
%>
%> @retval F the Faust object result of the factorization.
%> @retval [F, lambda] = palm4msa(M, p) when optionally getting lambda (scale).
%>
......
......@@ -707,6 +707,13 @@ def palm4msa(M, p, ret_lambda=False, backend=2016, on_gpu=False):
should be faster for most of the factorizations).
on_gpu: if True the GPU implementation is executed (this option applies only to 2020 backend).
NOTE: If backend=2020 and independently to the StoppingCriterion defined in p,
it is possible to stop the algorithm manually at any iteration by the key
combination CTRL-C.
The last Faust computed in the factorization process will be returned.
A typical use case is when the verbose mode is enabled and you see that the error
doesn't change anymore or only slightly, you might stop iterations by typing CTRL-C.
Returns:
The Faust object resulting of the factorization.
if ret_lambda == True then the function returns a tuple (Faust, lambda).
......@@ -940,6 +947,13 @@ def hierarchical(M, p, ret_lambda=False, ret_params=False, backend=2016,
simplified parametrizations used to generate a
ParamsHierarchical instance and possibly adjust its attributes to factorize again.
NOTE: If backend=2020 and independently to the StoppingCriterion-s defined in p,
it is possible to stop any internal call to PALM4MSA manually at any iteration
by the key combination CTRL-C.
The last Faust computed in the PALM4MSA instance will be used to continue
the hierarchical factorization.
A typical use case is when the verbose mode is enabled and you see that the error
doesn't change anymore or only slightly, you might stop iterations by typing CTRL-C.
Returns:
F the Faust object result of the factorization: Faust\f$([S_1, S_2, ...
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment