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.0.tar.gz (16.2 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.0-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: notiboard-0.1.0.tar.gz
  • Upload date:
  • Size: 16.2 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.0.tar.gz
Algorithm Hash digest
SHA256 d0be77cc1f6af052bf219986eb394e9286f2d817030cdc18d57c7caab2f99b49
MD5 ea94ca5d36a0381f5b73754013f762e4
BLAKE2b-256 7731d62dfbf4bb83b5b940009cdea14c987d5b2acbf1cd90734137fbe50c9b1e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: notiboard-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 12.8 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 08f292f1c6235a5d7e22698ba707bcdb3291866c1e73062a3da16ab2c6fbd6cc
MD5 642e94227edbfc90dc344b6986516b0d
BLAKE2b-256 4f1d92e420e668a074a79e17598481487fa81a726d6aa3c44b15e6a386466923

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