INTEGRATION

API coverage and documentation gaps

This site uses the published public API. It does not import training implementation code.

Public reference

Distributed Neural Training API ↗ · Get Started ↗

Connection

The training API is retrieved after loadWeei() resolves. The built-in window is not opened. If the API is unavailable, the application shows an error. The documented contract makes it available after loadWeei() when enabled for the site and user. The interface is explicitly hidden with setVisibility(false); this does not disable training.

Execution diagnostics

Compare actual backend, browser, Workers, assignment size, batch settings, and computation-only speed per participant. Expand each peer for model hashes, GPU availability, fallback reasons, assignment IDs, and stage durations. Unknown values are shown as missing; the GPU budget is not a measurement of memory usage. Snapshots are sent every 2 seconds and on stage changes. They are stale after 10 seconds or on disconnection.

Data displayed

Job state, dataset passes, participant states, pending invitations, live progress, transfer status, and checkpoint training/validation metrics use the published State interfaces. Metric labels and direction come from the selected model. Missing values are shown as unavailable, never as zero.

Model export and aggregation

Open in Playground uses exportModule() and exportCheckpoint(round). The module is available only when job.hasModuleFile is true. An empty checkpoint round selects the latest saved checkpoint. Dataset passes are sent as settings.epochs; rounds is the legacy name. FedAvg, FedAvgM and FedAdam use the documented aggregation settings and defaults.

Remaining documentation limits

The API does not document export of GPU execution files, external tokenizers or validation files. Playground includes currently selected local GPU/validation files; missing auxiliary files must be selected manually. Checkpoint versions 1 and 2 are supported. Playground validates weight and optimizer-state sizes, finite values and SHA-256 hashes, and loads only the weights for inference.

The optional WGSL archive is provided through the documented executionFiles field. Saved-job summaries and storage inventory are displayed as returned because their schemas are not specified. Commands validate the participant’s role and current state; API errors are displayed. Commands returning does not mean training has completed.

Verification limits

Connecting to the API does not prove model training. A complete run needs a compatible WASM model, its required dataset or experience package, and an enabled site origin. Check saved checkpoints and independent validation results before using trained weights.

Execution settings and experience jobs

Backend preference, local worker limit and GPU memory budget use setBackendPreference(), setMaxLocalWorkers() and setGpuMemoryBudgetMiB(). Actual execution comes from state.execution and job.localWorkers. The GPU budget is a limit, not memory usage. Experience setup reads workSource and auxiliaryWeights from the package manifest and sends settings.experience.unitsPerAssignment. settings.epochs counts rounds for these jobs.

Recording Demos integration

The FAQ reads listDemos(), refreshDemos() and subscribe() from widgetsApi.get('recording-demos'). A question calls play(id); Stop walkthrough calls stopPlayback(). Only the management button calls widgetsApi.enable('recording-demos') to open the built-in interface. This site does not implement its own recording format or player. The widget must be enabled for this site and user independently of Distributed Training.

Weei UI is hidden with setVisibility(false). Opening a widget can replace its API instance, so the FAQ retrieves the API again for each action and renews its subscription after opening management.

RL shader archive

For inputs: none, the dataset manifest is empty and no validation file is selected. An optional WGSL file must match the package’s shaderArchive. Pass it through executionFiles for GPU training; without it the package trains on the CPU. Weei validates the selected archive.

Recording Demos API ↗ · Client API ↗

Open training workspace · Open Playground