Class ParameterLearningProgressInfo

Provides progress information during BayesServer.Learning.Parameters.ParameterLearning.Learn.

Inheritance

System.Object

ParameterLearningProgressInfo

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: BayesServer.Learning.Parameters

Assembly: BayesServer.Learning.Parameters.dll

Syntax

public sealed class ParameterLearningProgressInfo

Properties

Delta

Gets the relative change in parameters used to determine convergence.

Declaration

public double? Delta { get; }

Property Value

Type	Description
System.Nullable<System.Double>

Remarks

See Tolerance for more information about convergence.

IterationCount

Gets the current iteration count.

Declaration

public int IterationCount { get; }

Property Value

Type	Description
System.Int32	The iteration count.

LogLikelihood

Gets or sets the current log likelihood value, if calculated

Declaration

public double? LogLikelihood { get; }

Property Value

Type	Description
System.Nullable<System.Double>	The log likelihood.

Remarks

This value is only calculated if MonitorLogLikelihood is true, as it can be expensive to calculate.

For more information about the log likelihood statistic see LogLikelihood.

Methods

GetMonitoredDistribution(Node)

Gets a copy of the current distribution assigned to the node.

Declaration

public IDistribution GetMonitoredDistribution(Node node)

Parameters

Type	Name	Description
Node	node	The node.

Returns

Type	Description
IDistribution	A copy of the current node distribution.

GetMonitoredDistribution(Node, NodeDistributionKey)

Gets a copy of the current distribution assigned to the node at the requested order.

Declaration

public IDistribution GetMonitoredDistribution(Node node, NodeDistributionKey key)

Parameters

Type	Name	Description
Node	node	The node.
NodeDistributionKey	key	The order/related node of the distribution to retrieve. For temporal nodes / noisy nodes that may have more than one distribution.

Returns

Type	Description
IDistribution	A copy of the current node distribution at a specific order.

GetMonitoredDistribution(Node, Nullable<Int32>)

Gets a copy of the current distribution assigned to the node at the requested order.

Declaration

public IDistribution GetMonitoredDistribution(Node node, int? order)

Parameters

Type	Name	Description
Node	node	The node.
System.Nullable<System.Int32>	order	The order of the distribution to retrieve. For temporal nodes that may have more than one distribution.

Returns

Type	Description
IDistribution	A copy of the current node distribution at a specific order.