From 249405b46eb87556ce7dbfc44e861c7626835a32 Mon Sep 17 00:00:00 2001 From: Dan Saunders Date: Wed, 26 Feb 2025 17:56:46 +0000 Subject: [PATCH] docs fix --- docs/telemetry.qmd | 4 ++-- src/axolotl/telemetry/manager.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/telemetry.qmd b/docs/telemetry.qmd index b7c4cb11d..fee4dfcd0 100644 --- a/docs/telemetry.qmd +++ b/docs/telemetry.qmd @@ -39,9 +39,9 @@ runtime metrics telemetry. The telemetry system will block training startup for 15 seconds to ensure users are aware of data collection, unless telemetry is explicitly enabled or disabled. -## Opt-Out Mechanism +## Opt-In Mechanism -Telemetry is **disable by default** on an opt-in basis. To enable it, set: `AXOLOTL_DO_NOT_TRACK=0`. +Telemetry is **disabled by default** on an opt-in basis. To enable it, set `AXOLOTL_DO_NOT_TRACK=0`. To remove the warning message about telemetry that is displayed on train, etc. startup, explicitly set: `AXOLOTL_DO_NOT_TRACK=0` (enable telemetry) or `AXOLOTL_DO_NOT_TRACK=1` diff --git a/src/axolotl/telemetry/manager.py b/src/axolotl/telemetry/manager.py index ca6983058..e92845d93 100644 --- a/src/axolotl/telemetry/manager.py +++ b/src/axolotl/telemetry/manager.py @@ -174,7 +174,7 @@ class TelemetryManager: Tuple containing: - Boolean denoting whether telemetry is enabled or not. """ - # Parse relevant env vars and fill opt-out default values + # Parse relevant env vars axolotl_do_not_track = os.getenv("AXOLOTL_DO_NOT_TRACK") do_not_track = os.getenv("DO_NOT_TRACK")