Skip to content

README.md: false denial — N-30: qlora/unsloth Linux-only; export/distributed not on Windows; a missing backend raises ImportError naming the extra (DOC-D4B01-012) #270

Closed

Description

@cemililik

Wave 1 · theme D1-10: Documentation-only fixes · highest severity High · 1 finding(s) · effort docs fix

Summary

The platform markers hold: qlora/unsloth sys_platform=='linux' (pyproject.toml:74,79) and distributed/export !='win32' (:116,:131). The claim 'raises ImportError naming the extra' holds for unsloth (model.py:291-294, inference.py:141-144), deepspeed (trainer.py:581-586) and export (export.py:123-126). It does NOT hold for qlora: model.py:440-450 builds transformers' BitsAndBytesConfig with no forgelm[qlora] hint, and rg 'forgelm[qlora]' over forgelm/ returns nothing, so the user sees transformers' own error message.

Primary finding

DOC-D4B01-012 — README.md: false denial — N-30: qlora/unsloth Linux-only; export/distributed not on Windows; a missing backend raises ImportError naming the extra

severity High

Where. README.md:212 · type: false denial

The document says. N-30: qlora/unsloth Linux-only; export/distributed not on Windows; a missing backend raises ImportError naming the extra

What the code does. The platform markers hold: qlora/unsloth sys_platform=='linux' (pyproject.toml:74,79) and distributed/export !='win32' (:116,:131). The claim 'raises ImportError naming the extra' holds for unsloth (model.py:291-294, inference.py:141-144), deepspeed (trainer.py:581-586) and export (export.py:123-126). It does NOT hold for qlora: model.py:440-450 builds transformers' BitsAndBytesConfig with no forgelm[qlora] hint, and rg 'forgelm[qlora]' over forgelm/ returns nothing, so the user sees transformers' own error message.

Acceptance criteria

  • Each statement is re-checked against the code at fix time.
  • Documentation listed above is corrected in English and in its Turkish mirror in the same PR.
  • Every finding in this issue is resolved or explicitly closed with a reason.

Found by the October 2026 ForgeLM code and documentation review against commit cab2947. Code links point at that commit; line numbers may have moved since. Finding IDs (CR-…, DOC-…, TECH-…) are stable references for this backlog.

Activity

  1. added
    documentationImprovements or additions to documentation
    severity: highWrong behaviour or a false claim users rely on
    source: review-2026-10Found by the October 2026 code and documentation review
    wave: 1Roadmap wave 1: high severity, small effort
    on Oct 9, 2026
  2. cemililik commented on Oct 22, 2026

    @cemililik
    CollaboratorAuthor

    The README sentence this finding checked was removed by 5971d58, the README rewrite. It said that a missing backend raises an ImportError naming the extra (the old footnote). The platform statements the README keeps (QLoRA on Linux + CUDA, Intel Macs unsupported, a link to the installation page) match pyproject.toml. The code gap that made the old sentence false for qlora is tracked as CR-A03-073 in #689. Closing as completed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationseverity: highWrong behaviour or a false claim users rely onsource: review-2026-10Found by the October 2026 code and documentation reviewwave: 1Roadmap wave 1: high severity, small effort

    Type

    No type

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions