[Docs](mlu-ops): Update docs for v1.0.0

Cambricon · Jan 25, 2024 · 894d337 · 894d337
1 parent ac22f7f
commit 894d337
Show file tree

Hide file tree

Showing 10 changed files with 421 additions and 68 deletions.
diff --git a/.github/workflows/daily.yaml b/.github/workflows/daily.yaml
@@ -12,9 +12,9 @@ jobs:
     strategy:
       matrix:
         runner: [mlu370-m8]
-        mlu_ops_version : [0.11.0]
-        cntoolkit_version : [3.7.0]
-        cnnl_version: [1.21.1]
+        mlu_ops_version : [1.0.0]
+        cntoolkit_version : [3.9.0]
+        cnnl_version: [1.24.0]
     runs-on: ${{matrix.runner}}
     steps:
       - uses: actions/checkout@v3
@@ -28,33 +28,33 @@ jobs:
 
       - name: build_mlu_ops
         run: >
-          docker run --rm -v $(pwd):/work -w /work docker-user.extrotec.com:30080/mlu-ops/mluops_ci:devel-x86_64-ubuntu18.04-cntoolkit${{matrix.cntoolkit_version}}-cnnl${{matrix.cnnl_version}}
+          docker run --rm -v $(pwd):/work -w /work docker-user.extrotec.com:30080/mlu-ops/mluops_ci:devel-x86_64-ubuntu20.04-cntoolkit${{matrix.cntoolkit_version}}-cnnl${{matrix.cnnl_version}}
           ./build.sh
 
       - name: release_test_cases
         run: >
           docker run --rm --device /dev/cambricon_ctl --device /dev/cambricon_dev0 --device /dev/commu0
-          -v /testdata:/testdata -v $(pwd):/work -w /work docker-user.extrotec.com:30080/mlu-ops/mluops_ci:devel-x86_64-ubuntu18.04-cntoolkit${{matrix.cntoolkit_version}}-cnnl${{matrix.cnnl_version}}
+          -v /testdata:/testdata -v $(pwd):/work -w /work docker-user.extrotec.com:30080/mlu-ops/mluops_ci:devel-x86_64-ubuntu20.04-cntoolkit${{matrix.cntoolkit_version}}-cnnl${{matrix.cnnl_version}}
           ./test.sh --cases_dir=/testdata/release_test/default_platform
 
       - name: release_temp_cases
         run: >
           docker run --rm --device /dev/cambricon_ctl --device /dev/cambricon_dev0 --device /dev/commu0
-          -v /testdata:/testdata -v $(pwd):/work -w /work docker-user.extrotec.com:30080/mlu-ops/mluops_ci:devel-x86_64-ubuntu18.04-cntoolkit${{matrix.cntoolkit_version}}-cnnl${{matrix.cnnl_version}}
+          -v /testdata:/testdata -v $(pwd):/work -w /work docker-user.extrotec.com:30080/mlu-ops/mluops_ci:devel-x86_64-ubuntu20.04-cntoolkit${{matrix.cntoolkit_version}}-cnnl${{matrix.cnnl_version}}
           ./test.sh --cases_dir=/testdata/release_temp/default_platform
 
       - name: test_release_test_370_cases
         if: matrix.runner == 'mlu370-m8'
         run: >
           docker run --rm --device /dev/cambricon_ctl --device /dev/cambricon_dev0 --device /dev/commu0
-          -v /testdata:/testdata -v $(pwd):/work -w /work docker-user.extrotec.com:30080/mlu-ops/mluops_ci:devel-x86_64-ubuntu18.04-cntoolkit${{matrix.cntoolkit_version}}-cnnl${{matrix.cnnl_version}}
+          -v /testdata:/testdata -v $(pwd):/work -w /work docker-user.extrotec.com:30080/mlu-ops/mluops_ci:devel-x86_64-ubuntu20.04-cntoolkit${{matrix.cntoolkit_version}}-cnnl${{matrix.cnnl_version}}
           ./test.sh --cases_dir=/testdata/release_test/370
 
       - name: test_release_temp_370_cases
         if: matrix.runner == 'mlu370-m8'
         run: >
           docker run --rm --device /dev/cambricon_ctl --device /dev/cambricon_dev0 --device /dev/commu0
-          -v /testdata:/testdata -v $(pwd):/work -w /work docker-user.extrotec.com:30080/mlu-ops/mluops_ci:devel-x86_64-ubuntu18.04-cntoolkit${{matrix.cntoolkit_version}}-cnnl${{matrix.cnnl_version}}
+          -v /testdata:/testdata -v $(pwd):/work -w /work docker-user.extrotec.com:30080/mlu-ops/mluops_ci:devel-x86_64-ubuntu20.04-cntoolkit${{matrix.cntoolkit_version}}-cnnl${{matrix.cnnl_version}}
           ./test.sh --cases_dir=/testdata/release_temp/370
 
       - name: clean

