mxfusion.components.variables.var_trans

Members

class mxfusion.components.variables.var_trans.VariableTransformation

Bases: abc.ABC

Abstract class for transformations and constraints applied to Variables.

transform(var, F=None, dtype=None)

Forward transformation.

Parameters:
  • var (mx.ndarray or mx.sym) – Variable to be transformed.
  • F (mxnet.ndarray or mxnet.symbol) – Mode to run MxNet in.
  • dtype (e.g. np.float32) – data type.
inverseTransform(out_var, F=None, dtype=None)

Inverse transformation.

Parameters:
  • out_var (mx.ndarray or mx.sym) – Variable to be transformed.
  • F (mxnet.ndarray or mxnet.symbol) – Mode to run MxNet in.
  • dtype (e.g. np.float32) – data type.
class mxfusion.components.variables.var_trans.Softplus(offset)

Bases: mxfusion.components.variables.var_trans.VariableTransformation

Transformation to apply the Softplus and inverse Softplus functions. f = log(1+exp(x))+c f^-1 = log(exp(x-c)-1)

transform(var, F=None, dtype=None)

Forward transformation.

Parameters:
  • var (mx.ndarray or mx.sym) – Variable to be transformed.
  • F (mxnet.ndarray or mxnet.symbol) – Mode to run MxNet in.
  • dtype (e.g. np.float32) – data type.
inverseTransform(out_var, F=None, dtype=None)

Inverse transformation.

Parameters:
  • out_var (mx.ndarray or mx.sym) – Variable to be transformed.
  • F (mxnet.ndarray or mxnet.symbol) – Mode to run MxNet in.
  • dtype (e.g. np.float32) – data type.
class mxfusion.components.variables.var_trans.PositiveTransformation

Bases: mxfusion.components.variables.var_trans.Softplus

Transformation positively constrain a Variable. Wrapper for the Softplus transformation with offset 0.

class mxfusion.components.variables.var_trans.Logistic(lower, upper)

Bases: mxfusion.components.variables.var_trans.VariableTransformation

Transformation to constraint a variable to lie between two values.

transform(var, F=None, dtype=None)

Forward transformation.

Parameters:
  • var (mx.ndarray or mx.sym) – Variable to be transformed.
  • F (mxnet.ndarray or mxnet.symbol) – Mode to run MxNet in.
  • dtype (e.g. np.float32) – data type.
inverseTransform(out_var, F=None, dtype=None)

Inverse transformation.

Parameters:
  • out_var (mx.ndarray or mx.sym) – Variable to be transformed.
  • F (mxnet.ndarray or mxnet.symbol) – Mode to run MxNet in.
  • dtype (e.g. np.float32) – data type.