Complete Google-style docstrings across neural_compressor #2415
Merged
Complete Google-style docstrings across neural_compressor #2415
Conversation
Co-authored-by: chensuyue <51692656+chensuyue@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix and complete docstrings in neural_compressor directory
Fix docstrings in neural_compressor directory
Mar 3, 2026
Contributor
|
@copilot you have missing a list of issues such as is not correct. Need to scan carefully in the path and fix the missing issues. |
Co-authored-by: chensuyue <51692656+chensuyue@users.noreply.github.com>
Contributor
Author
Updated |
Copilot
AI
changed the title
Fix docstrings in neural_compressor directory
Fix docstrings across neural_compressor including autoround
Mar 4, 2026
Copilot
AI
changed the title
Fix docstrings across neural_compressor including autoround
Align AutoRound dataloader docstrings with actual signatures
Mar 4, 2026
Co-authored-by: chensuyue <51692656+chensuyue@users.noreply.github.com>
Co-authored-by: chensuyue <51692656+chensuyue@users.noreply.github.com>
Copilot
AI
changed the title
Align AutoRound dataloader docstrings with actual signatures
Align torch FP8 docstrings with Google style
Mar 4, 2026
Co-authored-by: chensuyue <51692656+chensuyue@users.noreply.github.com>
Copilot
AI
changed the title
Align torch FP8 docstrings with Google style
Complete Google-style docstrings across common/tensorflow/jax modules
Mar 4, 2026
Copilot stopped work on behalf of
chensuyue due to an error
March 4, 2026 14:18
Co-authored-by: chensuyue <51692656+chensuyue@users.noreply.github.com>
Co-authored-by: chensuyue <51692656+chensuyue@users.noreply.github.com>
Co-authored-by: chensuyue <51692656+chensuyue@users.noreply.github.com>
Co-authored-by: chensuyue <51692656+chensuyue@users.noreply.github.com>
Co-authored-by: chensuyue <51692656+chensuyue@users.noreply.github.com>
Copilot
AI
changed the title
Complete Google-style docstrings across common/tensorflow/jax modules
Tighten JAX docstrings across quantization modules
Mar 4, 2026
…/github.com/intel/neural-compressor into copilot/fix-docstrings-in-neural-compressor
for more information, see https://pre-commit.ci
chensuyue
approved these changes
Mar 5, 2026
Contributor
|
@copilot revert the PR description, need an overall describe, not only just for the last change. |
Contributor
Author
Copilot
AI
changed the title
Complete Google-style docstrings across neural_compressor
Complete Google-style docstrings across neural_compressor JAX modules
Mar 5, 2026
xin3he
approved these changes
Mar 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request primarily improves documentation and code clarity across the codebase, especially for the JAX quantization APIs and the core configuration and utility classes. It introduces new API documentation for JAX quantization, adds or enhances docstrings for many methods, and clarifies function signatures and argument types. Additionally, it fixes a typo in a function name and improves the descriptions of configuration and operator handling.
Documentation and API enhancements:
jax_quantization_common.rstandjax_quantization_config.rstand corresponding references in the main API index. [1] [2] [3]neural_compressor/jax/algorithms/dynamic.py,neural_compressor/jax/algorithms/static.py,neural_compressor/jax/quantization/__init__.py). [1] [2] [3]BaseConfig,Evaluator, utility decorators, and logging functions). [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17]JAX quantization API and config improvements:
dynamic_quantizeandstatic_quantizeto clarify argument types and return values. [1] [2]OperatorConfigclass and related config registration methods with more descriptive docstrings and clarified return types inneural_compressor/jax/quantization/config.py. [1] [2] [3] [4]Bugfixes and minor code improvements:
Evaluatorclass (molde→model).These changes collectively improve the usability, maintainability, and clarity of the codebase and documentation, especially for users and developers working with JAX quantization features.