Skip to main content

icefold-sdk

The slim, shared kernel for IceFold: the worker-control WebSocket protocol plus a small on-runner helper kit. It ships no node implementations — the server renders each node into a self-contained .py bundle and the icefold-runner imports the bundle on demand.

Import name: the distribution is icefold-sdk, but it installs as the top-level package icefold (like pyyamlimport yaml).

import icefold
print(icefold.__version__)

Both the IceFold server and the runner depend on this package: the server uses the wire / id / log surface to talk to its workers; the runner uses the same wire protocol to dial back, then imports server-rendered bundles to run jobs.

Surface

Module What
icefold.wire /v1/ws/worker frames, including optional CPU/GPU lane widths in runner hello: make_node_exec, make_worker_ready, make_missing_dep, binary_install_hint; constants (SRV_NODE_EXEC, SRV_WORKER_READY, WKR_NODE_DONE, …); worker output endpoint constant
icefold._logging Coloured stdout logger (log_info, log_warning, log_error, log_debug)
icefold.ids get_file_id() — time-ordered unique id for output filenames
icefold.config DATA_DIR / SCRATCH_BASE_DIR (driven by ICEFOLD_PROJECT_ROOT)
icefold.exceptions AppError family + MissingDependencyError
icefold.runtime run_blocking(fn, *a, **kw) + write_text(path, content) — off-event-loop IO helpers
icefold.__init__ Slim re-export: log_* / get_file_id / run_blocking / write_text

Install

pip install icefold-sdk           # runner-side helpers + wire protocol

Requires Python ≥ 3.11. This package is the shared protocol layer; if you want to run IceFold nodes on your own machine, install icefold-runner instead (it pulls this in).

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

icefold_sdk-0.1.8.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

icefold_sdk-0.1.8-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

Details for the file icefold_sdk-0.1.8.tar.gz.

File metadata

  • Download URL: icefold_sdk-0.1.8.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for icefold_sdk-0.1.8.tar.gz
Algorithm Hash digest
SHA256 dc2cb782be279fd8a930565618948e7b27d7a81c80517d6bd3ea82eb8c26bff5
MD5 e1bd073e6e5a73299d2a48f976886240
BLAKE2b-256 cb4774d24a5ea2775338ac3e9a5b31ecd76bb765b8b772eda10ddb9479f7023a

See more details on using hashes here.

File details

Details for the file icefold_sdk-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: icefold_sdk-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 14.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for icefold_sdk-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 6a997e95290dc0bb3caf180359e816c7540f797b9dd22731914f900ae181a743
MD5 8ae551ea0d9062c092a5a9a7683254be
BLAKE2b-256 3f629a9ff3d5e725bb49ff094db59f41fe31d70a7890c8360e6d180b21a64278

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.8 This release

2 files

0.1.7

2 files

0.1.6

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page