Skip to content
OFFICIAL SS DOCUMENTATION

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
API 1.2.0
MIT
source

Language compatibility: >=1.0.0 <2.0.0
Runtime compatibility: >=1.0.0 <2.0.0

No package dependencies declared.

Public API

Public signature
export function cartesian(string experimentId, double[] first, double[] second) -> Sweep

Parameters: experimentId: string, first: double[], second: double[]


Public signature
export function cartesianPlan(string experimentId, ParameterAxis[] axes, string[] resultNames)->ExperimentPlan

Parameters: experimentId: string, axes: ParameterAxis[], resultNames: string[]


Public signature
export function categoricalAxis(string name, string[] labels)->ParameterAxis

Parameters: name: string, labels: string[]


Public signature
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


Public signature
export function checkpointExperimentBatch(ExperimentRun run) -> string

Parameters: run: ExperimentRun


Public signature
export function define(string identity, int seed, string sourceDigest, string dataIdentity, string methodVersion)->ExperimentDefinition

Parameters: identity: string, seed: int, sourceDigest: string, dataIdentity: string, methodVersion: string


Public signature
export function executeBudget(ExperimentPlan plan, ExperimentRun run, TrialExecutor executor, int budget, int maximumAttempts)->ExperimentRun

Parameters: plan: ExperimentPlan, run: ExperimentRun, executor: TrialExecutor, budget: int, maximumAttempts: int


Public signature
export function executeExperimentCallable(ExperimentPlan plan, ExperimentRun run, TrialExecutor executor, int budget, int maximumAttempts) -> ExperimentRun

Parameters: plan: ExperimentPlan, run: ExperimentRun, executor: TrialExecutor, budget: int, maximumAttempts: int


Public signature
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


Public signature
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[]


Public signature
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[]


Public signature
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


Public signature
export record ExperimentTrial(public int ordinal, public double[] parameters, public string experimentId)

Parameters: ordinal: int, parameters: double[], experimentId: string


Public signature
export function integerAxis(string name, int[] values)->ParameterAxis

Parameters: name: string, values: int[]


Public signature
export function latinHypercubePlan(string experimentId, ParameterAxis[] axes, string[] resultNames, long seed, int count)->ExperimentPlan

Parameters: experimentId: string, axes: ParameterAxis[], resultNames: string[], seed: long, count: int


Public signature
export function numericAxis(string name, double[] values)->ParameterAxis

Parameters: name: string, values: double[]


Public signature
export record ParameterAxis(public string name, public string kind, public double[] values, public string[] labels)

Parameters: name: string, kind: string, values: double[], labels: string[]


Public signature
export function provenance(ExperimentDefinition definition, Checkpoint checkpoint)->ResultProvenance

Parameters: definition: ExperimentDefinition, checkpoint: Checkpoint


Public signature
export function restoreRun(ExperimentPlan plan, string text)->ExperimentRun

Parameters: plan: ExperimentPlan, text: string


Public signature
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


Public signature
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


Public signature
export function resumeAffine(Sweep sweep, Checkpoint checkpoint, double leftScale, double rightScale, int budget) -> Checkpoint

Parameters: sweep: Sweep, checkpoint: Checkpoint, leftScale: double, rightScale: double, budget: int


Public signature
export function retryFailedExperimentRuns(ExperimentPlan plan, ExperimentRun run, TrialExecutor executor, string[] eligibleFailureCodes, int retryBudget, int maximumAdditionalAttempts) -> ExperimentRun

Parameters: plan: ExperimentPlan, run: ExperimentRun, executor: TrialExecutor, eligibleFailureCodes: string[], retryBudget: int, maximumAdditionalAttempts: int


Public signature
export function serializeRun(ExperimentRun run)->string

Parameters: run: ExperimentRun


Public signature
export function startCheckpoint(Sweep sweep) -> Checkpoint

Parameters: sweep: Sweep


Public signature
export function startRun(ExperimentPlan plan)->ExperimentRun

Parameters: plan: ExperimentPlan


Public signature
export function summarizeExperimentFailures(ExperimentRun run) -> ExperimentFailureSummary

Parameters: run: ExperimentRun


Public signature
export function summarizeResult(ExperimentRun run, string resultName)->ResultSummary

Parameters: run: ExperimentRun, resultName: string


Public signature
export record Sweep(public Trial[] trials, public string experimentId)

Parameters: trials: Trial[], experimentId: string


Public signature
export record Trial(public int ordinal, public double first, public double second, public string identity)

Parameters: ordinal: int, first: double, second: double, identity: string


Public signature
export interface TrialExecutor

Public signature
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.