diff --git a/.github/workflows/mluops_all_system_ci.yaml b/.github/workflows/mluops_all_system_ci.yaml
@@ -30,10 +30,10 @@ jobs:
     strategy:
       matrix:
         runner: [mlu370-m8]
-        mlu_ops_version : [0.11.0]
-        cntoolkit_version : [3.7.0]
-        cnnl_version: [1.21.1]
-        os: [ubuntu18.04, ubuntu20.04, centos7, centos8, kylin10]
+        mlu_ops_version : [1.0.0]
+        cntoolkit_version : [3.9.0]
+        cnnl_version: [1.24.0]
+        os: [ubuntu20.04, ubuntu22.04, centos7, centos8, kylin10]
     runs-on: ${{matrix.runner}}
     steps:
       - uses: actions/checkout@v3

diff --git a/.github/workflows/mluops_ci.yaml b/.github/workflows/mluops_ci.yaml
@@ -39,7 +39,7 @@ jobs:
     strategy:
       matrix:
         runner: [mlu370-m8]
-        mlu_ops_version : [v0.11.0]
+        mlu_ops_version : [v1.0.0]
     runs-on: [yellow]
     steps:
       - uses: actions/checkout@v3

diff --git a/README.md b/README.md
@@ -46,11 +46,12 @@ MLU-OPS™提供了以下功能：
 ## 依赖条件
 
 - 操作系统：
-  - 支持 x86_64 下 Ubuntu18.04、Ubuntu20.04、Centos7.6、Centos8.5、Kylin10
+  - 支持 x86_64 下 Ubuntu20.04、Ubuntu22.04、Centos7.6、Centos8.5、Kylin10
+  - MLU-OPS v1.0.0版本后不再发布Ubuntu18.04的软件包
 - 寒武纪 MLU SDK：
-  - 编译和运行时依赖 CNToolkit v3.7.0 或更高版本，CNNL v1.21.1 或者更高版本
+  - 编译和运行时依赖 CNToolkit v3.9.0 或更高版本，CNNL v1.24.0 或者更高版本
 - 寒武纪 MLU 驱动：
-  - 运行时依赖驱动 v5.10.15 或更高版本
+  - 运行时依赖驱动 v5.10.27 或更高版本
 - 外部链接库：
   - libxml2-dev、libprotobuf-dev、protobuf-compiler、llvm-6.0-dev、libeigen3-dev>=3.4
 - Python环境：
@@ -61,6 +62,8 @@ MLU-OPS™提供了以下功能：
 
 - 获取 MLU-OPS™ 代码
 
+以Ubuntu20.04版本为例
+
   ```sh
   git clone https://github.com/Cambricon/mlu-ops.git
   cd mlu-ops
@@ -70,12 +73,12 @@ MLU-OPS™提供了以下功能：
 - 准备 CNToolkit、CNNL 环境
 
   ```sh
-  wget https://sdk.cambricon.com/static/Basis/MLU370_X86_ubuntu18.04/cntoolkit_x.x.x-1.ubuntuxx.xx_amd64.deb
-  wget https://sdk.cambricon.com/static/Basis/MLU370_X86_ubuntu18.04/cnnl_x.x.x-1.ubuntuxx.xx_amd64.deb
-  sudo apt-get install ./cntoolkit-x.x.x_ubuntuxx.xx_amd64.deb
+  wget https://sdk.cambricon.com/static/Basis/MLU370_X86_ubuntu20.04/cntoolkit_3.9.0-1.ubuntu20.04_amd64.deb
+  wget https://sdk.cambricon.com/static/Basis/MLU370_X86_ubuntu20.04/cnnl_1.24.0-1.ubuntu20.04_amd64.deb
+  sudo apt-get install ./cntoolkit-3.9.0-1.ubuntu20.04_amd64.deb
   sudo apt-get update
   sudo apt-get install cncc cnas cnbin cndrv cndev cnrt cnrtc cngdb cnperf
