pyfaust.factparams.ParamsFact Class Reference

The parent abstract class to represent the general factorization parameters. More...

Public Member Functions
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)
def	__repr__ (self)
	Returns object representation. More...

Static Public Member Functions
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...

Public Attributes
	step_size
	constant_step_size
	norm2_max_iter
	norm2_threshold
	factor_format
	packing_RL
	no_normalization
	no_lambda
	use_MHTP

Detailed Description

The parent abstract class to represent the general factorization parameters.

The class is the base parameters for Palm4MSA and Hierarchical factorization but as an abstract class it's not for direct use. The documentation is hence left empty, please refer to the subclasses.

Attrs

DISABLED_OPT (int) Optimization disabled (value 0) INTERNAL_OPT (int) Internal optimization (value 1). EXTERNAL_OPT (int) External optimization (value 2)

See also

ParamsHierarchical, ParamsPalm4MSA

Constructor & Destructor Documentation

__init__()

def pyfaust.factparams.ParamsFact.__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
	)

See also

ParamsHierarchical.__init__, ParamsPalm4MSA.__init__

Member Function Documentation

__repr__()

def pyfaust.factparams.ParamsFact.__repr__

(

self

)

Returns object representation.

Reimplemented in pyfaust.factparams.ParamsPalm4MSA, pyfaust.factparams.ParamsHierarchicalDFT, and pyfaust.factparams.ParamsHierarchical.

factor_format_int2str()

def pyfaust.factparams.ParamsFact.factor_format_int2str (   factor_format )

static

factor_format_str2int()

def pyfaust.factparams.ParamsFact.factor_format_str2int (   factor_format )

static

get_constraints()

def pyfaust.factparams.ParamsFact.get_constraints (   projs )

static

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.

If projs is a ConstraintList then the function just returns the same object as is.

The function purpose is to make the list uniform as ConstraintGeneric objects.

Member Data Documentation

constant_step_size

pyfaust.factparams.ParamsFact.constant_step_size

factor_format

pyfaust.factparams.ParamsFact.factor_format

no_lambda

pyfaust.factparams.ParamsFact.no_lambda

no_normalization

pyfaust.factparams.ParamsFact.no_normalization

norm2_max_iter

pyfaust.factparams.ParamsFact.norm2_max_iter

norm2_threshold

pyfaust.factparams.ParamsFact.norm2_threshold

packing_RL

pyfaust.factparams.ParamsFact.packing_RL

step_size

pyfaust.factparams.ParamsFact.step_size

use_MHTP

pyfaust.factparams.ParamsFact.use_MHTP

---

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

• factparams.py