From b8ec5bdccf62c756db0070c619034ea88640a574 Mon Sep 17 00:00:00 2001 From: Dan Saunders Date: Wed, 26 Feb 2025 20:40:12 +0000 Subject: [PATCH] doc update --- README.md | 7 +++++++ _quarto.yml | 1 + 2 files changed, 8 insertions(+) diff --git a/README.md b/README.md index d5e8f08a1..06b2bcab1 100644 --- a/README.md +++ b/README.md @@ -112,6 +112,13 @@ That's it! Check out our [Getting Started Guide](https://docs.axolotl.ai/docs/ge Contributions are welcome! Please see our [Contributing Guide](https://github.com/axolotl-ai-cloud/axolotl/blob/main/.github/CONTRIBUTING.md) for details. +## 📈 Telemetry + +Axolotl has opt-in telemetry that helps us understand how the project is being used +and prioritize improvements. We collect basic system information, model types, and +error rates—never personal data or file paths. Telemetry is disabled by default. To +enable it, set AXOLOTL_DO_NOT_TRACK=0. For more details, see our [telemetry documentation](https://axolotl-ai-cloud.github.io/axolotl/docs/telemetry.html). + ## Supported Models | | fp16/fp32 | lora | qlora | gptq | gptq w/flash attn | flash attn | xformers attn | diff --git a/_quarto.yml b/_quarto.yml index 9b97095ce..a7b07a8f4 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -236,6 +236,7 @@ website: - docs/inference.qmd - docs/cli.qmd - docs/config.qmd + - docs/telemetry.qmd - text: "API Reference" href: docs/api