Skip to content
OFFICIAL SS DOCUMENTATION

SS.Distributed 1.3.0

Canonical bounded and per-worker authorized TCP envelope exchange; communicators, validated Linux remote-worker launch observations, cluster barriers, authorized scatter/gather, versioned halo exchange, declared distributed execution with node-local fallback, deterministic worker lifecycle/failure observations, partitions, checkpoint recovery, scheduling metadata, ordered result validation, and portable host plans
API 1.3.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 affinePartition(double[] localValues, double scale, double offset)->DistributedResult

Parameters: localValues: double[], scale: double, offset: double


Public signature
export function allPartitions(int globalCount, int workers, int haloWidth)->Partition1D[]

Parameters: globalCount: int, workers: int, haloWidth: int


Public signature
export function allReduceSum(double[] rankValues, int workers)->Collective

Parameters: rankValues: double[], workers: int


Public signature
export function assign(TaskRequirement task, WorkerCapability[] workers)->ScheduleAssignment

Parameters: task: TaskRequirement, workers: WorkerCapability[]


Public signature
export record AuthorizedEnvelope(public string schema, public TransportEnvelope message, public string workerId, public long generation, public string nonce, public string authorizationTag)

Parameters: schema: string, message: TransportEnvelope, workerId: string, generation: long, nonce: string, authorizationTag: string


Public signature
export function authorizeEnvelope(TransportEnvelope message, string workerId, long generation, string nonce, string authorizationTag)->AuthorizedEnvelope

Parameters: message: TransportEnvelope, workerId: string, generation: long, nonce: string, authorizationTag: string


Public signature
export function broadcast(double[] rootValues, int rootRank, int workers)->Collective

Parameters: rootValues: double[], rootRank: int, workers: int


Public signature
export function cancelWorker(WorkerState worker)->WorkerState

Parameters: worker: WorkerState


Public signature
export function checkpoint(string jobId, int completedEpoch, int totalEpochs, double[] state, string sourceDigest)->DistributedCheckpoint

Parameters: jobId: string, completedEpoch: int, totalEpochs: int, state: double[], sourceDigest: string


Public signature
export function clusterBarrier(Communicator context, WorkerObservation[] participants, long barrierEpoch, long heartbeatDeadline)->ClusterBarrierResult

Parameters: context: Communicator, participants: WorkerObservation[], barrierEpoch: long, heartbeatDeadline: long


Public signature
export record ClusterBarrierResult(public long epoch, public int participants, public int arrived, public bool complete, public string diagnostic)

Parameters: epoch: long, participants: int, arrived: int, complete: bool, diagnostic: string


Public signature
export record ClusterKit(public string schema, public string packageVersion, public string runtimeTarget, public string launchCommand, public string manifestDigest, public bool requiresHostTransport, public string licensingBoundary)

Parameters: schema: string, packageVersion: string, runtimeTarget: string, launchCommand: string, manifestDigest: string, requiresHostTransport: bool, licensingBoundary: string


Public signature
export record Collective(public string operation, public double[] values, public int participants, public bool deterministic)

Parameters: operation: string, values: double[], participants: int, deterministic: bool


Public signature
export function communicator(string jobId, int size, long generation, string authorizationId)->Communicator

Parameters: jobId: string, size: int, generation: long, authorizationId: string


Public signature
export record Communicator(public string schema, public string jobId, public int size, public long generation, public string authorizationId)

Parameters: schema: string, jobId: string, size: int, generation: long, authorizationId: string


Public signature
export function distributedAffineSweep(double[] parameters, double scale, double offset, int workers)->DistributedResult

Parameters: parameters: double[], scale: double, offset: double, workers: int


Public signature
export record DistributedCheckpoint(public string schema, public string jobId, public int completedEpoch, public int totalEpochs, public double[] state, public string sourceDigest)

Parameters: schema: string, jobId: string, completedEpoch: int, totalEpochs: int, state: double[], sourceDigest: string


Public signature
export function distributedExecute(Communicator context, WorkerObservation[] workers, string operation, double[] values, double scale, double offset)->RemoteExecution

