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.2.tar.gz (16.7 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.2-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: notiboard-0.1.2.tar.gz
  • Upload date:
  • Size: 16.7 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.2.tar.gz
Algorithm Hash digest
SHA256 742a9baf183d2c2f7496052a73c8feef28f9700e5cfb6600740e9abc147b7287
MD5 95a7d90be6561bf0b2e7f80cdfa89dd4
BLAKE2b-256 c8d478f60b0840c05e1c67d101eb0712b82a1bb9549864db0f4b4621e01f80e6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: notiboard-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 13.3 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 751e632182c3aedd05f37f79913dffddfc531f2903e49a88ad3fe1f8a0881be6
MD5 cd05cafed964df7f9b25afc48fccd605
BLAKE2b-256 7ddfa3baab9f81ae3e02421770adb6fabbc4bdcd904515c26b4994b8cb565433

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