-: pyfaust.factparams.ParamsHierarchicalSquareMat Class Reference

Public Member Functions
def	__init__ (self, n, proj_name='splincol')

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 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

Constructor & Destructor Documentation

def pyfaust.factparams.ParamsHierarchicalSquareMat.__init__	(	self,
		n,
		proj_name = `'splincol'`
	)

Parameters

n	(int) the number of output factors (the input matrix to factorize must be of shape (2n, 2n)).
proj_name	(str) the type of projector used, must be either 'splincol' (default value) or 'skperm'.

def pyfaust.factparams.ParamsHierarchicalSquareMat.createParams	(	M,
		p
	)

static

The documentation for this class was generated from the following file: