Add API docs for ONNX Runtime and Intel

.github/workflows/build_dev_documentation.yml

@@ -48,7 +48,8 @@ jobs:
           cd ..
 
           cd optimum
-          pip install .[dev]
+          apt install -y libopencv-dev python3-opencv
+          pip install .[dev,onnxruntime,intel]
           cd ..
 
       - name: Setup git

.github/workflows/build_documentation.yml

@@ -55,7 +55,8 @@ jobs:
         run: |
           pip install git+https://github.com/huggingface/doc-builder
           cd optimum
-          pip install .[dev]
+          apt install -y libopencv-dev python3-opencv
+          pip install .[dev,onnxruntime,intel]
           cd ..
 
       - name: Setup git

docs/source/_toctree.yml

@@ -2,4 +2,27 @@
   - local: index
     title: 🤗 Optimum
   - local: quickstart
-    title: Quickstart
+    title: Quickstart
+  title: Get started
+- sections:
+  - local: onnxruntime/configuration
+    title: Configuration
+  - local: onnxruntime/optimization
+    title: Optimization
+  - local: onnxruntime/quantization
+    title: Quantization
+  - local: onnxruntime/trainer
+    title: Trainer
+  title: ONNX Runtime
+- sections:
+  - local: intel/configuration
+    title: Configuration
+  - local: intel/optimization
+    title: Optimization
+  - local: intel/quantization
+    title: Quantization
+  - local: intel/pruning
+    title: Pruning
+  - local: intel/trainer
+    title: Trainer
+  title: Intel Neural Compressor

docs/source/intel/configuration.mdx

@@ -0,0 +1,17 @@
+<!--Copyright 2022 The HuggingFace Team. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
+-->
+
+# Configuration
+
+## IncConfig
+
+[[autodoc]] intel.neural_compressor.config.IncConfig

docs/source/intel/optimization.mdx

@@ -0,0 +1,17 @@
+<!--Copyright 2022 The HuggingFace Team. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
+-->
+
+# Optimization
+
+## IncOptimizer
+
+[[autodoc]] intel.neural_compressor.optimizer.IncOptimizer

docs/source/intel/pruning.mdx

@@ -0,0 +1,17 @@
+<!--Copyright 2022 The HuggingFace Team. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
+-->
+
+# Pruning
+
+## IncPruningMode
+
+[[autodoc]] intel.neural_compressor.pruning.IncPruningMode

docs/source/intel/quantization.mdx

@@ -0,0 +1,21 @@
+<!--Copyright 2022 The HuggingFace Team. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
+-->
+
+# Quantization
+
+## IncQuantizer
+
+[[autodoc]] intel.neural_compressor.quantization.IncQuantizer
+
+## IncQuantizedModel
+
+[[autodoc]] intel.neural_compressor.quantization.IncQuantizedModel

docs/source/intel/trainer.mdx

@@ -0,0 +1,17 @@
+<!--Copyright 2022 The HuggingFace Team. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
+-->
+
+# Trainer
+
+## IncTrainer
+
+[[autodoc]] intel.neural_compressor.trainer_inc.IncTrainer

docs/source/onnxruntime/configuration.mdx

@@ -0,0 +1,17 @@
+<!--Copyright 2022 The HuggingFace Team. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
+-->
+
+# Configuration
+
+## ORTConfig
+
+[[autodoc]] onnxruntime.configuration.ORTConfig

docs/source/onnxruntime/optimization.mdx

@@ -0,0 +1,17 @@
+<!--Copyright 2022 The HuggingFace Team. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
+-->
+
+# Optimization
+
+## ORTOptimizer
+
+[[autodoc]] onnxruntime.optimization.ORTOptimizer

docs/source/onnxruntime/quantization.mdx

@@ -0,0 +1,21 @@
+<!--Copyright 2022 The HuggingFace Team. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
+-->
+
+# Quantization
+
+## ORTCalibrationDataReader
+
+[[autodoc]] onnxruntime.quantization.ORTCalibrationDataReader
+
+## ORTQuantizer
+
+[[autodoc]] onnxruntime.quantization.ORTQuantizer

docs/source/onnxruntime/trainer.mdx

@@ -0,0 +1,17 @@
+<!--Copyright 2022 The HuggingFace Team. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
+-->
+
+# Trainer
+
+## ORTTrainer
+
+[[autodoc]] onnxruntime.trainer.ORTTrainer

optimum/intel/__init__.py

@@ -11,3 +11,9 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
+
+from .neural_compressor.config import IncConfig, IncPruningConfig, IncQuantizationConfig
+from .neural_compressor.optimizer import IncOptimizer
+from .neural_compressor.pruning import IncPruner, IncPruningMode
+from .neural_compressor.quantization import IncQuantizationMode, IncQuantizer
+from .neural_compressor.trainer_inc import IncTrainer