Class VariablePointOpBase

Provides outgoing messages for VariablePoint<T>(T, out T), given random arguments to the function.

Inheritance

Object

VariablePointOpBase

VariablePointOp_Mean<T>

VariablePointOp_Rprop

VariablePointOp_RpropBeta

VariablePointOp_RpropGamma

VariablePointOp_RpropTruncatedGamma

VariablePointOp_RpropTruncatedGaussian

VariablePointOp<T>

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Microsoft.ML.Probabilistic.Factors

Assembly: Microsoft.ML.Probabilistic.dll

Syntax

[Quality(QualityBand.Preview)]
public class VariablePointOpBase

Methods

AverageLogFactor()

Evidence message for VMP.

Declaration

public static double AverageLogFactor()

Returns

Type	Description
Double	Average of the factor's log-value across the given argument distributions.

Remarks

The formula for the result is log(factor(use,def,marginal)). Adding up these values across all factors and variables gives the log-evidence estimate for VMP.

DefAverageConditional<TDist>(TDist)

EP message to def.

Declaration

public static TDist DefAverageConditional<TDist>(TDist to_marginal)

Parameters

Type	Name	Description
TDist	to_marginal	Previous outgoing message to marginal.

Returns

Type	Description
TDist	The outgoing EP message to the def argument.

Type Parameters

Name	Description
TDist	The type of the marginal of the variable.

Remarks

The outgoing message is the factor viewed as a function of def conditioned on the given values.

DefAverageLogarithm<TDist>(TDist)

VMP message to def.

Declaration

public static TDist DefAverageLogarithm<TDist>(TDist to_marginal)

Parameters

Type	Name	Description
TDist	to_marginal	Previous outgoing message to marginal.

Returns

Type	Description
TDist	The outgoing VMP message to the def argument.

Type Parameters

Name	Description
TDist	The type of the marginal of the variable.

Remarks

The outgoing message is the factor viewed as a function of def conditioned on the given values.

LogEvidenceRatio<TDist>(TDist, TDist, TDist)

Evidence message for EP.

Declaration

public static double LogEvidenceRatio<TDist>(TDist use, TDist def, TDist to_marginal)
    where TDist : CanGetLogAverageOf<TDist>

Parameters

Type	Name	Description
TDist	use	Incoming message from use.
TDist	def	Incoming message from def.
TDist	to_marginal	Previous outgoing message to marginal.

Returns

Type	Description
Double	Logarithm of the factor's contribution the EP model evidence.

Type Parameters

Name	Description
TDist	The type of the marginal of the variable.

Remarks

The formula for the result is log(sum_(use,def) p(use,def) factor(use,def,marginal) / sum_use p(use) messageTo(use)). Adding up these values across all factors and variables gives the log-evidence estimate for EP.

MarginalAverageConditionalInit<TDist>(TDist)

Declaration

public static TDist MarginalAverageConditionalInit<TDist>(TDist def)
    where TDist : ICloneable

Parameters

Type	Name	Description
TDist	def	Incoming message from def.

Returns

Type	Description
TDist

Type Parameters

Name	Description
TDist	The type of the marginal of the variable.

Remarks

UseAverageConditional<TDist>(TDist)

EP message to use.

Declaration

public static TDist UseAverageConditional<TDist>(TDist to_marginal)

Parameters

Type	Name	Description
TDist	to_marginal	Previous outgoing message to marginal.

Returns

Type	Description
TDist	The outgoing EP message to the use argument.

Type Parameters

Name	Description
TDist	The type of the marginal of the variable.

Remarks

The outgoing message is the factor viewed as a function of use conditioned on the given values.

UseAverageLogarithm<TDist>(TDist)

VMP message to use.

Declaration

public static TDist UseAverageLogarithm<TDist>(TDist to_marginal)

Parameters

Type	Name	Description
TDist	to_marginal	Previous outgoing message to marginal.

Returns

Type	Description
TDist	The outgoing VMP message to the use argument.

Type Parameters

Name	Description
TDist	The type of the marginal of the variable.

Remarks

The outgoing message is the factor viewed as a function of use conditioned on the given values.