TRL documentation

使用統計の収集

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

使用統計の収集

TRLは、実環境でどのトレーナー、モデルアーキテクチャ、ハードウェア構成が使用されているかを理解するために、匿名の使用統計を収集しています。このデータは、どの機能に投資し、どの機能を非推奨にするかという優先順位付けの判断に役立てられています。

収集される情報

トレーナーがインスタンス化されるたびに、1回のピンが送信されます。ペイロードには以下が含まれます:

  • 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