vibetrack 0.1.0__tar.gz

vibetrack-0.1.0/LICENSE

@@ -0,0 +1,183 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an Individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of submitting the Work,
+      but excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combined work of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or any patent
+      claims licensable by such Contributor constitute direct or contributory
+      patent infringement, then any patent licenses granted to You under
+      this License for that Work shall terminate as of the date such
+      litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or in addition to the
+          NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Derivative Works, and to permit persons to whom the Derivative Works
+      is furnished to do so.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Liability. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a fee
+      for, acceptance of support, warranty, indemnity, or other liability
+      obligations and/or rights consistent with this License. However, in
+      accepting such obligations, You may offer such obligations only on
+      Your own behalf and on Your sole responsibility, not on behalf of
+      any other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Sergei Chicherin
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

vibetrack-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+graft docs
+global-exclude __pycache__ *.pyc

vibetrack-0.1.0/PKG-INFO

@@ -0,0 +1,286 @@
+Metadata-Version: 2.4
+Name: vibetrack
+Version: 0.1.0
+Summary: Modern experiment tracking — drop-in compatible with TensorBoard SummaryWriter.
+Author-email: Sergei Chicherin <serenkiy@ieee.org>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/chroneus/vibetrack
+Project-URL: Bug Tracker, https://github.com/chroneus/vibetrack/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi>=0.100.0
+Requires-Dist: uvicorn[standard]>=0.20.0
+Requires-Dist: python-multipart>=0.0.5
+Requires-Dist: psutil>=5.9
+Provides-Extra: telegram
+Requires-Dist: python-telegram-bot>=20.0; extra == "telegram"
+Provides-Extra: all
+Requires-Dist: fastapi>=0.100.0; extra == "all"
+Requires-Dist: uvicorn[standard]>=0.20.0; extra == "all"
+Requires-Dist: python-multipart>=0.0.5; extra == "all"
+Requires-Dist: mcp>=1.0; python_version >= "3.10" and extra == "all"
+Requires-Dist: psutil>=5.9; extra == "all"
+Requires-Dist: numpy; extra == "all"
+Requires-Dist: Pillow; extra == "all"
+Requires-Dist: gradio<7,>=6.0; extra == "all"
+Requires-Dist: python-telegram-bot>=20.0; extra == "all"
+Requires-Dist: pytest>=7.0; extra == "all"
+Requires-Dist: pytest-cov>=4.0; extra == "all"
+Requires-Dist: httpx>=0.24.0; extra == "all"
+Dynamic: license-file
+
+# vibetrack
+
+Modern experiment tracking.
+
+![vibetrack showcase](https://raw.githubusercontent.com/chroneus/vibetrack/main/docs/showcase.gif)
+
+Key features:
+
+- Send experiment results elsewhere: Telegram, Slack, Jupyter, Gradio, and MCP.
+- Run locally while receiving experiment data over the network via REST API.
+- Use open formats: experiment data is stored in SQLite and local files.
+- Compare image-to-image results.
+- Use a rich UI to show, hide, delete, and customize runs.
+- TensorBoard SummaryWriter compatible drop-in APIs.
+- Query results through the MCP server.
+- Fast scalar logging; see the [benchmark report](https://github.com/chroneus/vibetrack/blob/main/docs/BENCHMARK.md).
+
+
+
+
+
+## Install
+
+```bash
+pip install vibetrack          # default with web
+pip install vibetrack[all]     # all optional backends+dev; MCP on Python >=3.10
+```
+
+## Quick start
+
+### TensorBoard-style API
+
+```python
+from vibetrack import SummaryWriter
+
+writer = SummaryWriter("runs/exp1", project_folder="my_project")
+for step in range(100):
+    writer.add_scalar("loss", 1.0 / (step + 1), step)
+    writer.add_scalar("acc", step / 100, step)
+writer.close()
+```
+See [API.md](https://github.com/chroneus/vibetrack/blob/main/docs/API.md) for SummaryWriter and module-level logging examples.
+
+### Launch the dashboard
+
+```bash
+vibetrack --listen 0.0.0.0:6116
+# -> Web UI on http://you_server:6116
+# -> MCP is also mounted when installed with vibetrack[all] on Python 3.10+
+```
+
+### Viewers and destinations syntax
+
+```python
+
+writer = SummaryWriter("runs/exp1", project_folder="my_project")
+writer.to("console").to("slack", every="15m")
+writer.to("remote", url="http://server:8080", token="devtoken")
+writer.add_scalar("loss", 0.5, step=0).to("telegram")
+```
+
+See [VIEWERS.md](https://github.com/chroneus/vibetrack/blob/main/docs/VIEWERS.md) for web, console, Slack, Telegram, Gradio,
+Jupyter, custom viewers, remote forwarding, credentials, and HTTP ingest.
+
+# vibetrack Architecture
+
+```mermaid
+flowchart TB
+  subgraph LOGGING["Experiment logging"]
+    direction TB
+    SW["SummaryWriter"]
+    ADD["add_(scalar|image|*)"]
+    SW --> ADD
+  end
+  subgraph REMOTE["remote HTTP logging"]
+    direction TB
+    TO_REMOTE[".to(#quot;remote#quot;)"]
+  end
+  VIBETRACK["vibetrack<br/>scalars • media • text"]
+  subgraph PERSIST["Persist"]
+    direction TB
+    DB_ROWS["scalars + text + metadata"]
+    DEFAULT_DB[("default DB<br/>~/.vibetrack/vibetrack.db")]
+    PROJECT_DB[("per project DB<br/>project_log_dir/vibetrack.db")]
+    MEDIA["media files<br/>project_log_dir/media"]
+    DB_ROWS --> DEFAULT_DB
+    DB_ROWS -.-> PROJECT_DB
+  end
+  DISPATCH[".to(viewer)"]
+  FANOUT["best-effort fanout"]
+  subgraph VIEWERS["live / summary viewers"]
+    direction TB
+    WEB["web<br/>(default)"]
+    CONSOLE["console"]
+    SLACK["slack"]
+    GRADIO["gradio"]
+    TELEGRAM["telegram"]
+    JUPYTER["jupyter"]
+    MCP["MCP"]
+    CUSTOM[".to(#quot;custom#quot;)"]
+  end
+
+  ADD --> VIBETRACK
+  TO_REMOTE -.-> VIBETRACK
+  VIBETRACK --> DB_ROWS
+  VIBETRACK --> MEDIA
+  ADD --> DISPATCH
+  DISPATCH --> FANOUT
+  FANOUT --> VIEWERS
+  DEFAULT_DB --> VIEWERS
+  PROJECT_DB -.-> VIEWERS
+  MEDIA --> VIEWERS
+
+  classDef logging fill:#fff4e6,stroke:#f59e0b,stroke-width:2px,color:#172033;
+  classDef code fill:#fff7ed,stroke:#f59e0b,stroke-width:1.5px,color:#172033,font-family:monospace;
+  classDef liveCode fill:#eef2ff,stroke:#6366f1,stroke-width:1.5px,color:#172033,font-family:monospace;
+  classDef event fill:#ffe4ec,stroke:#e11d48,stroke-width:2px,color:#172033;
+  classDef live fill:#eef2ff,stroke:#6366f1,stroke-width:2px,color:#172033;
+  classDef storage fill:#e7f8ef,stroke:#10b981,stroke-width:2px,color:#172033;
+  classDef optional fill:#f8fafc,stroke:#94a3b8,stroke-width:1.5px,stroke-dasharray:5 5,color:#64748b;
+  classDef optionalCode fill:#f8fafc,stroke:#94a3b8,stroke-width:1.5px,stroke-dasharray:5 5,color:#64748b,font-family:monospace;
+  classDef viewer fill:#f5e8ff,stroke:#a855f7,stroke-width:2px,color:#172033;
+
+  class SW,ADD code;
+  class TO_REMOTE optionalCode;
+  class VIBETRACK event;
+  class DISPATCH liveCode;
+  class FANOUT live;
+  class DB_ROWS,DEFAULT_DB,MEDIA storage;
+  class PROJECT_DB optional;
+  class WEB,CONSOLE viewer;
+  class SLACK,GRADIO,TELEGRAM,JUPYTER,MCP optional;
+  class CUSTOM optionalCode;
+```
+
+
+# FAQ
+
+## How do I collect results from another server?
+
+Run a vibetrack ingest server on the machine that should receive results:
+
+```bash
+vibetrack --listen 0.0.0.0:8080 --token devtoken --project-folder /srv/runs
+```
+
+Then forward events from the training machine:
+
+```python
+from vibetrack import SummaryWriter
+
+writer = SummaryWriter("runs/exp1", project_folder="my_project")
+writer.to("remote", url="http://server:8080", token="devtoken")
+```
+
+See [VIEWERS.md](https://github.com/chroneus/vibetrack/blob/main/docs/VIEWERS.md#remote-event-forwarding) for remote forwarding
+and direct HTTP ingest.
+
+## How do I use separate databases on one machine?
+
+By default, vibetrack writes to `~/.vibetrack/vibetrack.db`. Pass
+`project_folder` to keep a separate `vibetrack.db` inside that project folder.
+
+```python
+from vibetrack import SummaryWriter
+
+writer = SummaryWriter("runs/exp1", project_folder="projects/cv")
+```
+
+Open that database in the dashboard with the same folder:
+
+```bash
+vibetrack --project-folder projects/cv
+```
+
+## How does vibetrack work with distributed training?
+
+vibetrack automatically detects `RANK` / `LOCAL_RANK`. Only rank 0 logs by
+default; other ranks get a silent no-op writer.
+
+```python
+from vibetrack import SummaryWriter
+
+writer = SummaryWriter("runs/distributed", project_folder="project/")
+writer.add_scalar("loss", loss.item(), step)
+writer.close()
+```
+
+To force every rank to log, pass `rank="all"`:
+
+```python
+writer = SummaryWriter("runs/distributed", rank="all")
+```
+
+## Can vibetrack collect system resources?
+
+Yes. vibetrack can collect CPU, GPU, memory, and project disk metrics in a
+background thread.
+
+```python
+writer = SummaryWriter("runs/exp1", system_metrics_interval=3600)  # every hour
+```
+
+Collected metrics include `system/cpu_percent`, `system/mem_used_gb`,
+`system/disk_free_gb`, `gpu/utilization`, `gpu/memory_used_gb`, and
+`gpu/temperature`. Use `system_metrics_interval=0` to disable collection.
+
+## How do I run the MCP server for an LLM agent?
+
+Install MCP dependencies, then run the standalone MCP server:
+
+```bash
+pip install vibetrack[all]
+vibetrack --viewer mcp --project-folder my_project/
+```
+
+See [MCP.md](https://github.com/chroneus/vibetrack/blob/main/docs/MCP.md) for MCP endpoints, tools, resources, and agent usage.
+
+## What CLI commands are available?
+
+```bash
+vibetrack                           # default
+vibetrack [PROJECT_FOLDER]          # Launch dashboard (web + ingest; MCP with vibetrack[all] on Python 3.10+)
+vibetrack --port 8080               # Custom port
+vibetrack --token SECRET            # Protect ingest endpoints
+vibetrack --listen 0.0.0.0:9009     # Open server on separate port
+vibetrack migrate PROJECT_FOLDER    # Merge legacy per-run DBs into project DB
+```
+
+## How is vibetrack configured?
+
+Settings are stored in `~/.vibetrack/config.json`. The web UI can also write
+project-scoped settings through its Settings tab.
+
+```json
+{
+  "smoothing": "ema",
+  "smooth_weight": 0.6,
+  "system_metrics_interval": 3600,
+  "web": {
+    "theme": "light",
+    "auto_refresh": 5,
+    "image_play_fps": 2,
+    "original_values_opacity": 0.17
+  }
+}
+```
+
+## License
+
+Apache 2.0