Parameters: context: Communicator, workers: WorkerObservation[], operation: string, values: double[], scale: double, offset: double


Public signature
export record DistributedGather(public double[] values, public int participants, public bool cancelled, public bool complete, public string diagnostic)

Parameters: values: double[], participants: int, cancelled: bool, complete: bool, diagnostic: string


Public signature
export record DistributedHaloExchange(public Halo[] halos, public long version, public int exchangedValues, public bool ordered, public string diagnostic)

Parameters: halos: Halo[], version: long, exchangedValues: int, ordered: bool, diagnostic: string


Public signature
export record DistributedResult(public double[] values, public int partitions, public int exchangedValues, public string algorithm)

Parameters: values: double[], partitions: int, exchangedValues: int, algorithm: string


Public signature
export record DistributedScatter(public Partition1D[] partitions, public TransportEnvelope[] messages, public int values, public string checksum)

Parameters: partitions: Partition1D[], messages: TransportEnvelope[], values: int, checksum: string


Public signature
export function envelope(string jobId, int sourceRank, int targetRank, int workers, int tag, long sequence, double[] payload, string checksum)->TransportEnvelope

Parameters: jobId: string, sourceRank: int, targetRank: int, workers: int, tag: int, sequence: long, payload: double[], checksum: string


Public signature
export function exchangeDistributedHalos(Communicator context, Partition1D[] partitions, double[][] localValues, long version)->DistributedHaloExchange

Parameters: context: Communicator, partitions: Partition1D[], localValues: double[][], version: long


Public signature
export function gatherDistributed(Communicator context, AuthorizedEnvelope[] results, int targetRank, int tag, long firstSequence, string checksum, string[] workerIds, string[] nonces, string[] authorizationTags, bool cancelled)->DistributedGather

Parameters: context: Communicator, results: AuthorizedEnvelope[], targetRank: int, tag: int, firstSequence: long, checksum: string, workerIds: string[], nonces: string[], authorizationTags: string[], cancelled: bool


Public signature
export record Halo(public bool hasLeft, public double left, public bool hasRight, public double right)

Parameters: hasLeft: bool, left: double, hasRight: bool, right: double


Public signature
export function haloFromGlobal(double[] globalValues, Partition1D partition)->Halo

Parameters: globalValues: double[], partition: Partition1D


Public signature
export function heartbeat(WorkerState worker, long value)->WorkerState

Parameters: worker: WorkerState, value: long


Public signature
export function launchRemoteWorkers(RemoteLaunchPlan plan, WorkerObservation[] processObservations, long expectedGeneration)->RemoteWorkerLaunchResult

Parameters: plan: RemoteLaunchPlan, processObservations: WorkerObservation[], expectedGeneration: long


Public signature
export function observeWorker(WorkerState worker, int exitCode, long observedHeartbeat, long heartbeatDeadline)->WorkerObservation

Parameters: worker: WorkerState, exitCode: int, observedHeartbeat: long, heartbeatDeadline: long


Public signature
export function orderedPayloads(TransportEnvelope[] values, string jobId, int targetRank, int tag, int workers, long firstSequence, string checksum)->double[]

Parameters: values: TransportEnvelope[], jobId: string, targetRank: int, tag: int, workers: int, firstSequence: long, checksum: string


Public signature
export function partition1d(int globalCount, int workers, int rank, int haloWidth)->Partition1D

Parameters: globalCount: int, workers: int, rank: int, haloWidth: int


Public signature
export record Partition1D(public int rank, public int workers, public int globalCount, public int offset, public int count, public int halo, public int ghostStart, public int ghostEnd)

Parameters: rank: int, workers: int, globalCount: int, offset: int, count: int, halo: int, ghostStart: int, ghostEnd: int


Public signature
export function portableKit(string runtimeTarget, string launchCommand, string manifestDigest)->ClusterKit

Parameters: runtimeTarget: string, launchCommand: string, manifestDigest: string


Public signature
export function prefixScan(double[] rankValues, int workers)->Collective

Parameters: rankValues: double[], workers: int


