Class PointEstimator

Implements point estimators.

Inheritance

Object

PointEstimator

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.Learners

Assembly: Microsoft.ML.Probabilistic.Learners.dll

Syntax

public static class PointEstimator

Methods

ForBernoulli(LossFunction)

Gets a method which converts a Bernoulli distribution into a point estimate.

Declaration

public static Func<Bernoulli, bool> ForBernoulli(LossFunction lossFunction)

Parameters

Type	Name	Description
LossFunction	lossFunction	The LossFunction, which determines the loss to minimize.

Returns

Type	Description
Func<Bernoulli, Boolean>	The point estimator.

ForBernoulli(Func<Boolean, Boolean, Double>)

Gets a method which converts a Bernoulli distribution into a point estimate.

Declaration

public static Func<Bernoulli, bool> ForBernoulli(Func<bool, bool, double> customLossFunction)

Parameters

Type	Name	Description
Func<Boolean, Boolean, Double>	customLossFunction	The custom loss function used to compute the point estimate.

Returns

Type	Description
Func<Bernoulli, Boolean>	The point estimator.

ForDiscrete(LossFunction)

Gets a method which converts a Discrete distribution into a point estimate.

Declaration

public static Func<Discrete, int> ForDiscrete(LossFunction lossFunction)

Parameters

Type	Name	Description
LossFunction	lossFunction	The LossFunction, which determines the loss to minimize.

Returns

Type	Description
Func<Discrete, Int32>	The point estimator.

ForDiscrete(Func<Int32, Int32, Double>)

Gets a method which converts a Discrete distribution into a point estimate.

Declaration

public static Func<Discrete, int> ForDiscrete(Func<int, int, double> customLossFunction)

Parameters

Type	Name	Description
Func<Int32, Int32, Double>	customLossFunction	The custom loss function used to compute the point estimate.

Returns

Type	Description
Func<Discrete, Int32>	The point estimator.

ForDiscrete<TLabel>(LossFunction)

Gets a method which converts a Discrete distribution into a point estimate.

Declaration

public static Func<IDictionary<TLabel, double>, TLabel> ForDiscrete<TLabel>(LossFunction lossFunction)

Parameters

Type	Name	Description
LossFunction	lossFunction	The LossFunction, which determines the loss to minimize.

Returns

Type	Description
Func<IDictionary<TLabel, Double>, TLabel>	The point estimator.

Type Parameters

Name	Description
TLabel	The type of a label.

ForDiscrete<TLabel>(Func<TLabel, TLabel, Double>)

Gets a method which converts a Discrete distribution into a point estimate.

Declaration

public static Func<IDictionary<TLabel, double>, TLabel> ForDiscrete<TLabel>(Func<TLabel, TLabel, double> customLossFunction)

Parameters

Type	Name	Description
Func<TLabel, TLabel, Double>	customLossFunction	The custom loss function used to compute the point estimate.

Returns

Type	Description
Func<IDictionary<TLabel, Double>, TLabel>	The point estimator.

Type Parameters

Name	Description
TLabel	The type of a label.

GetEstimate(Bernoulli, Func<Boolean, Boolean, Double>)

Computes the point estimate for a Bernoulli distribution using a specified loss function.

Declaration

public static bool GetEstimate(Bernoulli distribution, Func<bool, bool, double> lossFunction)

Parameters

Type	Name	Description
Bernoulli	distribution	The Bernoulli distribution.
Func<Boolean, Boolean, Double>	lossFunction	The loss function.

Returns

Type	Description
Boolean	The point estimate.

GetEstimate(Discrete, Func<Int32, Int32, Double>)

Computes the point estimate for a Discrete distribution using a specified loss function.

Declaration

public static int GetEstimate(Discrete distribution, Func<int, int, double> lossFunction)

Parameters

Type	Name	Description
Discrete	distribution	The Discrete distribution.
Func<Int32, Int32, Double>	lossFunction	The loss function.

Returns

Type	Description
Int32	The point estimate.

GetEstimate<TLabel>(IDictionary<TLabel, Double>, Func<TLabel, TLabel, Double>)

Computes the point estimate for a Discrete distribution using a specified loss function.

Declaration

public static TLabel GetEstimate<TLabel>(IDictionary<TLabel, double> distribution, Func<TLabel, TLabel, double> lossFunction)

Parameters

Type	Name	Description
IDictionary<TLabel, Double>	distribution	The predictive distribution.
Func<TLabel, TLabel, Double>	lossFunction	The loss function.

Returns

Type	Description
TLabel	The point estimate.

Type Parameters

Name	Description
TLabel	The type of a label.

GetMode<TLabel>(IDictionary<TLabel, Double>)

Gets the mode of the specified generic discrete distribution.

Declaration

public static TLabel GetMode<TLabel>(this IDictionary<TLabel, double> distribution)

Parameters

Type	Name	Description
IDictionary<TLabel, Double>	distribution	The distribution.

Returns

Type	Description
TLabel	The mode of the distribution.

Type Parameters

Name	Description
TLabel	The type of a label.