ExperimentBinaryStatisticalEvidence

NexusLabs.Foundry.Evaluation

NexusLabs.Foundry.Evaluation.Experiments

ExperimentBinaryStatisticalEvidence Class

Describes binary-success proportion evidence and its uncertainty.

public sealed record ExperimentBinaryStatisticalEvidence : System.IEquatable<NexusLabs.Foundry.Evaluation.Experiments.ExperimentBinaryStatisticalEvidence>

Inheritance System.Object 🡒 ExperimentBinaryStatisticalEvidence

Implements System.IEquatable<ExperimentBinaryStatisticalEvidence>

Properties

ExperimentBinaryStatisticalEvidence.AttemptCount Property

Gets the total number of operational attempts across all trials.

public int AttemptCount { get; }

Property Value

System.Int32

ExperimentBinaryStatisticalEvidence.ConfidenceLevel Property

Gets the one-sided confidence level.

public double ConfidenceLevel { get; }

Property Value

System.Double

ExperimentBinaryStatisticalEvidence.Estimate Property

Gets the observed success proportion, when a denominator exists.

public System.Nullable<double> Estimate { get; }

Property Value

System.Nullable<System.Double>

ExperimentBinaryStatisticalEvidence.ExclusionCount Property

Gets the number of trials with unknown or excluded evidence.

public int ExclusionCount { get; }

Property Value

System.Int32

ExperimentBinaryStatisticalEvidence.ExecutionFailureCount Property

Gets the number of execution-failed trials.

public int ExecutionFailureCount { get; }

Property Value

System.Int32

ExperimentBinaryStatisticalEvidence.FailureCount Property

Gets the denominator failure count.

public int FailureCount { get; }

Property Value

System.Int32

ExperimentBinaryStatisticalEvidence.IntervalMethod Property

Gets the confidence interval method.

public NexusLabs.Foundry.Evaluation.Experiments.ExperimentConfidenceIntervalMethod IntervalMethod { get; }

Property Value

ExperimentConfidenceIntervalMethod

ExperimentBinaryStatisticalEvidence.MetricName Property

Gets the required boolean metric name.

public string MetricName { get; }

Property Value

System.String

ExperimentBinaryStatisticalEvidence.MinimumSampleCount Property

Gets the minimum effective sample count.

public int MinimumSampleCount { get; }

Property Value

System.Int32

ExperimentBinaryStatisticalEvidence.OneSidedLowerBound Property

Gets the one-sided lower bound at ConfidenceLevel, when a denominator exists.

public System.Nullable<double> OneSidedLowerBound { get; }

Property Value

System.Nullable<System.Double>

ExperimentBinaryStatisticalEvidence.OneSidedUpperBound Property

Gets the one-sided upper bound at ConfidenceLevel, when a denominator exists.

public System.Nullable<double> OneSidedUpperBound { get; }

Property Value

System.Nullable<System.Double>

ExperimentBinaryStatisticalEvidence.RequiredSuccessRate Property

Gets the required success proportion.

public double RequiredSuccessRate { get; }

Property Value

System.Double

ExperimentBinaryStatisticalEvidence.SampleCount Property

Gets the effective denominator sample count.

public int SampleCount { get; }

Property Value

System.Int32

ExperimentBinaryStatisticalEvidence.StatusCounts Property

Gets item counts in stable status order.

public System.Collections.Generic.IReadOnlyList<NexusLabs.Foundry.Evaluation.Experiments.ExperimentItemStatusCount> StatusCounts { get; }

Property Value

System.Collections.Generic.IReadOnlyList<ExperimentItemStatusCount>

ExperimentBinaryStatisticalEvidence.SuccessCount Property

Gets the denominator success count.

public int SuccessCount { get; }

Property Value

System.Int32

ExperimentBinaryStatisticalEvidence.TotalTrialCount Property

Gets the number of statistical trials in the run.

public int TotalTrialCount { get; }

Property Value

System.Int32

ExperimentBinaryStatisticalEvidence.UnknownSampleTreatment Property

Gets the configured treatment for unknown samples.

public NexusLabs.Foundry.Evaluation.Experiments.ExperimentUnknownSampleTreatment UnknownSampleTreatment { get; }

Property Value

ExperimentUnknownSampleTreatment

Methods

ExperimentBinaryStatisticalEvidence.Create(string, int, int, int, int, IReadOnlyList<ExperimentItemStatusCount>, double, double, int, ExperimentConfidenceIntervalMethod, ExperimentUnknownSampleTreatment) Method

Creates validated binary statistical evidence.

public static NexusLabs.Foundry.Evaluation.Experiments.ExperimentBinaryStatisticalEvidence Create(string metricName, int attemptCount, int successCount, int failureCount, int exclusionCount, System.Collections.Generic.IReadOnlyList<NexusLabs.Foundry.Evaluation.Experiments.ExperimentItemStatusCount> statusCounts, double confidenceLevel, double requiredSuccessRate, int minimumSampleCount, NexusLabs.Foundry.Evaluation.Experiments.ExperimentConfidenceIntervalMethod intervalMethod, NexusLabs.Foundry.Evaluation.Experiments.ExperimentUnknownSampleTreatment unknownSampleTreatment);

Parameters

metricName System.String

The required boolean metric name.

attemptCount System.Int32

The total number of operational attempts.

successCount System.Int32

The effective denominator success count.

failureCount System.Int32

The effective denominator failure count.

exclusionCount System.Int32

The number of trials with excluded evidence.

statusCounts System.Collections.Generic.IReadOnlyList<ExperimentItemStatusCount>

Item counts for every terminal status.

confidenceLevel System.Double

The one-sided confidence level.

requiredSuccessRate System.Double

The required success proportion.

minimumSampleCount System.Int32

The minimum effective sample count.

intervalMethod ExperimentConfidenceIntervalMethod

The confidence interval method.

unknownSampleTreatment ExperimentUnknownSampleTreatment

The treatment for excluded evidence.

Returns

ExperimentBinaryStatisticalEvidence
Validated binary statistical evidence with derived totals and Wilson bounds.

Exceptions

System.ArgumentNullException
statusCounts or one of its elements is null.

System.ArgumentException
metricName is blank, status accounting is incomplete or inconsistent, or sample and exclusion counts do not match the configured unknown-sample treatment.

System.ArgumentOutOfRangeException
A count is negative, a configured rate or confidence level is outside its supported range, the minimum sample count is not positive, or an enum value is undefined.