diff --git a/.github/workflows/script/formatScan/nlp_dict.txt b/.github/workflows/script/formatScan/nlp_dict.txt index 62412bfe5f03..8db9a88fd54d 100644 --- a/.github/workflows/script/formatScan/nlp_dict.txt +++ b/.github/workflows/script/formatScan/nlp_dict.txt @@ -2262,4 +2262,14 @@ Cpplint DCO cloc jira -servicedesk \ No newline at end of file +servicedesk +Bas +GHA +clangformat +dco +gtest +inteltf +jenk +mr +sign off +formatScan \ No newline at end of file diff --git a/docs/CI_introduction.md b/docs/CI_introduction.md index 5f3e686fa84e..7c815dbc460f 100644 --- a/docs/CI_introduction.md +++ b/docs/CI_introduction.md @@ -1,17 +1,29 @@ # CI Introduction Intel Extension for Transformers use Github Action (GHA) for CI test, if you are new to GHA, please refer to [GHA](https://docs.github.com/en/actions) -All the test scripts will be maintained under [.github](../.github/workflows). +Generally We use [Azure Cloud](https://azure.microsoft.com/en-us/pricing/purchase-options/pay-as-you-go) to deploy CI on Es-v5, Bas-v2. -| Test Name | Test Pass Criteria | Checks | + +| Test Name | Test Scope | Test Pass Criteria | |-------------------------------|-----------------------------------------------|---------------| -| Format Scan | Pylint/Cpplint/bandit/cloc Pass | 4 | -| Spell Check | Check Pass | 1 | -| Copyright Check | Add License on top of code/scripts | 1 | -| DCO | Use git commit -s to signoff | 1 | -| Unit Test | a. No failure, no core dump, no segmentation fault b. No coverage drop| 5 | -| Kernel Benchmark | No failure, No performance regression | 1 | -| Model Test | a. Fp32/Int8 inference no regression b. API no fucntionality success | 5 | -| CPP Graph Test | No failure, No performance regression | 1 | +| Format Scan | Pylint/Cpplint/bandit/cloc/clangformat Pass | PASS | +| Spell Check | Spelling Check | PASS | +| Copyright Check | Copyright Check | PASS | +| [DCO](https://github.com/apps/dco/) | Use git commit -s to sign off | PASS | +| Unit Test | pytest + coverage + gtest | PASS(No failure, No core dump, No segmentation fault, No coverage drop) | +| Kernel Benchmark | Benchmark [Details](../intel_extension_for_transformers/backends/neural_engine/test/kernels/benchmark) | PASS(No performance regression) | +| Model Test | Pytorch + Tensorflow + Neural Engine + IPEX + CPP Graph | PASS(FP32/INT8 No performance regression) | + +# FAQ +1. How to add examples + + (1) Still need to pass detected CI tests + + (2) Use [Extension Test](https://inteltf-jenk.sh.intel.com/view/nlp-toolkit-validation/job/nlp-toolkit-validation-top-mr-extension/) to cover new examples. If you do not have permission for extension test, please contact [Maintainers](inc.maintainers@intel.com) + + +2. How to test specific component version + + (1) Use [Extension Test](https://inteltf-jenk.sh.intel.com/view/nlp-toolkit-validation/job/nlp-toolkit-validation-top-mr-extension/) to specify the version. If you do not have permission for extension test, please contact [Maintainers](inc.maintainers@intel.com) diff --git a/docs/component_owner.md b/docs/component_owner.md index b1c59f492d34..def3055c9ebb 100644 --- a/docs/component_owner.md +++ b/docs/component_owner.md @@ -5,10 +5,10 @@ Contributions to Intel Extension for Transformers specific component must get ap | Component | Owner | Backup | |--------------------|-----------------|-----------------| -| Kernel | Hengyu | Luo yu | -| Engine | Dong bo | Zhenwei | -| Pytorch | Penghui | He xin | -| Tensorflow | Lv liang | Penghui | -| Neuralchat | Lv liang | Kaokao | -| Workflow | Lv liang | Haihao | -| Tests | Wenxin | Xuehao | \ No newline at end of file +| Kernel | airMeng | luoyu-intel | +| Engine | a32543254 | zhenwei-intel | +| Pytorch | PenghuiCheng | xin3he | +| Tensorflow | lvliang-intel | PenghuiCheng | +| Neuralchat | lvliang-intel | lkk12014402 | +| Workflow | lvliang-intel | kevinintel | +| Tests | VincyZhang | XuehaoSun | \ No newline at end of file diff --git a/docs/contributions.md b/docs/contributions.md index 86c1919c43d8..077492435607 100644 --- a/docs/contributions.md +++ b/docs/contributions.md @@ -43,7 +43,7 @@ See [PR template](../.github/PULL_REQUEST_TEMPLATE/pull_request_template.md) (3) ALL conversations solved -(4) Third-party dependency license compliable +(4) Third-party dependency license Compatible ## CI Introduction