Public signature
export function receiveAuthorizedEnvelopesAt(string address, int port, int backlog, int workers, string expectedJob, int expectedTarget, int expectedTag, long firstSequence, string expectedChecksum, long expectedGeneration, string[] expectedWorkerIds, string[] expectedNonces, string[] expectedAuthorizationTags, int timeoutMilliseconds)->AuthorizedEnvelope[]

Parameters: address: string, port: int, backlog: int, workers: int, expectedJob: string, expectedTarget: int, expectedTag: int, firstSequence: long, expectedChecksum: string, expectedGeneration: long, expectedWorkerIds: string[], expectedNonces: string[], expectedAuthorizationTags: string[], timeoutMilliseconds: int


Public signature
export function receiveEnvelopesAt(string address, int port, int backlog, int count, int workers, string expectedJob, int expectedTarget, int expectedTag, long firstSequence, string expectedChecksum, int timeoutMilliseconds)->TransportEnvelope[]

Parameters: address: string, port: int, backlog: int, count: int, workers: int, expectedJob: string, expectedTarget: int, expectedTag: int, firstSequence: long, expectedChecksum: string, timeoutMilliseconds: int


Public signature
export function recover(DistributedCheckpoint saved, int requestedWorkers, int failedWorkers, bool cancelled, string expectedDigest)->RecoveryDecision

Parameters: saved: DistributedCheckpoint, requestedWorkers: int, failedWorkers: int, cancelled: bool, expectedDigest: string


Public signature
export record RecoveryDecision(public string action, public int resumeEpoch, public int survivingWorkers, public bool safe, public string diagnostic)

Parameters: action: string, resumeEpoch: int, survivingWorkers: int, safe: bool, diagnostic: string


Public signature
export function reduceSum(double[] rankValues, int workers)->Collective

Parameters: rankValues: double[], workers: int


Public signature
export function relaunchWorker(WorkerObservation failed, int workers, long nextGeneration, long heartbeat)->WorkerState

Parameters: failed: WorkerObservation, workers: int, nextGeneration: long, heartbeat: long


Public signature
export record RemoteExecution(public DistributedResult result, public string mode, public int workers, public bool remoteSideEffects, public string diagnostic)

Parameters: result: DistributedResult, mode: string, workers: int, remoteSideEffects: bool, diagnostic: string


Public signature
export function remoteLaunchPlan(Communicator context, string coordinatorHost, RemoteWorkerSpec[] workers, int startupTimeoutMilliseconds, bool isolatedNodes, bool encryptedHostChannel)->RemoteLaunchPlan

Parameters: context: Communicator, coordinatorHost: string, workers: RemoteWorkerSpec[], startupTimeoutMilliseconds: int, isolatedNodes: bool, encryptedHostChannel: bool


Public signature
export record RemoteLaunchPlan(public string schema, public Communicator communicator, public string coordinatorHost, public RemoteWorkerSpec[] workers, public int startupTimeoutMilliseconds, public bool isolatedNodes, public bool encryptedHostChannel)

Parameters: schema: string, communicator: Communicator, coordinatorHost: string, workers: RemoteWorkerSpec[], startupTimeoutMilliseconds: int, isolatedNodes: bool, encryptedHostChannel: bool


Public signature
export function remoteWorker(string workerId, int rank, int workers, string host, int port, string operatingSystem, string launcher, string launchCommand, string artifactDigest, string authorizationId)->RemoteWorkerSpec

Parameters: workerId: string, rank: int, workers: int, host: string, port: int, operatingSystem: string, launcher: string, launchCommand: string, artifactDigest: string, authorizationId: string


Public signature
export record RemoteWorkerLaunchResult(public WorkerObservation[] workers, public int launched, public bool authenticated, public bool running, public string diagnostic)

Parameters: workers: WorkerObservation[], launched: int, authenticated: bool, running: bool, diagnostic: string


Public signature
export record RemoteWorkerSpec(public string workerId, public int rank, public string host, public int port, public string operatingSystem, public string launcher, public string launchCommand, public string artifactDigest, public string authorizationId)

