[cemililik]

Summary

The privacy page says ForgeLM "does not collect telemetry, does not send usage data anywhere". A default online forgelm run did send one: TRL's trainers call huggingface_hub's send_telemetry when they are built, and huggingface_hub sends a small anonymous usage ping to huggingface.co unless HF_HUB_DISABLE_TELEMETRY is true or offline mode is on. This makes the claim true for the CLI instead of softening it.

Related issues

Fixes #95 for the CLI. The site's privacy strings need no change for the CLI path; using ForgeLM as a library is covered in the Telemetry row below.

Changes

• forgelm/cli/_config_load.py: _disable_hub_telemetry() does os.environ.setdefault("HF_HUB_DISABLE_TELEMETRY", "1").
• forgelm/cli/_dispatch.py: main() calls it first, before anything imports huggingface_hub (which reads the variable once, at import).
• docs/usermanuals/{en,tr}/operations/air-gap.md: the Telemetry row now says what the CLI sets and that library use does not.

Trade-offs

• setdefault leaves an operator's own value alone, so HF_HUB_DISABLE_TELEMETRY=0 opts back in. This is an environment default for a dependency, not environment-driven ForgeLM behaviour, so it does not break the "config-driven" principle, but it is worth a look.
• Using ForgeLM as a library does not go through main() and is not covered; the air-gap page says so.
• Whether huggingface_hub makes other background requests beyond the telemetry ping was not examined.

Type

• Bug fix

Testing

• TestHubTelemetryDefault in tests/test_cli.py: the variable is set to 1 by main(), an existing value is kept, and importing forgelm.cli does not import huggingface_hub (a later top-level import would silently defeat the default).
• Checked against the installed TRL 1.7.1 and huggingface_hub: both read the variable.
• The full CLAUDE.md gauntlet from a clean worktree of this branch: exit 0.

Checklist

• English and Turkish mirrors updated together
• CHANGELOG entry under [Unreleased]
• Tests added

🤖 Generated with Claude Code

Summary by Sourcery

Disable Hugging Face anonymous telemetry by default for CLI invocations to keep ForgeLM’s CLI privacy behavior consistent with its documentation.

Bug Fixes:

• Prevent the forgelm CLI from sending Hugging Face’s anonymous usage telemetry by default while preserving explicit operator opt-in values.

Documentation:

• Document the CLI’s Hugging Face telemetry behavior and its distinction from library usage in the English and Turkish air-gap guides.

Tests:

• Add coverage for the telemetry default, operator overrides, initialization ordering, and Hugging Face Hub integration.

Chores:

• Record the telemetry privacy fix in the unreleased changelog.

[sourcery-ai]

Sorry @cemililik, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 13 hours and 33 minutes by commenting @sourcery-ai review. Upgrade to get a review now.

[coderabbitai]

Warning

Review limit reached

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

Next included review available in 35 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 3 included reviews currently available. Your 48 included PR review attempts over the past 7 days set your current allowance at 3 reviews per hour.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

• Configuration used: defaults
• Review profile: CHILL
• Plan: Essentials
• Run ID: a7e4c9ea-98ee-4b00-9757-990f57e3dcf4

📥 Commits

Reviewing files that changed from the base of the PR and between 56b4f0d and 77363e4.

📒 Files selected for processing: 6

• CHANGELOG.md
• docs/usermanuals/en/operations/air-gap.md
• docs/usermanuals/tr/operations/air-gap.md
• forgelm/cli/_config_load.py
• forgelm/cli/_dispatch.py
• tests/test_cli.py

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

_{Comment @coderabbitai help to get the list of available commands.}

[sourcery-ai]

Reviewer's Guide

The PR prevents the forgelm CLI from triggering Hugging Face’s anonymous telemetry ping by setting HF_HUB_DISABLE_TELEMETRY=1 at the earliest dispatch point, while preserving explicit operator values, documenting that library usage is out of scope, and testing import order and dependency behavior.

Sequence diagram for CLI telemetry suppression

sequenceDiagram
    participant Operator
    participant CLI as forgelm CLI
    participant Dispatch as main()
    participant Hub as huggingface_hub
    participant HF as huggingface.co

    Operator->>CLI: invoke forgelm
    CLI->>Dispatch: main()
    Dispatch->>Dispatch: _disable_hub_telemetry()
    Note over Dispatch: os.environ.setdefault(HF_HUB_DISABLE_TELEMETRY, 1)
    Dispatch->>Hub: import after environment setup
    Hub->>Hub: send_telemetry()
    alt HF_HUB_DISABLE_TELEMETRY=1
        Hub-->>HF: no anonymous usage ping
    else operator set HF_HUB_DISABLE_TELEMETRY=0
        Hub->>HF: anonymous usage ping
    end

Loading

Flow diagram for CLI and library telemetry behavior

flowchart TD
    Start[ForgeLM usage] --> Mode{CLI or library?}
    Mode -->|CLI| Main["main()"]
    Main --> Default["_disable_hub_telemetry()"]
    Default --> Env[setdefault HF_HUB_DISABLE_TELEMETRY=1]
    Env --> Trainers[TRL trainers and huggingface_hub]
    Trainers --> Suppressed[Anonymous usage ping suppressed]
    Mode -->|Library| Library[Library entry point]
    Library --> Hub[TRL trainers and huggingface_hub]
    Hub --> Caller[Caller configures telemetry behavior]

Loading

File-Level Changes

Change	Details	Files
Adds a CLI startup default that disables Hugging Face Hub telemetry before dependency import.	Introduces an environment-variable helper using setdefault, preserving explicit operator opt-in or opt-out values. Invokes the helper at the beginning of CLI dispatch before the main execution path and potential huggingface_hub imports.	forgelm/cli/_config_load.py forgelm/cli/_dispatch.py
Documents the scope and behavior of telemetry suppression.	Updates the English and Turkish air-gap telemetry rows to describe the CLI default, operator override, and library-use limitation. Adds an unreleased changelog entry explaining the privacy fix and opt-in behavior.	docs/usermanuals/en/operations/air-gap.md docs/usermanuals/tr/operations/air-gap.md CHANGELOG.md
Adds regression coverage for initialization order and environment-variable semantics.	Verifies the default is set, existing values are preserved, and dispatch establishes the setting before command execution. Uses fresh subprocesses to ensure importing the CLI does not preload huggingface_hub and that the dependency observes the configured value.	tests/test_cli.py

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#95	Prevent Hugging Face telemetry from being sent during ForgeLM training runs by default, including when ForgeLM is used through its library API.	❌	The change disables telemetry only when the CLI calls main(). The PR explicitly leaves library use uncovered, so training through that entry point can still send the ping.
#95	Make the privacy claims accurate in the privacy page and the English and Turkish air-gap manuals.	❌	The English and Turkish manuals now disclose the CLI behavior and its library-use limitation, but the privacy-page strings in all six locales are unchanged and still make an unqualified no-telemetry claim.
#95	Add a regression test for the telemetry behavior and document the fix in the release notes.	✅

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[cemililik]

Superseded by #999: the wave-0 fixes are combined by theme into five pull requests to cut the review load. This branch's commits are included there unchanged apart from the CHANGELOG.md merge; the branch stays on the remote.