pyfaust.factparams.MHTPParams Class Reference

This class defines the set of parameters to run the MHTP-PALM4MSA algorithm. More...

Public Member Functions
def	__init__ (self, num_its=50, constant_step_size=False, step_size=1e-3, palm4msa_period=1000, updating_lambda=True)
	Constructor of the MHTPParams class. More...
def	__repr__ (self)
	The MHTPParams instance str representation. More...

Public Attributes
	constant_step_size
	step_size
	palm4msa_period
	updating_lambda

Detailed Description

This class defines the set of parameters to run the MHTP-PALM4MSA algorithm.

See also

MHTPParams.__init__, pyfaust.fact.palm4msa_mhtp, pyfaust.fact.hierarchical_mhtp

Constructor & Destructor Documentation

__init__()

def pyfaust.factparams.MHTPParams.__init__	(		self,
			num_its = 50,
			constant_step_size = False,
			step_size = 1e-3,
			palm4msa_period = 1000,
			updating_lambda = True
	)

Constructor of the MHTPParams class.

Parameters

num_its	(int) the number of iterations to run the MHTP algorithm.
constant_step_size	(bool) True to use a constant step for the gradient descent, False otherwise. If False the step size is computed dynamically along the iterations (according to a Lipschitz criterion).
step_size	(float) The step size used when constant_step_size==True.
palm4msa_period	(int) The period (in term of iterations) according to the MHTP algorithm is ran (i.e.: 0 <= i < N being the PALM4MSA iteration, MHTP is launched every i = 0 (mod palm4msa_period). Hence the algorithm is ran one time at least – at PALM4MSA iteration 0).
updating_lambda	(bool) if True then the scale factor of the Faust resulting of the factorization is updated after each iteration of MHTP (otherwise it never changes during the whole MHTP execution).

See also

pyfaust.fact.palm4msa_mhtp,

Parameters

pyfaust.fact.hierarchical_mhtp

Member Function Documentation

__repr__()

def pyfaust.factparams.MHTPParams.__repr__

(

self

)

The MHTPParams instance str representation.

Member Data Documentation

constant_step_size

pyfaust.factparams.MHTPParams.constant_step_size

palm4msa_period

pyfaust.factparams.MHTPParams.palm4msa_period

step_size

pyfaust.factparams.MHTPParams.step_size

updating_lambda

pyfaust.factparams.MHTPParams.updating_lambda

---

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

• factparams.py