[TypeHint] Fix format_calibration_data type hint
#2012
Conversation
Signed-off-by: Kyle Sayers <[email protected]>
Summary of ChangesHello @kylesayrs, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses a minor but important type hinting inaccuracy within the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
👋 Hi! Thank you for contributing to llm-compressor. Please add the ready label when the PR is ready for review. Note: This is required to complete the testing suite, please only add the label once the PR is code complete and local testing has been performed. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request correctly updates the return type hint for the format_calibration_data function to DataLoader, which aligns with the function's implementation. However, this change introduces an inconsistency with the function's docstring, which was not updated. I've added a review comment to highlight this issue.
| do_shuffle: bool = True, | ||
| collate_fn: Callable = default_data_collator, | ||
| ) -> list[torch.Tensor]: | ||
| ) -> DataLoader: |
There was a problem hiding this comment.
With this change, the function's docstring is now inconsistent with the return type hint. The :return: description on line 141 still describes the old return type (list of trimmed calibration data tensors). Please update the docstring to reflect that a DataLoader is returned to maintain consistency.
| :param do_shuffle: whether to shuffle the dataset before selecting calibration | ||
| samples, true by default | ||
| :param collate_fn: optional custom collate function, or use default | ||
| :return: list of trimmed calibration data tensors |
There was a problem hiding this comment.
| :return: DataLoader containing trimmed calibration samples |
No description provided.