Metadata-Version: 2.5
Name: dlboard-client
Version: 0.2.1
Summary: A pytorch_lightning-compatible logger client for dlboard, a free, self-hosted experiment-tracking server.
Project-URL: Changelog, https://github.com/dlangerm/dlboard/blob/main/CHANGELOG.md
Project-URL: Documentation, https://github.com/dlangerm/dlboard#readme
Project-URL: Homepage, https://github.com/dlangerm/dlboard
Project-URL: Issues, https://github.com/dlangerm/dlboard/issues
Project-URL: Repository, https://github.com/dlangerm/dlboard
Author-email: David Langerman <dev.onyxzerosoftware@gmail.com>
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: experiment-tracking,logging,machine-learning,mlops,pytorch-lightning
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: coolname>=5.0.0
Requires-Dist: dltype>=0.16.0
Requires-Dist: numpy>=2.2.0
Requires-Dist: pendulum>=3.0.0
Requires-Dist: pillow>=10.0.0
Requires-Dist: pydantic-settings>=2.0.0
Requires-Dist: pydantic>=2.5.0
Requires-Dist: requests>=2.28.0
Requires-Dist: structlog>=23.1.0
Requires-Dist: typing-extensions>=4.5.0
Provides-Extra: lightning
Requires-Dist: pytorch-lightning>=2.0.0; extra == 'lightning'
Provides-Extra: server
Requires-Dist: dlboard; extra == 'server'
Description-Content-Type: text/markdown

# dlboard

A `pytorch_lightning`-compatible logger client for [dlboard](https://github.com/dlangerm/dlboard), a
free, self-hosted ML experiment-tracking server. This package ships metrics, hyperparameters, and
artifacts from a training script to a running dlboard server over a REST API.

```python
from dlboard.client.dlboard_logger import DLBoardLogger

logger = DLBoardLogger.from_names("my-project", "my-experiment", "a description")
trainer = pl.Trainer(logger=logger)
```

You'll also need a dlboard server to point it at — either `pip install dlboard[server]` for a
single-machine setup, or a shared deployment your team already runs. See the
[project README](https://github.com/dlangerm/dlboard#readme) for the full picture, and
[docs/client.md](https://github.com/dlangerm/dlboard/blob/main/docs/client.md) for logger setup,
authentication, and logging custom artifact types.