Parameters: workerId: string, rank: int, host: string, port: int, operatingSystem: string, launcher: string, launchCommand: string, artifactDigest: string, authorizationId: string


Public signature
export function scatterDistributed(Communicator context, double[] values, int haloWidth, int tag, long firstSequence, string checksum)->DistributedScatter

Parameters: context: Communicator, values: double[], haloWidth: int, tag: int, firstSequence: long, checksum: string


Public signature
export record ScheduleAssignment(public string taskId, public string workerId, public bool assigned, public string diagnostic)

Parameters: taskId: string, workerId: string, assigned: bool, diagnostic: string


Public signature
export function sendAuthorizedEnvelopeTo(string host, int port, int timeoutMilliseconds, AuthorizedEnvelope value, int workers)->bool

Parameters: host: string, port: int, timeoutMilliseconds: int, value: AuthorizedEnvelope, workers: int


Public signature
export function sendEnvelopeTo(string host, int port, int timeoutMilliseconds, TransportEnvelope value, int workers)->bool

Parameters: host: string, port: int, timeoutMilliseconds: int, value: TransportEnvelope, workers: int


Public signature
export function startWorker(string workerId, int rank, int workers, long generation, long heartbeat)->WorkerState

Parameters: workerId: string, rank: int, workers: int, generation: long, heartbeat: long


Public signature
export function stencilPartition(double[] localValues, Partition1D partition, Halo halo)->DistributedResult

Parameters: localValues: double[], partition: Partition1D, halo: Halo


Public signature
export function stencilStep(double[] globalValues, int workers)->DistributedResult

Parameters: globalValues: double[], workers: int


Public signature
export function stopWorker(WorkerState worker)->WorkerState

Parameters: worker: WorkerState


Public signature
export function supercomputingExecute(Communicator context, WorkerObservation[] workers, bool clusterAuthorized, string operation, double[] values, double scale, double offset)->RemoteExecution

Parameters: context: Communicator, workers: WorkerObservation[], clusterAuthorized: bool, operation: string, values: double[], scale: double, offset: double


Public signature
export record TaskRequirement(public string taskId, public int minimumThreads, public long minimumMemoryBytes, public string accelerator, public int priority)

Parameters: taskId: string, minimumThreads: int, minimumMemoryBytes: long, accelerator: string, priority: int


Public signature
export record TransportEnvelope(public string schema, public string jobId, public int sourceRank, public int targetRank, public int tag, public long sequence, public double[] payload, public string checksum)

Parameters: schema: string, jobId: string, sourceRank: int, targetRank: int, tag: int, sequence: long, payload: double[], checksum: string


Public signature
export function validateAuthorizedEnvelope(AuthorizedEnvelope value, int workers, string expectedChecksum, string expectedWorkerId, long expectedGeneration, string expectedNonce, string expectedAuthorizationTag)->bool

Parameters: value: AuthorizedEnvelope, workers: int, expectedChecksum: string, expectedWorkerId: string, expectedGeneration: long, expectedNonce: string, expectedAuthorizationTag: string


Public signature
export function validateEnvelope(TransportEnvelope value, int workers, string expectedChecksum)->bool

Parameters: value: TransportEnvelope, workers: int, expectedChecksum: string


Public signature
export record WorkerCapability(public string workerId, public int cpuThreads, public long memoryBytes, public string accelerator, public string operatingSystem, public string identity)

Parameters: workerId: string, cpuThreads: int, memoryBytes: long, accelerator: string, operatingSystem: string, identity: string


Public signature
export record WorkerObservation(public string workerId, public int rank, public long generation, public string state, public long heartbeat, public int exitCode, public bool relaunchAllowed, public string diagnostic)

Parameters: workerId: string, rank: int, generation: long, state: string, heartbeat: long, exitCode: int, relaunchAllowed: bool, diagnostic: string


Public signature
export record WorkerState(public string workerId, public int rank, public string state, public long generation, public long heartbeat, public bool cancelled)

Parameters: workerId: string, rank: int, state: string, generation: long, heartbeat: long, cancelled: bool


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.