SS.Experiments 1.2.0
Typed Cartesian and Latin-hypercube plans, user-callable execution, eligible bounded retries, canonical integrity-checked checkpoints, explicit failure summaries and legacy affine provenance
Language compatibility: >=1.0.0 <2.0.0
Runtime compatibility: >=1.0.0 <2.0.0
No package dependencies declared.
Public API
Experiments.cartesian
export function cartesian(string experimentId, double[] first, double[] second) -> SweepParameters: experimentId: string, first: double[], second: double[]
Experiments.cartesianPlan
export function cartesianPlan(string experimentId, ParameterAxis[] axes, string[] resultNames)->ExperimentPlanParameters: experimentId: string, axes: ParameterAxis[], resultNames: string[]
Experiments.categoricalAxis
export function categoricalAxis(string name, string[] labels)->ParameterAxisParameters: name: string, labels: string[]
Experiments.Checkpoint
export record Checkpoint(public string experimentId, public int trialCount, public int completed, public double[] results, public bool complete)Parameters: experimentId: string, trialCount: int, completed: int, results: double[], complete: bool
export function checkpointExperimentBatch(ExperimentRun run) -> stringParameters: run: ExperimentRun
Experiments.define
export function define(string identity, int seed, string sourceDigest, string dataIdentity, string methodVersion)->ExperimentDefinitionParameters: identity: string, seed: int, sourceDigest: string, dataIdentity: string, methodVersion: string
Experiments.executeBudget
export function executeBudget(ExperimentPlan plan, ExperimentRun run, TrialExecutor executor, int budget, int maximumAttempts)->ExperimentRunParameters: plan: ExperimentPlan, run: ExperimentRun, executor: TrialExecutor, budget: int, maximumAttempts: int
export function executeExperimentCallable(ExperimentPlan plan, ExperimentRun run, TrialExecutor executor, int budget, int maximumAttempts) -> ExperimentRunParameters: plan: ExperimentPlan, run: ExperimentRun, executor: TrialExecutor, budget: int, maximumAttempts: int
export record ExperimentDefinition(public string identity, public int seed, public string sourceDigest, public string dataIdentity, public string methodVersion)Parameters: identity: string, seed: int, sourceDigest: string, dataIdentity: string, methodVersion: string
export record ExperimentFailureSummary(public int succeeded, public int failed, public int skipped, public int unexecuted, public string[] failureCodes, public string[] failureMessages)Parameters: succeeded: int, failed: int, skipped: int, unexecuted: int, failureCodes: string[], failureMessages: string[]
export record ExperimentPlan(public string experimentId, public string fingerprint, public ParameterAxis[] axes, public string[] resultNames, public ExperimentTrial[] trials)Parameters: experimentId: string, fingerprint: string, axes: ParameterAxis[], resultNames: string[], trials: ExperimentTrial[]
export record ExperimentRun(public string experimentId, public string fingerprint, public int trialCount, public string[] resultNames, public TrialOutcome[] outcomes, public int nextOrdinal, public bool complete)Parameters: experimentId: string, fingerprint: string, trialCount: int, resultNames: string[], outcomes: TrialOutcome[], nextOrdinal: int, complete: bool
export record ExperimentTrial(public int ordinal, public double[] parameters, public string experimentId)Parameters: ordinal: int, parameters: double[], experimentId: string
Experiments.integerAxis
export function integerAxis(string name, int[] values)->ParameterAxisParameters: name: string, values: int[]
Experiments.latinHypercubePlan
export function latinHypercubePlan(string experimentId, ParameterAxis[] axes, string[] resultNames, long seed, int count)->ExperimentPlanParameters: experimentId: string, axes: ParameterAxis[], resultNames: string[], seed: long, count: int
Experiments.numericAxis
export function numericAxis(string name, double[] values)->ParameterAxisParameters: name: string, values: double[]
export record ParameterAxis(public string name, public string kind, public double[] values, public string[] labels)Parameters: name: string, kind: string, values: double[], labels: string[]
Experiments.provenance
export function provenance(ExperimentDefinition definition, Checkpoint checkpoint)->ResultProvenanceParameters: definition: ExperimentDefinition, checkpoint: Checkpoint
Experiments.restoreRun
export function restoreRun(ExperimentPlan plan, string text)->ExperimentRunParameters: plan: ExperimentPlan, text: string
export record ResultProvenance(public string experimentId, public int seed, public string sourceDigest, public string dataIdentity, public string methodVersion, public int completedTrials, public bool complete)Parameters: experimentId: string, seed: int, sourceDigest: string, dataIdentity: string, methodVersion: string, completedTrials: int, complete: bool
export record ResultSummary(public string name, public int succeeded, public int failed, public double minimum, public double maximum, public double mean)Parameters: name: string, succeeded: int, failed: int, minimum: double, maximum: double, mean: double
Experiments.resumeAffine
export function resumeAffine(Sweep sweep, Checkpoint checkpoint, double leftScale, double rightScale, int budget) -> CheckpointParameters: sweep: Sweep, checkpoint: Checkpoint, leftScale: double, rightScale: double, budget: int
export function retryFailedExperimentRuns(ExperimentPlan plan, ExperimentRun run, TrialExecutor executor, string[] eligibleFailureCodes, int retryBudget, int maximumAdditionalAttempts) -> ExperimentRunParameters: plan: ExperimentPlan, run: ExperimentRun, executor: TrialExecutor, eligibleFailureCodes: string[], retryBudget: int, maximumAdditionalAttempts: int
Experiments.serializeRun
export function serializeRun(ExperimentRun run)->stringParameters: run: ExperimentRun
Experiments.startCheckpoint
export function startCheckpoint(Sweep sweep) -> CheckpointParameters: sweep: Sweep
Experiments.startRun
export function startRun(ExperimentPlan plan)->ExperimentRunParameters: plan: ExperimentPlan
export function summarizeExperimentFailures(ExperimentRun run) -> ExperimentFailureSummaryParameters: run: ExperimentRun
Experiments.summarizeResult
export function summarizeResult(ExperimentRun run, string resultName)->ResultSummaryParameters: run: ExperimentRun, resultName: string
Experiments.Sweep
export record Sweep(public Trial[] trials, public string experimentId)Parameters: trials: Trial[], experimentId: string
Experiments.Trial
export record Trial(public int ordinal, public double first, public double second, public string identity)Parameters: ordinal: int, first: double, second: double, identity: string
Experiments.TrialExecutor
export interface TrialExecutorExperiments.TrialOutcome
export record TrialOutcome(public int ordinal, public string state, public int attempts, public double[] results, public string failureCode, public string failureMessage)Parameters: ordinal: int, state: string, attempts: int, results: double[], failureCode: string, failureMessage: string
Documentation version
Language 1.0.0, compiler 1.0.0, runtime 1.0.0. This reference is generated from the official SS documentation so package and language details stay consistent with the release.