chore: update docs
This commit is contained in:
@@ -36,7 +36,7 @@ runtime metrics during training.
|
|||||||
- `axolotl.telemetry.callbacks.TelemetryCallback`: A Trainer callback that sends
|
- `axolotl.telemetry.callbacks.TelemetryCallback`: A Trainer callback that sends
|
||||||
runtime metrics telemetry.
|
runtime metrics telemetry.
|
||||||
|
|
||||||
The telemetry system will block training startup for 15 seconds to ensure users are
|
The telemetry system will block training startup for 10 seconds to ensure users are
|
||||||
aware of data collection, unless telemetry is explicitly enabled or disabled.
|
aware of data collection, unless telemetry is explicitly enabled or disabled.
|
||||||
|
|
||||||
## Opt-Out Mechanism
|
## Opt-Out Mechanism
|
||||||
@@ -44,7 +44,10 @@ aware of data collection, unless telemetry is explicitly enabled or disabled.
|
|||||||
Telemetry is **enabled by default** on an opt-out basis. To disable it, set
|
Telemetry is **enabled by default** on an opt-out basis. To disable it, set
|
||||||
`AXOLOTL_DO_NOT_TRACK=1` or `DO_NOT_TRACK=1`.
|
`AXOLOTL_DO_NOT_TRACK=1` or `DO_NOT_TRACK=1`.
|
||||||
|
|
||||||
To remove the warning message about telemetry that is displayed on train, etc. startup,
|
A warning message will be logged on start to clearly inform users about telemetry.
|
||||||
|
We will remove this after some period.
|
||||||
|
|
||||||
|
To hide 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`
|
explicitly set: `AXOLOTL_DO_NOT_TRACK=0` (enable telemetry) or `AXOLOTL_DO_NOT_TRACK=1`
|
||||||
(explicitly disable telemetry).
|
(explicitly disable telemetry).
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user