W&B Core Library
Project description
W&B Nexus: the New "Bones" for the W&B SDK
What is Nexus
Greetings, developers!
What is W&B Nexus? At the highest level, Nexus is the new "bones" for the W&B SDK.
Why would anyone care and want to use it? There are numerous reasons, but here are just two:
- It's faster. A lot faster. We're talking 10x faster for some operations.
- It enables clean multi-language support.
For those technical folks out there, nexus
is a Golang reimplementation of the W&B SDK
internal process, wandb service
, based on the lessons learned from the original implementation(s),
but starting from a clean slate.
Installation
To install Nexus, you will need to run the following commands:
pip install "wandb[nexus]==0.16.0b1"
Supported Platforms
Nexus is currently supported on the following platforms:
- Linux:
x86_64
,aarch64
- macOS:
x86_64
,arm64
- Windows
amd64
If you are using a different platform, you can build Nexus from source by following the instructions in the contributing guide. Please also open a GitHub issue to let us know that you are interested in using Nexus on your platform, and we will prioritize adding support for it.
Usage example
While Nexus is still in development, you need to explicitly opt in to use it.
import wandb
wandb.require("nexus")
# Your code here using the W&B SDK
Contributing
Please read our contributing guide to learn to set up your development environment and how to contribute to the codebase.
Feedback
Please give Nexus a try and let us know what you think, we believe it is worth it!
We are very much looking forward for your feedback, especially bug reports. Please open a GitHub issue if you encounter an error and mention that you are using Nexus.
Feature Parity Status
The following table shows the status of feature parity
between the current W&B SDK and Nexus for version 0.16.0b1
.
Status legend:
- ✅: Available: The feature is relatively stable and ready for use.
- 🚧: In Development: The feature is available, but may be unstable or incomplete.
- ❌: Not Available: The feature is not yet available.
Category | Feature | Status |
---|---|---|
Experiments | ||
init |
✅[^E.1][^E.10][^E.11] | |
log |
✅[^E.2] | |
log_artifact |
❌[^E.3] | |
log_code |
❌[^E.4] | |
config |
✅ | |
summary |
✅ | |
define_metric |
🚧[^E.5] | |
tags |
✅ | |
notes |
✅ | |
name |
✅ | |
alert |
✅ | |
save |
🚧[^E.6] | |
restore |
✅ | |
mark_preempting |
✅ | |
resume | ✅ | |
reinit | ✅ | |
Media | 🚧[^E.7] | |
Grouping | ✅ | |
anonymous mode | ✅ | |
offline mode | ✅ | |
disabled mode | ✅ | |
multiprocessing | ✅ | |
TensorBoard sync | ❌ | |
console logging | 🚧[^E.8] | |
system metrics | 🚧[^E.9] | |
system info | ✅ | |
code saving | 🚧[^E.11] | |
Settings | 🚧[^E.12] | |
Login | ||
default entity | ✅ | |
team entity | ✅ | |
service account | ✅ | |
CLI | 🚧[^CLI.1] | |
Artifacts | ❌[^A.1] | |
Launch | ❌[^L.1] | |
Sweeps | 🚧[^S.1] |
[^E.1]: sync_tensorboard
requires TensorBoard support.
[^E.2]: wandb.Table
is not supported. Requires Artifacts support.
[^E.3]: log_artifact
is not yet supported. Requires Artifacts support.
[^E.4]: log_code
is not yet supported. Requires Artifacts support.
[^E.5]: define_metric
only supports default summary.
[^E.6]: save
only support now
and end
policy. live
policy will be treated as end
.
[^E.7]: wandb.Table
is not supported. Requires Artifacts support.
[^E.8]: Only raw console logging is supported.
[^E.9]: Supported system metrics: CPU, Memory, Disk, Network, NVIDIA GPU.
[^E.10]: The "live" policy is not yet supported, it will be treated as "end".
[^E.11]: Automatic code saving in Notebooks is not yet supported. Requires Artifacts support.
[^E.12]: TODO: list unsupported settings.
(anonymous
, _flow_control*
, _stats_open_metrics_endpoints
, ...)
[^CLI.1]: The CLI works, but uses the current Python backend under the hood for some
commands. Expect the CLI to be rewritten to use the new backend.
[^A.1]: Artifacts support is not yet available. Expect Artifacts to be supported soon.
[^L.1]: Launch is not yet supported. Requires Artifacts support.
[^S.1]: Requires verification.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
File details
Details for the file wandb_core-0.16.0b1-py3-none-win_amd64.whl
.
File metadata
- Download URL: wandb_core-0.16.0b1-py3-none-win_amd64.whl
- Upload date:
- Size: 4.1 MB
- Tags: Python 3, Windows x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f852448a48cea1e57586163bc16776a815cedf670440bb4bb6a8cf0f73fc0416 |
|
MD5 | 044b2804e1c67993fd155b7462819ee6 |
|
BLAKE2b-256 | 07560d784f4c0af701e7c83dc1f840bfe1f9c209ca825c6eb6a3a65f75b0e2d6 |
File details
Details for the file wandb_core-0.16.0b1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
.
File metadata
- Download URL: wandb_core-0.16.0b1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
- Upload date:
- Size: 3.7 MB
- Tags: Python 3, manylinux: glibc 2.17+ ARM64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0c8415dc6e8c30c3b98dae11abad0bacf8d8efe7fef48fe05c05d34228999055 |
|
MD5 | dd780f5be1b11b980924a89b4922a6b3 |
|
BLAKE2b-256 | bc96d8cf807eda83e343a36f72b7ca9ed02fa7de66360dcfcbd189424a2d95b7 |
File details
Details for the file wandb_core-0.16.0b1-py3-none-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl
.
File metadata
- Download URL: wandb_core-0.16.0b1-py3-none-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl
- Upload date:
- Size: 4.1 MB
- Tags: Python 3, manylinux: glibc 2.17+ x86-64, manylinux: glibc 2.5+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 42e61ac3214986a8351b029f047a0572c51b39afe384625fe98ad7bceef404bd |
|
MD5 | 74d5fcfd178dbceb20d8b12a6c853213 |
|
BLAKE2b-256 | ad8122b7da9a9e0640c2c0ec526d94501fa26b742fcb066c920c79c3d0aa0800 |
File details
Details for the file wandb_core-0.16.0b1-py3-none-macosx_11_0_arm64.whl
.
File metadata
- Download URL: wandb_core-0.16.0b1-py3-none-macosx_11_0_arm64.whl
- Upload date:
- Size: 4.2 MB
- Tags: Python 3, macOS 11.0+ ARM64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 194b4beb1cd752a737ffa4ff694616e738f021966d823007b72daded8945adf2 |
|
MD5 | d20a2df4dcdaacc3230e826f1597f63a |
|
BLAKE2b-256 | 37f67d4c0e4f399f54904032418c516c2f74a807fb6d821ab81f020759a505c0 |
File details
Details for the file wandb_core-0.16.0b1-py3-none-macosx_10_9_x86_64.whl
.
File metadata
- Download URL: wandb_core-0.16.0b1-py3-none-macosx_10_9_x86_64.whl
- Upload date:
- Size: 4.2 MB
- Tags: Python 3, macOS 10.9+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb205461be53d3d7be07f9a2617ca2655d80d109b90f8133b68374607b84644e |
|
MD5 | a8a8831a60a3ff84c67305d629b42aa3 |
|
BLAKE2b-256 | 80241035c1d510bee2a8737b38cb7673256b169c610f23786b8783aebfd43642 |