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 WOQ&LayerWise #1938

Closed Kaihui-intel closed 3 months ago

Kaihui-intel commented 4 months ago

Type of Change

documentation

Description

detail description

Expected Behavior & Potential Risk

the expected behavior that triggered by this PR

How has this PR been tested?

how to reproduce the test (including hardware information)

Dependency Change?

any library dependency introduced or removed

github-actions[bot] commented 4 months ago

⛈️ Required checks status: Has failure 🔴

Warning If you do not have the access to re-run the Probot, please contact XuehaoSun for help. If you push a new commit, all of the workflow will be re-triggered.

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=33047) | failure | | ❌ | | [Code-Scan (Bandit Code Scan Bandit)](https://dev.azure.com/lpot-inc/b7121868-d73a-4794-90c1-23135f974d09/_build/results?buildId=33047&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=33047&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=33047&view=logs&jobId=454075da-6b11-57a5-edf2-4c5947924fa8) | failure | [download](https://artprodcus3.artifacts.visualstudio.com/Acd5c2212-3bfc-4706-9afe-b292ced6ae69/b7121868-d73a-4794-90c1-23135f974d09/_apis/artifact/cGlwZWxpbmVhcnRpZmFjdDovL2xwb3QtaW5jL3Byb2plY3RJZC9iNzEyMTg2OC1kNzNhLTQ3OTQtOTBjMS0yMzEzNWY5NzRkMDkvYnVpbGRJZC8zMzA0Ny9hcnRpZmFjdE5hbWUvMV9weWxpbnQ1/content?format=file&subPath=%2Fpylint.json) | ❌ | These checks are required after the changes to `neural_compressor/torch/algorithms/layer_wise/load.py`, `neural_compressor/torch/algorithms/layer_wise/modified_pickle.py`, `neural_compressor/torch/algorithms/layer_wise/utils.py`, `neural_compressor/torch/algorithms/weight_only/__init__.py`, `neural_compressor/torch/algorithms/weight_only/autoround.py`, `neural_compressor/torch/algorithms/weight_only/awq.py`, `neural_compressor/torch/algorithms/weight_only/gptq.py`, `neural_compressor/torch/algorithms/weight_only/modules.py`, `neural_compressor/torch/algorithms/weight_only/rtn.py`, `neural_compressor/torch/algorithms/weight_only/save_load.py`, `neural_compressor/torch/algorithms/weight_only/teq.py`, `neural_compressor/torch/algorithms/weight_only/utility.py`.
🟢 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=33049) | success | | ✅ | | [Model-Test-3x (Generate Report GenerateReport)](https://dev.azure.com/lpot-inc/b7121868-d73a-4794-90c1-23135f974d09/_build/results?buildId=33049&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=33049&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=33049&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=33049&view=logs&jobId=919e49eb-e265-548b-eaa7-50d75ec3f230) | success | | ✅ | These checks are required after the changes to `neural_compressor/torch/algorithms/layer_wise/load.py`, `neural_compressor/torch/algorithms/layer_wise/modified_pickle.py`, `neural_compressor/torch/algorithms/layer_wise/utils.py`, `neural_compressor/torch/algorithms/weight_only/__init__.py`, `neural_compressor/torch/algorithms/weight_only/autoround.py`, `neural_compressor/torch/algorithms/weight_only/awq.py`, `neural_compressor/torch/algorithms/weight_only/gptq.py`, `neural_compressor/torch/algorithms/weight_only/modules.py`, `neural_compressor/torch/algorithms/weight_only/rtn.py`, `neural_compressor/torch/algorithms/weight_only/save_load.py`, `neural_compressor/torch/algorithms/weight_only/teq.py`, `neural_compressor/torch/algorithms/weight_only/utility.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=33048) | success | | ✅ | | [UT-3x-Torch (Coverage Compare CollectDatafiles)](https://dev.azure.com/lpot-inc/b7121868-d73a-4794-90c1-23135f974d09/_build/results?buildId=33048&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=33048&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=33048&view=logs&jobId=337dfcaa-e49a-58ed-d835-0606580c9539) | success | | ✅ | These checks are required after the changes to `neural_compressor/torch/algorithms/layer_wise/load.py`, `neural_compressor/torch/algorithms/layer_wise/modified_pickle.py`, `neural_compressor/torch/algorithms/layer_wise/utils.py`, `neural_compressor/torch/algorithms/weight_only/__init__.py`, `neural_compressor/torch/algorithms/weight_only/autoround.py`, `neural_compressor/torch/algorithms/weight_only/awq.py`, `neural_compressor/torch/algorithms/weight_only/gptq.py`, `neural_compressor/torch/algorithms/weight_only/modules.py`, `neural_compressor/torch/algorithms/weight_only/rtn.py`, `neural_compressor/torch/algorithms/weight_only/save_load.py`, `neural_compressor/torch/algorithms/weight_only/teq.py`, `neural_compressor/torch/algorithms/weight_only/utility.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.

Kaihui-intel commented 4 months ago

@yiliu30 Could you help add the hqq docstring?

yiliu30 commented 4 months ago

@yiliu30 Could you help add the hqq docstring?

Sure, will add it by a separate PR.

yiliu30 commented 4 months ago

Please update the scan path.

https://github.com/intel/neural-compressor/blob/master/.azure-pipelines/scripts/codeScan/pydocstyle/scan_path.txt

yiliu30 commented 4 months ago

@yiliu30 Could you help add the hqq docstring?

Sure, will add it by a separate PR.

Added docstring for hqq at https://github.com/intel/neural-compressor/pull/1937