fact_constraints | a ConstraintList object or a list of matfaust.proj.proj_gen objects to define the constraints of the main factor at each level of the factorization hierarchy (the first one for the first factorization and so on). |
res_constraints | a ConstraintList object or a list of matfaust.proj.proj_gen objects to define the constraints to apply to the residual factor at each level of the factorization hierarchy (the first one for the first factorization and so on). |
stop_crit1 | a matfaust.factparams.StoppingCriterion instance which defines the algorithm stopping criterion for the local optimization of the 2 terms of the last factorization (a main factor and a residual). |
stop_crit2 | a matfaust.factparams.StoppingCriterion instance which defines the algorithm stopping criterion for the global optimization. |
'is_update_way_R2L',bool | if true matfaust.fact.palm4msa (called for each optimization stage) will update factors from the right to the left, otherwise it's done in reverse order. |
'init_lambda',real | the scale scalar initial value for the global optimization (by default the value is one). It applies only to local optimization at each iteration (the global optimization lambda is updated consequently). |
'step_size',real | the initial step of the PALM descent for both local and global optimization stages. |
'constant_step_size',bool | if true the step_size keeps constant along the algorithm iterations otherwise it is updated before every factor update. |
'is_fact_side_left',bool | if true the leftmost factor is factorized, otherwise it's the rightmost. |
'is_verbose',bool | true to enable the verbose mode. |
'factor_format',str | (optional) 'dynamic' (by default), 'dense', or 'sparse'. If 'dense' or 'sparse' then all factors will be respectively full arrays or sparse matrices. If 'dynamic' is used then the algorithm determines the format of each factor automatically in order to decrease the memory footprint of the Faust. This option is available only on the 2020 backend matfaust.fact.palm4msa, matfaust.fact.hierarchical or matfaust.fact.palm4msa_mhtp, matfaust.fact.hierarchical_mhtp. |
'packing_RL',bool | true (by default) to pre-compute R and L products (only available with 2020 backend of pyfaust.fact.hierarchical). |
'no_normalization',bool | false (by default), if true it disables the normalization of prox output matrix in PALM4MSA algorithm. Note that this option is experimental (only available with 2020 backend of pyfaust.fact.palm4msa). |
'no_lambda',bool | false (by default), if true it disables the lambda scalar factor in the PALM4MSA algorithm which consists basically to set it always to one (it also lowers the algorithm cost). |
'norm2_max_iter',int | maximum number of iterations of power iteration algorithm (default to 100). Used for computing 2-norm. |
'norm2_threshold',real | power iteration algorithm threshold (default to 1e-6). Used for computing 2-norm. |
'grad_calc_opt_mode',int | the mode used for computing the PALM gradient. It can be one value among matfaust.factparams.ParamsFact.EXTERNAL_OPT, matfaust.factparams.ParamsFact.INTERNAL_OPT or matfaust.factparams.ParamsFact.DISABLED_OPT. This parameter is experimental, its value shouln't be changed.
|