search

intel / neural-compressor

SOTA low-bit LLM quantization (INT8/FP8/INT4/FP4/NF4) & sparsity; leading model compression techniques on TensorFlow, PyTorch, and ONNX Runtime
https://intel.github.io/neural-compressor/
Apache License 2.0
2.23k stars 257 forks source link

Add docstring for PT2E and HQQ #1937

Closed yiliu30 closed 4 months ago

yiliu30 commented 4 months ago

Type of Change

Docstring

pydocstyle --convention=google ./neural_compressor/torch/export/
pydocstyle --convention=google ./neural_compressor/torch/algorithms/pt2e_quant/
github-actions[bot] commented 4 months ago

⚡ Required checks status: All passing 🟢

Groups summary

🟢 Code Scan Tests workflow | Check ID | Status | Error details | | | -------- | ------ | ---- | --- | | [Code-Scan](https://dev.azure.com/lpot-inc/b7121868-d73a-4794-90c1-23135f974d09/_build/results?buildId=33079) | success | | ✅ | | [Code-Scan (Bandit Code Scan Bandit)](https://dev.azure.com/lpot-inc/b7121868-d73a-4794-90c1-23135f974d09/_build/results?buildId=33079&view=logs&jobId=343c57fa-283e-589b-e772-0a0553c93e53) | success | | ✅ | | [Code-Scan (DocStyle Code Scan DocStyle)](https://dev.azure.com/lpot-inc/b7121868-d73a-4794-90c1-23135f974d09/_build/results?buildId=33079&view=logs&jobId=c1e234ec-db76-5d40-e8f0-e1ad3ef905a3) | success | | ✅ | | [Code-Scan (Pylint Code Scan Pylint)](https://dev.azure.com/lpot-inc/b7121868-d73a-4794-90c1-23135f974d09/_build/results?buildId=33079&view=logs&jobId=454075da-6b11-57a5-edf2-4c5947924fa8) | success | | ✅ | These checks are required after the changes to `neural_compressor/torch/algorithms/pt2e_quant/__init__.py`, `neural_compressor/torch/algorithms/pt2e_quant/core.py`, `neural_compressor/torch/algorithms/pt2e_quant/half_precision_rewriter.py`, `neural_compressor/torch/algorithms/pt2e_quant/save_load.py`, `neural_compressor/torch/algorithms/pt2e_quant/utility.py`, `neural_compressor/torch/algorithms/weight_only/hqq/__init__.py`, `neural_compressor/torch/algorithms/weight_only/hqq/bitpack.py`, `neural_compressor/torch/algorithms/weight_only/hqq/config.py`, `neural_compressor/torch/algorithms/weight_only/hqq/core.py`, `neural_compressor/torch/algorithms/weight_only/hqq/optimizer.py`, `neural_compressor/torch/algorithms/weight_only/hqq/qtensor.py`, `neural_compressor/torch/algorithms/weight_only/hqq/quantizer.py`, `neural_compressor/torch/algorithms/weight_only/hqq/utility.py`, `neural_compressor/torch/export/__init__.py`, `neural_compressor/torch/export/pt2e_export.py`, `neural_compressor/torch/quantization/config.py`, `.azure-pipelines/scripts/codeScan/pydocstyle/scan_path.txt`.
🟢 Model Tests 3x workflow | Check ID | Status | Error details | | | -------- | ------ | ---- | --- | | [Model-Test-3x](https://dev.azure.com/lpot-inc/b7121868-d73a-4794-90c1-23135f974d09/_build/results?buildId=33081) | success | | ✅ | | [Model-Test-3x (Generate Report GenerateReport)](https://dev.azure.com/lpot-inc/b7121868-d73a-4794-90c1-23135f974d09/_build/results?buildId=33081&view=logs&jobId=131b5a5d-c16f-50a4-e704-41ef17f1e502) | success | | ✅ | | [Model-Test-3x (Run PyTorch Model opt_125m_woq_gptq_int4)](https://dev.azure.com/lpot-inc/b7121868-d73a-4794-90c1-23135f974d09/_build/results?buildId=33081&view=logs&jobId=e3333e26-4334-5d5e-a7bd-ee7471860e42) | success | | ✅ | | [Model-Test-3x (Run PyTorch Model opt_125m_woq_gptq_int4_dq_bnb)](https://dev.azure.com/lpot-inc/b7121868-d73a-4794-90c1-23135f974d09/_build/results?buildId=33081&view=logs&jobId=2ce7611e-1b4a-5a32-2344-8e2c635b00bd) | success | | ✅ | | [Model-Test-3x (Run PyTorch Model opt_125m_woq_gptq_int4_dq_ggml)](https://dev.azure.com/lpot-inc/b7121868-d73a-4794-90c1-23135f974d09/_build/results?buildId=33081&view=logs&jobId=919e49eb-e265-548b-eaa7-50d75ec3f230) | success | | ✅ | These checks are required after the changes to `neural_compressor/torch/algorithms/pt2e_quant/__init__.py`, `neural_compressor/torch/algorithms/pt2e_quant/core.py`, `neural_compressor/torch/algorithms/pt2e_quant/half_precision_rewriter.py`, `neural_compressor/torch/algorithms/pt2e_quant/save_load.py`, `neural_compressor/torch/algorithms/pt2e_quant/utility.py`, `neural_compressor/torch/algorithms/weight_only/hqq/__init__.py`, `neural_compressor/torch/algorithms/weight_only/hqq/bitpack.py`, `neural_compressor/torch/algorithms/weight_only/hqq/config.py`, `neural_compressor/torch/algorithms/weight_only/hqq/core.py`, `neural_compressor/torch/algorithms/weight_only/hqq/optimizer.py`, `neural_compressor/torch/algorithms/weight_only/hqq/qtensor.py`, `neural_compressor/torch/algorithms/weight_only/hqq/quantizer.py`, `neural_compressor/torch/algorithms/weight_only/hqq/utility.py`, `neural_compressor/torch/export/__init__.py`, `neural_compressor/torch/export/pt2e_export.py`, `neural_compressor/torch/quantization/config.py`.
🟢 Unit Tests 3x-PyTorch workflow | Check ID | Status | Error details | | | -------- | ------ | ---- | --- | | [UT-3x-Torch](https://dev.azure.com/lpot-inc/b7121868-d73a-4794-90c1-23135f974d09/_build/results?buildId=33080) | success | | ✅ | | [UT-3x-Torch (Coverage Compare CollectDatafiles)](https://dev.azure.com/lpot-inc/b7121868-d73a-4794-90c1-23135f974d09/_build/results?buildId=33080&view=logs&jobId=71384379-497b-5787-1f51-cc2e0f831d78) | success | | ✅ | | [UT-3x-Torch (Unit Test 3x Torch Unit Test 3x Torch)](https://dev.azure.com/lpot-inc/b7121868-d73a-4794-90c1-23135f974d09/_build/results?buildId=33080&view=logs&jobId=ce119872-54c8-5686-93fc-b763560515d2) | success | | ✅ | | [UT-3x-Torch (Unit Test 3x Torch baseline Unit Test 3x Torch baseline)](https://dev.azure.com/lpot-inc/b7121868-d73a-4794-90c1-23135f974d09/_build/results?buildId=33080&view=logs&jobId=337dfcaa-e49a-58ed-d835-0606580c9539) | success | | ✅ | These checks are required after the changes to `neural_compressor/torch/algorithms/pt2e_quant/__init__.py`, `neural_compressor/torch/algorithms/pt2e_quant/core.py`, `neural_compressor/torch/algorithms/pt2e_quant/half_precision_rewriter.py`, `neural_compressor/torch/algorithms/pt2e_quant/save_load.py`, `neural_compressor/torch/algorithms/pt2e_quant/utility.py`, `neural_compressor/torch/algorithms/weight_only/hqq/__init__.py`, `neural_compressor/torch/algorithms/weight_only/hqq/bitpack.py`, `neural_compressor/torch/algorithms/weight_only/hqq/config.py`, `neural_compressor/torch/algorithms/weight_only/hqq/core.py`, `neural_compressor/torch/algorithms/weight_only/hqq/optimizer.py`, `neural_compressor/torch/algorithms/weight_only/hqq/qtensor.py`, `neural_compressor/torch/algorithms/weight_only/hqq/quantizer.py`, `neural_compressor/torch/algorithms/weight_only/hqq/utility.py`, `neural_compressor/torch/export/__init__.py`, `neural_compressor/torch/export/pt2e_export.py`, `neural_compressor/torch/quantization/config.py`.

Thank you for your contribution! 💜

Note This comment is automatically generated and will be updates every 180 seconds within the next 6 hours. If you have any other questions, contact chensuyue or XuehaoSun for help.