-  3.39.25
pyfaust.factparams.ParamsHierarchicalRectMatNoResCons Class Reference

This parameter class is the same as ParamsHierarchicalRectMat except that there is no residual factor constraints (see ParamsHierachicalNoResCons). More...

Public Member Functions

def __init__ (self, m, n, j, k, s, rho=0.8, P=None, **kwargs)
 This class defines the same parameterization as ParamsHierarchicalRectMat except that there is no constraint on the residual factors (cf. More...
 
- Public Member Functions inherited from pyfaust.factparams.ParamsHierarchicalRectMat
def __init__ (self, m, n, j, k, s, rho=0.8, P=1.4)
 Constructor for the specialized parameterization used for example in the pyfaust.demo.bsl (brain souce localization). More...
 
- Public Member Functions inherited from pyfaust.factparams.ParamsHierarchical
def __init__ (self, fact_constraints, res_constraints, stop_crit1, stop_crit2, is_update_way_R2L=False, init_lambda=1.0, step_size=10.0 **-16, constant_step_size=False, is_fact_side_left=False, is_verbose=False, factor_format='dynamic', packing_RL=True, no_normalization=False, no_lambda=False, norm2_max_iter=100, norm2_threshold=1e-6, grad_calc_opt_mode=ParamsFact.EXTERNAL_OPT, **kwargs)
 Constructor. More...
 
def are_constraints_consistent (self, M)
 This method verifies that the constraints are shape-consistent to the matrix/array M to factorize and with each other. More...
 
def __repr__ (self)
 Returns object representation. More...
 
- Public Member Functions inherited from pyfaust.factparams.ParamsFact
def __init__ (self, num_facts, is_update_way_R2L, init_lambda, constraints, step_size, constant_step_size, is_verbose, factor_format='dynamic', packing_RL=True, no_normalization=False, no_lambda=False, norm2_max_iter=100, norm2_threshold=1e-6, grad_calc_opt_mode=EXTERNAL_OPT, **kwargs)
 

Static Public Member Functions

def createParams (M, p)
 Static member function to create a ParamsHierarchicalRectMatNoResCons instance by a simplified parameterization expression. More...
 
- Static Public Member Functions inherited from pyfaust.factparams.ParamsFact
def factor_format_str2int (factor_format)
 
def factor_format_int2str (factor_format)
 
def get_constraints (projs)
 Returns a python list of constraints from the projs which is a ConstralintList or a list/tuple that can be a mix of ConstraintGeneric or pyfaust.proj.proj_gen. More...
 

Additional Inherited Members

- Public Attributes inherited from pyfaust.factparams.ParamsFact
 step_size
 
 constant_step_size
 
 norm2_max_iter
 
 norm2_threshold
 
 factor_format
 
 packing_RL
 
 no_normalization
 
 no_lambda
 
 use_MHTP
 

Detailed Description

This parameter class is the same as ParamsHierarchicalRectMat except that there is no residual factor constraints (see ParamsHierachicalNoResCons).

See also
pyfaust.fact.hierarchical, pyfaust.demo.bsl,
ParamsHierarchicalRectMat,
ParamsHierarchicalNoResCons,
ParamsHierarchicalRectMatNoResCons.__init__

Constructor & Destructor Documentation

◆ __init__()

def pyfaust.factparams.ParamsHierarchicalRectMatNoResCons.__init__ (   self,
  m,
  n,
  j,
  k,
  s,
  rho = 0.8,
  P = None,
**  kwargs 
)

This class defines the same parameterization as ParamsHierarchicalRectMat except that there is no constraint on the residual factors (cf.

pyfaust.proj.proj_id).

Parameters
m(int)
cf. ParamsHierarchicalRectMat.__init__
n: (int)
cf. ParamsHierarchicalRectMat.__init__
j: (int)
cf. ParamsHierarchicalRectMat.__init__
k: (int)
cf. ParamsHierarchicalRectMat.__init__
s: (float)
cf. ParamsHierarchicalRectMat.__init__
rho: (float)
cf. ParamsHierarchicalRectMat.__init__
P: (float)
cf. ParamsHierarchicalRectMat.__init__

Member Function Documentation

◆ createParams()

def pyfaust.factparams.ParamsHierarchicalRectMatNoResCons.createParams (   M,
  p 
)
static

Static member function to create a ParamsHierarchicalRectMatNoResCons instance by a simplified parameterization expression.

Parameters
pa list of the form ['rectmat_simple', j, k, s] to create a parameter instance with the parameters j, k, s (see the class ParamsHierarchicalRectMat.__init__ for their definitions).

Examples

>>> from pyfaust.factparams import ParamsHierarchicalRectMat
>>> from numpy.random import rand, seed
>>> seed(42) # just for reproducibility
>>> num_facts = 9
>>> k = 10
>>> s = 8
>>> p = ParamsHierarchicalRectMat.createParams(rand(256, 1024), ['rectmat_simple', num_facts, k, s])

Reimplemented from pyfaust.factparams.ParamsHierarchicalRectMat.


The documentation for this class was generated from the following file:
pyfaust.seed
def seed(s)
(Re)Initializes the pyfaust pseudo-random generator.
Definition: __init__.py:5334
pyfaust.rand
def rand(num_rows, num_cols, num_factors=None, dim_sizes=None, density=None, fac_type='sparse', per_row=True, dev='cpu', dtype='float64', field=None, seed=0)
Generates a random Faust.
Definition: __init__.py:5016
pyfaust.factparams
The module for the parameterization of FAuST's algorithms (Palm4MSA and Hierarchical Factorization)....
Definition: factparams.py:1