TRL documentation

使用统计信息收集

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

使用统计信息收集

TRL 会收集匿名的使用统计数据,以帮助维护者了解在实际使用中采用了哪些训练器、模型架构和硬件配置。这些数据为确定哪些功能值得投入开发、哪些功能应被弃用提供了决策依据。

收集的内容

每次实例化 trainer 时都会发送一次 ping。该负载包含:

  • TRL 版本(例如 1.5.0)
  • Trainer 类名称,仅当其为 TRL 定义的 trainer 时才会报告(例如 SFTTrainer、GRPOTrainer)。用户自定义的子类将报告为 other。
  • 模型架构,仅当其为 transformers 已知的模型类型时才会报告(例如 llama、qwen3)。自定义或私有架构将报告为 other。
  • 是否正在使用 PEFT
  • 训练数据集的加载方式:hub(从 Hub 下载)、files(通过基于文件的构建器读取,例如 json 或 csv —— 这也涵盖了包含原始 json/csv 文件的 Hub 仓库)、memory(在进程内构建,例如 Dataset.from_dict)或 other。数据集的名称和路径永远不会被收集。
  • 分布式后端(deepspeed、fsdp、ddp 或 none)
  • 世界大小,分桶(1、2-8、9-64、65+)
  • 加速器类型(cuda、xpu、npu、mlu、mps、cpu)
  • GPU 型号名称(例如 NVIDIA H100 80GB HBM3),如可用

不会收集任何数据集名称、文件路径、模型标识符、超参数值或其他用户提供的数据。与任何 HTTP 请求一样,服务器可以看到源 IP 地址和标准 HTTP 请求头。

在 CI 环境(即设置了 CI 环境变量时)或离线模式下,不会发送遥测数据。

如何退出

设置以下任一环境变量以禁用遥测:

export HF_HUB_DISABLE_TELEMETRY=1   # disables telemetry for all HF libraries
export HF_HUB_OFFLINE=1             # disables all network calls to the Hub

这为何有帮助

如果没有使用数据,维护者将无法了解库的哪些部分对用户最为重要。遥测功能使我们能够回答以下问题:

  • 哪些训练器被广泛采用,哪些可以安全地弃用?
  • 哪些模型架构最常使用 TRL 进行微调,以便我们优先支持它们?
  • 用户正在使用哪些硬件配置,以便我们针对这些配置进行测试和优化?

如果您觉得 TRL 有用,保持遥测功能开启是一种低成本的方式,可以帮助我们改进它。

Update on GitHub