From 1917b610e43be9ce793764f099ba6b9129228aae Mon Sep 17 00:00:00 2001 From: Jon Geyer Date: Fri, 30 Jan 2026 16:26:55 -0800 Subject: [PATCH 1/2] docs: update readme project description and links to glaas.ai --- README.md | 49 +++++++++++++++++++++++++++++++------------------ 1 file changed, 31 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index bdf4664..adaa54a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,11 @@ **Run Observation & Artifact Registration** -A local front-end to TReqs' Graph Lineage-as-a-Service (GLaaS). Roar tracks data artifacts and execution steps in ML pipelines, enabling reproducibility and lineage queries. +`roar` tracks data artifacts and execution steps in ML pipelines, enabling reproducibility and lineage queries. `roar` tracking happens automagically by observing your commands as they run, capturing essential context without requiring you to define a pipeline explicitly. + +By identifying files based on their actual content rather than their names, it ensures you can always trace a result back to the exact inputs and code that produced it. This gives you reliable reproducibility and a clear history of your artifacts, all derived naturally from your workflow. + +While `roar` captures your work locally, connecting it to a GLaaS (Graph Lineage-as-a-Service) server like [glaas.ai](https://glaas.ai) allows you to publish your lineage graphs to a shared global registry for easy visualization and collaboration. Now your team can search for any artifact by its hash to see exactly how it was made and generate the precise commands needed to reproduce it on another machine. ## Installation @@ -16,12 +20,12 @@ Requires Python 3.10+ and Linux (x86_64 or aarch64) for full functionality. ### Platform Support -| Platform | `roar run` | Other commands | -|----------|------------|----------------| -| Linux x86_64 | Full support | Full support | -| Linux aarch64 | Full support | Full support | -| macOS | Not supported | Full support | -| Windows | Not supported | Full support | +| Platform | `roar run` | Other commands | +| ------------- | ------------- | -------------- | +| Linux x86_64 | Full support | Full support | +| Linux aarch64 | Full support | Full support | +| macOS | Not supported | Full support | +| Windows | Not supported | Full support | The `roar run` command uses a native tracer binary that requires Linux. Other commands work on all platforms. @@ -64,6 +68,7 @@ roar init ### `roar run ` Run a command with provenance tracking. Roar captures: + - Files read and written - Git commit and branch - Execution time and exit code @@ -127,15 +132,15 @@ roar config set Available configuration options: -| Key | Default | Description | -|-----|---------|-------------| -| `output.track_repo_files` | false | Include repo files in provenance | -| `output.quiet` | false | Suppress written files report | -| `filters.ignore_system_reads` | true | Ignore /sys, /etc reads | -| `filters.ignore_package_reads` | true | Ignore installed package reads | -| `filters.ignore_torch_cache` | true | Ignore torch/triton cache | -| `filters.ignore_tmp_files` | true | Ignore /tmp files | -| `glaas.url` | (none) | GLaaS server URL | +| Key | Default | Description | +| ------------------------------ | ------- | ------------------------------------------ | +| `output.track_repo_files` | false | Include repo files in provenance | +| `output.quiet` | false | Suppress written files report | +| `filters.ignore_system_reads` | true | Ignore /sys, /etc reads | +| `filters.ignore_package_reads` | true | Ignore installed package reads | +| `filters.ignore_torch_cache` | true | Ignore torch/triton cache | +| `filters.ignore_tmp_files` | true | Ignore /tmp files | +| `glaas.url` | (none) | GLaaS server URL (e.g. `https://glaas.ai`) | ## Concepts @@ -166,6 +171,7 @@ roar reproduce --run ## Git Integration Roar automatically captures git metadata: + - Current commit hash - Branch name - Repository path @@ -173,6 +179,7 @@ Roar automatically captures git metadata: ## Data Storage All data is stored locally in `.roar/roar.db` (SQLite). The database includes: + - Artifact hashes and metadata - Job records with inputs/outputs - Hash cache for performance @@ -199,6 +206,12 @@ GLAAS_HOST=0.0.0.0 GLAAS_PORT=8080 glaas-server ``` The server provides: +LAAS_PORT=8080 glaas-server + +```` + +The server provides: + - REST API for artifact and job registration - Web UI at `/` with artifact and job browsers - Search and filtering by command, GPU, file type, etc. @@ -214,14 +227,14 @@ roar auth register # Test authentication roar auth test -``` +```` ## Development ### Prerequisites - Python 3.10+ -- Rust toolchain (for building the tracer) - install from https://rustup.rs/ +- Rust toolchain (for building the tracer) - install from ### Setup From f5eef30afe967c838c0e615bfc5db63892922d53 Mon Sep 17 00:00:00 2001 From: Jon Geyer Date: Fri, 30 Jan 2026 16:31:48 -0800 Subject: [PATCH 2/2] fix: clean up auto-lint issues --- README.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/README.md b/README.md index adaa54a..8d1e50e 100644 --- a/README.md +++ b/README.md @@ -205,11 +205,6 @@ glaas-server GLAAS_HOST=0.0.0.0 GLAAS_PORT=8080 glaas-server ``` -The server provides: -LAAS_PORT=8080 glaas-server - -```` - The server provides: - REST API for artifact and job registration @@ -227,7 +222,7 @@ roar auth register # Test authentication roar auth test -```` +``` ## Development