Skip to main content

Monitor AI training on your phone with a drop-in SummaryWriter replacement.

Project description

notiboard

notiboard is both the PyPI distribution name and the Python import package.

Monitor your AI training on your phone with a drop-in replacement for TensorBoard's SummaryWriter.

Installation

pip install notiboard

Quick Start

from notiboard import NotiWriter

writer = NotiWriter(
    log_dir="runs/experiment1",
    noti_api_key="nk_your_key_here",   # from the Noti app: Settings > API Keys
    noti_project="my-project",
    noti_run_name="experiment-001",    # optional, auto-generated if not set
)

for step in range(1000):
    loss = train_step()
    writer.add_scalar("loss/train", loss, step)
    writer.set_progress(step, 1000, f"Step {step}/1000")

writer.send_notification("Training complete", "Final loss: 0.001", "Done.")
writer.close()

All standard TensorBoard SummaryWriter methods are preserved. If PyTorch is installed, NotiWriter uses torch.utils.tensorboard. Otherwise it falls back to tensorboardX, which is included as a package dependency.

Configuration

Argument Env Variable Default Description
noti_api_key NOTI_API_KEY API key from the Noti app (required)
noti_server NOTI_SERVER https://notiapi.tech-webs.com Noti server URL
noti_project "default" Project name
noti_run_name Auto-generated Run name
noti_enabled NOTI_ENABLED 1 Set 0 to disable Noti sync
noti_complete_on_close True Mark the run as completed when close() is called

Release Files

This package is configured for standard PyPI release tooling:

python -m build
python -m twine check dist/*
python -m twine upload dist/*

There are helper scripts under sdk/scripts/ and a release checklist in sdk/RELEASING.md.

License

MIT

Project details


Download files

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

Source Distribution

notiboard-0.1.1.tar.gz (16.5 kB view details)

Uploaded Source

Built Distribution

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

notiboard-0.1.1-py3-none-any.whl (13.1 kB view details)

Uploaded Python 3

File details

Details for the file notiboard-0.1.1.tar.gz.

File metadata

  • Download URL: notiboard-0.1.1.tar.gz
  • Upload date:
  • Size: 16.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for notiboard-0.1.1.tar.gz
Algorithm Hash digest
SHA256 88242355b4a8f3ab0f91a6a9dd613bd119ef02f85ddb6def7f15188ca267cff7
MD5 bdf5c9a2e18978d5b72549c619d05082
BLAKE2b-256 48ad50f79a6cf10b84103e9676b6912e75178ca0399b46d56addcc0ebb979293

See more details on using hashes here.

File details

Details for the file notiboard-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: notiboard-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 13.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for notiboard-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8e703f8765e6c1ba48cf3758d0d13512d92c3c19e1ff77cac3ab497eab600d1c
MD5 69f0787da27037935f3edecd507d09be
BLAKE2b-256 8436469109ab11fa3690da8053484d5056fb01c49b474c8ef5a7426b52c2eaa3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page