Docs/observability surfacedocs: document the current observability surface - #447
Open
qsxns wants to merge 8 commits into
Open
Docs/observability surfacedocs: document the current observability surface#447qsxns wants to merge 8 commits into
qsxns wants to merge 8 commits into
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…fact reference Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…face areno dashboard uses --start/--stop flags, not start/stop subcommands, and has no --no-browser option. The server starts in the background and prints the URL rather than opening a browser. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The design spec and implementation plan under docs/superpowers/ are agent-workflow artifacts, not user-facing documentation. Remove them so the PR contains only the observability doc changes. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #45
Closes #122
Summary
Documents the current observability surface of AReno — what training
emits through console logs,
train_stats, TensorBoard scalar metrics,and agentic trajectory diagnostics, and how to inspect each during
debugging.
This is a docs-only change. No code, dependencies, or CLI surface are
modified.
What's documented
docs/reference/environment-variables.rstARENO_LOG_LEVEL— controls thearenologger level (defaultINFO).Set to
DEBUGfor per-request decode progress and fine-grained enginediagnostics.
ARENO_LOG_COMPLETIONS— number of decoded rollout samples persisted pertraining step (default
1), written torollout_samples.{pid}.jsonl.docs/cli/observability.rstARENO_LOG_LEVEL.EventAccumulatorcode example for reading TensorBoard scalarsprogrammatically.
areno dashboard --start/--stop, thedefault port, and the metrics-directory artifacts
(
dashboard_state.{pid}.json,rollout_samples.{pid}.jsonl,areno_run_config.{pid}.json/.txt).The existing content already cited
areno.api.metrics,--metrics-log-dir,trainer logging paths, and the
rollout/*,train/*,time/*namespaces,and explicitly notes that AReno does not yet provide a built-in wandb
integration. All of that is preserved.
Acceptance criteria
areno.api.metrics,--metrics-log-dir, and trainer logging pathstrain_stats, TensorBoard, and agentic trajectory diagnosticsrollout/*,train/*, andtime/*metric namespacesVerification
(
areno/cli/dashboard.py,areno/cli/train.py,areno/api/metrics.py,areno/api/defaults.py).interface (
--start/--stop, no--no-browser).make htmlwas not run; the RSTfollows existing patterns in the same file.
Notes
docs/cli/observability.rstremains an orphan page (not linked from thetoctree) — consistent with the existing cross-references from
docs/reference/cli.rstanddocs/cli/training.rst.