runmonitor 0.2.0__py3-none-any.whl

runmonitor-0.2.0.dist-info/METADATA

@@ -0,0 +1,148 @@
+Metadata-Version: 2.4
+Name: runmonitor
+Version: 0.2.0
+Summary: Lean, local experiment tracker with a live, terminal-styled web dashboard.
+Author-email: bub4tz <ezgroupnl@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 k
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/empero-org/runmonitor
+Project-URL: Repository, https://github.com/empero-org/runmonitor
+Project-URL: Issues, https://github.com/empero-org/runmonitor/issues
+Keywords: machine-learning,experiment-tracking,metrics,dashboard,training,monitoring,mlops,tensorboard,wandb
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+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 :: System :: Monitoring
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flask>=2.0
+Provides-Extra: system
+Requires-Dist: psutil>=5.0; extra == "system"
+Dynamic: license-file
+
+# runmonitor
+
+Lean, local experiment tracker with a live, **terminal-styled** web dashboard. Import and go.
+
+```python
+import runmonitor as rm
+
+run = rm.init("my-experiment", config={"lr": 0.001, "batch_size": 32}, total_steps=1000)
+
+for step in range(1000):
+    loss, acc = train_step()
+    run.log({"loss": loss, "accuracy": acc}, step)
+    if step % 100 == 0:
+        run.save("checkpoint.pt")
+
+run.finish()
+```
+
+Open `http://localhost:8080` — your loss curve is already live and drawing itself.
+
+## Install
+
+```bash
+pip install runmonitor                 # core
+pip install "runmonitor[system]"       # + CPU/RAM tracking (psutil)
+```
+
+Then in any training script:
+
+```python
+import runmonitor as rm
+```
+
+Or run the dashboard on its own (no training script needed):
+
+```bash
+runmonitor                 # opens the dashboard in your browser
+python -m runmonitor       # equivalent, for a checkout/vendored copy
+RUNMONITOR_PORT=9000 runmonitor   # pick a port (set before launch)
+```
+
+## The dashboard
+
+A single, evolving view in the empero black/purple palette:
+
+| Element | What it shows |
+|---|---|
+| **Metric ticker** | Every logged metric as `key=value`. Click one to **select** it. |
+| **Live hero curve** | The selected metric, drawn point-by-point and growing every step. |
+| **Anomaly detection** | Rolling z-score flags spikes — vertical markers on the curve + a status line ("⚠ anomaly at step N" / "● all calm"). |
+| **Run header** | Run id, current step, status pill, elapsed, steps/sec, ETA, progress bar. |
+| **Streak / best badges** | 🔥 improving-streak and 🏆 personal-best on the selected metric (direction-aware). |
+| **Compare** | Pick a second run to overlay on the selected metric. |
+| **System pane** | CPU % and RAM % over time (needs `psutil`). |
+| **Hyperparameters / Artifacts** | Config passed to `rm.init()` and any saved files. |
+| **Export** | Download the full run as CSV or JSON. |
+| **Theme** | Midnight (black/purple) by default; toggle to light bone-paper. |
+
+## API
+
+```python
+# Start a run (creates the project if new)
+run = rm.init(project: str, name: str | None = None,
+              config: dict | None = None,
+              total_steps: int | None = None) -> Run
+
+run.log(metrics: dict[str, float], step: int)   # log metrics at a step
+run.save(filepath: str) -> dict                  # save an artifact file
+run.finish()                                     # mark finished
+run.fail()                                       # mark crashed
+```
+
+## Storage
+
+Everything lives in `~/.runmonitor/`:
+- `runs.db` — SQLite database (WAL mode, thread-safe)
+- `artifacts/<run_id>/` — saved files per run
+
+No database setup, no API keys, no cloud.
+
+## Requirements
+
+- Python 3.10+
+- Flask
+- Chart.js (loaded from CDN in the dashboard)
+- `psutil` (optional, for system metrics)
+
+## Publishing to PyPI (maintainers)
+
+```bash
+python -m pip install --upgrade build twine
+python -m build                 # → dist/runmonitor-<version>.tar.gz + .whl
+python -m twine check dist/*
+python -m twine upload dist/*   # needs a PyPI account + API token
+```
+
+Bump `version` in `pyproject.toml` before each release.

runmonitor-0.2.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+runmonitor/__init__.py,sha256=rRbMZ0n_4fzURs8rcqXgBVPnvbB1DG0WfEzobKgmV_w,4054
+runmonitor/__main__.py,sha256=8bihT_jm-_D1riuCctLlkLJoizaUylFKAUcco7G9CCo,1717
+runmonitor/server.py,sha256=lZbaYpJDI1NgyDELmFhwCZof_NnUpUnFmtLE8yPVdgI,4934
+runmonitor/storage.py,sha256=Xj3zbbAppyOj9tgW6b2yT5yMOh_4IR7pmsZibNdFj-s,7764
+runmonitor/static/style.css,sha256=9kdrhDCXV_gcoEELfdfTHwAVPYWBQufNd4vCzoM4DqA,12288
+runmonitor/templates/dashboard.html,sha256=ibcisoIM3m8Ug3xVRbnwYNDaJ5ZiZOLkQGo0MSA5PFg,25323
+runmonitor-0.2.0.dist-info/licenses/LICENSE,sha256=wI23uqCd_PcgxQPNrvHCp5eNcOG1xuVI_aJlLcBBDFY,1058
+runmonitor-0.2.0.dist-info/METADATA,sha256=MccZUtJzr85nmp2U-BTOwncWdG4lpwk8ns52evpvSzU,5680
+runmonitor-0.2.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+runmonitor-0.2.0.dist-info/entry_points.txt,sha256=JXpjs7SvT0j5AP-T4z_mjYgza2dv1fOu2mNhZxjXmL0,56
+runmonitor-0.2.0.dist-info/top_level.txt,sha256=vGsypUTmcngKNLMTli0houdYY--zLrjDKg885dBvHfA,11
+runmonitor-0.2.0.dist-info/RECORD,,

runmonitor-0.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

runmonitor-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+runmonitor = runmonitor.__main__:main

runmonitor-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 k
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

runmonitor-0.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+runmonitor