-  sudo apt-get install ./cnnl_x.x.x-x.ubuntuxx.xx_amd64.deb
+  sudo apt-get install ./cnnl_1.24.0-1.ubuntu20.04_amd64.deb
   ```
 
 - 准备 Python-3.8.0 环境

diff --git a/build.property b/build.property
@@ -1,9 +1,9 @@
 {
-  "version": "0.11.0-1",
+  "version": "1.0.0-1",
   "python": "3.6.0",
-  "build_requires": {"cntoolkit": ["release","3.8.4-1"],
-                     "cnnl":["release","1.21.1-1"],
-                     "driver": "5.10.15",
+  "build_requires": {"cntoolkit": ["release","3.9.0-1"],
+                     "cnnl":["release","1.24.0-1"],
+                     "driver": "5.10.27",
                      "eigen3": "3.4.0",
                      "libxml2": "2.9.0",
                      "protoc": "3.6.0"},

diff --git a/docs/api_guide/update.rst b/docs/api_guide/update.rst
@@ -3,6 +3,139 @@ Update History
 
 This section lists contents that were made for each product release.
 
+* V1.0.0
+
+  **Date:** February 6, 2024
+
+  **Changes:**
+
+  - Added the following new operations:
+
+    - ``DCN``
+
+      - mluOpDCNForward
+      - mluOpDCNBackwardWeight
+      - mluOpDCNBackwardData
+      - mluOpCreateDCNDescriptor
+      - mluOpDestroyDCNDescriptor
+      - mluOpSetDCNDescriptor
+      - mluOpGetDCNBakcwardDataWorkspaceSize 
+  - The following APIs are removed:
+
+    - ``add_n``
+
+      - mluOpAddN
+      - mluOpGetAddNWorkspaceSize
+      - mluOpAddN_v2
+
+    - ``copy``
+
+      - mluOpCopy
+
+    - ``concat``
+
+      - mluOpConcat
+      - mluOpGetConcatWorkspaceSize
+
+    - ``expand``
+
+      - mluOpExpand 
+
+    - ``fill``
+
+      - mluOpFill
+      - mluOpFill_v3
+
+    - ``gather_nd``
+
+      - mluOpGatherNd
+
+    - ``matmul``
+
+      - mluOpMatMul
+      - mluOpMatMulDescCreate
+      - mluOpMatMulDescDestroy
+      - mluOpSetMatMulDescAttr
+      - mluOpGetMatMulDescAttr
+      - mluOpCreateMatMulHeuristicResult
+      - mluOpDestroyMatMulHeuristicResult
+      - mluOpGetMatMulHeuristicResult
+      - mluOpGetMatMulAlgoHeuristic
+      - mluOpMatMulAlgoCreate
+      - mluOpMatMulAlgoDestroy
+      - mluOpGetMatMulWorkspaceSize
+      - mluOpMatMul_v2
+
+    - ``nms``
+
+      - mluOpNms
+
+    - ``pad``
+
+      - mluOpPad
+
+    - ``reduce``
+
+      - mluOpReduce
+      - mluOpCreateReduceDescriptor
+      - mluOpDestroyReduceDescriptor
+      - mluOpSetReduceDescriptor
+      - mluOpSetReduceDescriptor_v2
+      - mluOpGetReduceOpWorkspaceSize
+
+    - ``scatter_nd``
+
+      - mluOpScatterNd
+      - mluOpScatterNd_v2
+
+    - ``stride_slice``
+
+      - mluOpStrideSlice
+
+    - ``transform``
+
+      - mluOpTransform
+
+    - ``transpose``
+
+      - mluOpCreateTransposeDescriptor
+      - mluOpDestroyTransposeDescriptor
+      - mluOpSetTransposeDescriptor
+      - mluOpGetTransposeWorkspaceSize
+      - mluOpTranspose
+      - mluOpTranspose_v2
+
+    - ``unique``
+
+      - mluOpUnique
+      - mluOpCreateUniqueDescriptor
+      - mluOpDestroyUniqueDescriptor
+      - mluOpSetUniqueDescriptor
+      - mluOpGetUniqueWorkSpace
+      - mluOpUniqueGetOutLen
+      - mluOpGetUniqueWorkspaceSize
+      - mluOpUnique_v2
+
+    - ``batch_matmul_bcast``
+
+      - mluOpGetBatchMatMulBCastWorkspaceSize
+      - mluOpGetBatchMatMulHeuristicResult
+      - mluOpGetBatchMatMulAlgoHeuristic
+      - mluOpBatchMatMulBCastDescCreate
+      - mluOpBatchMatMulBCastDescDestroy
+      - mluOpSetBatchMatMulBCastDescAttr
+      - mluOpGetBatchMatMulBCastDescAttr
+      - mluOpBatchMatMulBCastAlgoCreate
+      - mluOpBatchMatMulBCastAlgoDestroy
+      - mluOpGetQuantizeBatchMatMulBCastAlgorithm
+      - mluOpGetQuantizeBatchMatMulBCastWorkspaceSize
+      - mluOpQuantizeBatchMatMulBCast
+      - mluOpBatchMatMulBCast
+      - mluOpBatchMatMulBCast_v2
+
+  - Removed BangPy APIs and adjusted repository structure.
+
+
 * V0.11.0
 
   **Date:** December 15, 2023