Skip to content

Update documentation link for compression formats#713

Open
dsikka wants to merge 2 commits into
mainfrom
dsikka-update-link
Open

Update documentation link for compression formats#713
dsikka wants to merge 2 commits into
mainfrom
dsikka-update-link

Conversation

@dsikka

@dsikka dsikka commented May 21, 2026

Copy link
Copy Markdown
Collaborator

No description provided.

@coderabbitai

coderabbitai Bot commented May 21, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 2d2b6520-6c7f-4999-bd79-81ad885e46c1

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Walkthrough

The infer_model_format function's docstring is updated to point users to the vLLM documentation URL for compression format information instead of the previous local markdown file reference.

Changes

Documentation Reference Update

Layer / File(s) Summary
Docstring documentation reference update
src/compressed_tensors/compressors/format.py
The infer_model_format function's docstring reference to compression format documentation is updated from a local docs/guides/compression_formats.md path to a vLLM guides URL.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive No pull request description was provided by the author, making it impossible to assess relevance to the changeset. Add a brief description explaining why the documentation link was updated and what users should expect from the change.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: updating a documentation link related to compression formats in the codebase.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch dsikka-update-link

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@mergify

mergify Bot commented May 21, 2026

Copy link
Copy Markdown

The quality checks have failed. Please run make style and make quality under
the root directory to adddress the lint failures. You will need to install the
dev optional install to get the required linting packages.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/compressed_tensors/compressors/format.py`:
- Line 37: The module-level docstring in compressed_tensors.compressors.format
currently has a single long line ("For a summary of the formats, see
https://docs.vllm.ai/projects/llm-compressor/en/latest/guides/compression_schemes/")
that triggers flake8 E501; edit that docstring in format.py to wrap or shorten
the text so no line exceeds the configured max length (e.g., split into two
lines: a short sentence "For a summary of the formats, see:" and put the long
URL on the next line) ensuring the docstring still reads clearly and the URL
remains intact.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: f88eab1c-f396-401f-9e54-7772143f2170

📥 Commits

Reviewing files that changed from the base of the PR and between c170de6 and 0b59d12.

📒 Files selected for processing (1)
  • src/compressed_tensors/compressors/format.py

Comment thread src/compressed_tensors/compressors/format.py
dsikka and others added 2 commits June 22, 2026 12:48
Signed-off-by: Dipika Sikka <dipikasikka1@gmail.com>
Signed-off-by: Kyle Sayers <kylesayrs@gmail.com>
@kylesayrs kylesayrs force-pushed the dsikka-update-link branch from 0b59d12 to 46238fd Compare June 22, 2026 16:49
@mergify mergify Bot removed the quality-failed label Jun 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants