vibetrack 0.1a0__tar.gz

vibetrack-0.1a0/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.1a0/PKG-INFO

@@ -0,0 +1,479 @@
+Metadata-Version: 2.4
+Name: vibetrack
+Version: 0.1a0
+Summary: Lightweight experiment tracking — drop-in compatible with TensorBoard and W&B APIs.
+Author-email: Sergei Chicherin <serenkiy@ieee.org>
+License:                                  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.
+        
+Project-URL: Homepage, https://github.com/chroneus/vibetrack
+Project-URL: Bug Tracker, https://github.com/chroneus/vibetrack/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+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: mcp>=1.0
+Requires-Dist: psutil>=5.9
+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; extra == "all"
+Requires-Dist: psutil>=5.9; extra == "all"
+Requires-Dist: gradio>=3.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
+
+Lightweight experiment tracking — drop-in compatible with TensorBoard and W&B APIs.
+
+No cloud. No account. No signup. Just a single SQLite file.
+
+## Why vibetrack?
+
+| | TensorBoard | W&B | vibetrack |
+|---|---|---|---|
+| Storage | tfevents files | Cloud (paid tiers) | Single SQLite DB |
+| Account required | No | Yes | No |
+| AI agent integration (MCP) | No | No | Built-in |
+| Distributed torchrun support | Manual | Manual | Automatic (rank-0 only) |
+| Single-port server (web + API + ingest) | No | N/A | Yes |
+| Viewer backends | Web only | Web only | Web, Gradio, Telegram, Console, MCP |
+| System metrics | Via plugin | Built-in | Built-in (CPU, GPU, memory, disk) |
+| Remote HTTP logging | No | Yes (cloud) | Yes (self-hosted, token auth) |
+| Zero mandatory dependencies | No | No | Yes |
+
+## Install
+
+```bash
+pip install vibetrack          # default
+pip install vibetrack[all]     # all optional backends
+```
+
+## 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()
+```
+
+### W&B-style API
+
+```python
+import vibetrack
+
+vibetrack.init(project="my_project", name="run_1", config={"lr": 0.01, "epochs": 50})
+for step in range(100):
+    vibetrack.log({"loss": 1.0 / (step + 1), "acc": step / 100})
+vibetrack.finish()
+```
+
+### Launch the dashboard
+
+```bash
+vibetrack 
+# -> Web UI + MCP server + ingest endpoint on http://0.0.0.0:6006
+```
+
+## API reference
+
+### SummaryWriter
+
+```python
+from vibetrack import SummaryWriter
+
+writer = SummaryWriter("runs/exp1", name="experiment_name", project_folder="project/")
+
+# Scalars
+writer.add_scalar("loss", 0.5, step=0)
+writer.add_scalars("metrics", {"train_loss": 0.5, "val_loss": 0.6}, step=0)
+
+# Images — accepts file paths, numpy arrays, or PIL Images
+writer.add_image("samples", "path/to/image.png", step=0)
+
+# Audio — accepts file paths or numpy waveforms
+writer.add_audio("speech", waveform_array, step=0, sample_rate=16000)
+
+# Video
+writer.add_video("rollout", "path/to/video.mp4", step=0)
+
+# Artifacts — any file with optional metadata
+writer.add_artifact("checkpoint", "model.pt", step=0, metadata={"val_acc": 0.95})
+
+# Text
+writer.add_text("notes", "Training started with lr=0.01", step=0)
+
+# Histograms
+writer.add_histogram("weights", weight_tensor, step=0)
+
+# Hyperparameters
+writer.add_hparams({"lr": 0.01, "batch_size": 32}, {"best_acc": 0.95})
+
+writer.close()
+```
+
+### W&B-compatible module API
+
+```python
+import vibetrack
+from vibetrack import Image, Audio, Video, Artifact
+
+vibetrack.init(project="nlp", name="bert-finetune", config={"lr": 3e-5})
+
+# Log scalars
+vibetrack.log({"loss": 0.3, "acc": 0.92})
+
+# Log media with wrapper types
+vibetrack.log({"sample": Image("output.png")})
+vibetrack.log({"audio": Audio("clip.wav", sample_rate=22050)})
+vibetrack.log({"demo": Video("result.mp4")})
+vibetrack.log({"model": Artifact("best_model.pt", metadata={"epoch": 10})})
+
+# Access config
+vibetrack.config["lr"]  # 3e-5
+
+vibetrack.finish()
+```
+
+### Comparison and analysis
+
+```python
+from vibetrack import RunReader
+from vibetrack.compare import compare_scalars, compare_hparams, summary_table
+
+reader = RunReader("my_project/")
+experiments = reader.experiments()
+
+# Summary table — last value of each tag per experiment
+summary_table(experiments, tags=["loss", "acc"])
+
+# Compare scalars with smoothing
+compare_scalars(experiments, "loss", smoothing="ema", weight=0.6)
+
+# Side-by-side hyperparameter comparison
+compare_hparams(experiments)
+```
+
+### Smoothing
+
+```python
+from vibetrack import smooth, ema, moving_average, gaussian
+
+smoothed = ema(values, weight=0.6)           # Exponential moving average
+smoothed = moving_average(values, window=10)  # Uniform window
+smoothed = gaussian(values, sigma=2.0)        # Gaussian kernel
+smoothed = smooth(values, method="ema", weight=0.6)  # Unified dispatcher
+```
+
+## Distributed training (torchrun)
+
+vibetrack automatically detects `RANK` / `LOCAL_RANK` environment variables. Only rank 0 logs data — all other ranks get a silent no-op writer.
+
+```bash
+torchrun --nproc_per_node=4 --nnodes=2 train.py
+```
+
+```python
+# train.py — no code changes needed
+from vibetrack import SummaryWriter
+
+writer = SummaryWriter("runs/distributed", project_folder="project/")
+# Only rank 0 writes to the database. Other ranks silently skip.
+writer.add_scalar("loss", loss.item(), step)
+writer.close()
+```
+
+Force all ranks to log:
+
+```python
+writer = SummaryWriter("runs/distributed", rank="all")
+```
+
+## Remote logging over HTTP
+
+vibetrack's built-in ingest endpoints accept metrics from remote machines:
+
+```bash
+# Server (included in default web server)
+vibetrack my_project/ --token mysecret
+# -> Ingest at http://host:6006/{project}/listen/log
+```
+
+```python
+# Remote client
+import requests
+
+requests.post("http://server:6006/my_project/listen/log", json={
+    "experiment": "remote_run",
+    "step": 42,
+    "scalars": {"loss": 0.3, "acc": 0.91},
+    "texts": {"note": "checkpoint saved"},
+}, headers={"Authorization": "Bearer mysecret"})
+```
+
+Upload media:
+
+```python
+requests.post("http://server:6006/my_project/listen/media",
+    data={"experiment": "remote_run", "tag": "sample", "step": "0", "type": "image"},
+    files={"file": open("output.png", "rb")},
+    headers={"Authorization": "Bearer mysecret"},
+)
+```
+
+## System metrics
+
+Built-in collection of CPU, GPU, memory, and disk metrics. Runs in a background thread.
+
+```python
+writer = SummaryWriter("runs/exp1", system_metrics_interval=3600)  # every hour (default)
+```
+
+Collected metrics: `system/cpu_percent`, `system/mem_used_gb`, `system/disk_free_gb`, `gpu/utilization`, `gpu/memory_used_gb`, `gpu/temperature`, and automatic alerts when resources are critically low.
+
+## MCP server (AI agent integration)
+
+The web dashboard includes an MCP (Model Context Protocol) server at `/vibetrack_mcp`, enabling AI agents like Claude to query your experiment data directly.
+
+**Available MCP tools:** `list_experiments`, `get_experiment_tags`, `get_scalars`, `get_texts`, `get_images`, `get_audio`, `get_hparams`, `get_histograms`, `summary`, `compare_hparams_tool`
+
+**MCP resources:** `vibetrack://experiments`, `vibetrack://experiments/{name}`, `vibetrack://experiments/{name}/scalars/{tag}`, etc.
+
+Standalone MCP server:
+
+```bash
+vibetrack --viewer mcp --project-folder my_project/
+```
+
+
+
+## CLI
+
+```bash
+vibetrack                           # default  
+vibetrack [PROJECT_FOLDER]          # Launch dashboard (web + MCP + ingest)
+vibetrack --port 8080               # Custom port
+vibetrack --host 127.0.0.1          # Bind to localhost only (by default it is open on LAN IP)
+vibetrack --token SECRET            # Protect ingest endpoints
+vibetrack --listen 0.0.0.0:9009     # Standalone  server on separate port
+vibetrack migrate PROJECT_FOLDER    # Merge legacy per-run DBs into project DB
+```
+
+## Configuration
+
+Settings are stored in `~/.vibetrack/config.json` (global) or per-project via the API:
+
+```json
+{
+  "smoothing": "ema",
+  "smooth_weight": 0.6,
+  "system_metrics_interval": 3600,
+  "web": {
+    "theme": "light",
+    "auto_refresh": 5,
+    "image_play_fps": 2
+  }
+}
+```
+
+## License
+
+Apache 2.0