Merge pull request #23 from anandhu-eng/docs

Documentation support added

.github/workflows/publish.yaml

@@ -0,0 +1,33 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Publish site
+
+
+on:
+  release:
+    types: [published]
+  push:
+    branches:
+      - main
+      - docs
+
+jobs:
+
+  publish:
+    name: Publish the site
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository normally
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Install Mkdocs
+        run: pip install -r docs/requirements.txt
+
+      - name: Run Mkdocs deploy
+        run: mkdocs gh-deploy --force

docs/AI-ML-datasets/index.md

@@ -0,0 +1,29 @@
+The AI/ML datasets category contains the following scripts:
+
+- [get-croissant](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-croissant/README.md)
+- [get-dataset-cifar10](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-dataset-cifar10/README.md)
+- [get-dataset-cnndm](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-dataset-cnndm/README.md)
+- [get-dataset-coco](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-dataset-coco/README.md)
+- [get-dataset-coco2014](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-dataset-coco2014/README.md)
+- [get-dataset-criteo](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-dataset-criteo/README.md)
+- [get-dataset-imagenet-aux](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-dataset-imagenet-aux/README.md)
+- [get-dataset-imagenet-calibration](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-dataset-imagenet-calibration/README.md)
+- [get-dataset-imagenet-helper](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-dataset-imagenet-helper/README.md)
+- [get-dataset-imagenet-train](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-dataset-imagenet-train/README.md)
+- [get-dataset-imagenet-val](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-dataset-imagenet-val/README.md)
+- [get-dataset-kits19](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-dataset-kits19/README.md)
+- [get-dataset-librispeech](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-dataset-librispeech/README.md)
+- [get-dataset-openimages](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-dataset-openimages/README.md)
+- [get-dataset-openimages-annotations](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-dataset-openimages-annotations/README.md)
+- [get-dataset-openimages-calibration](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-dataset-openimages-calibration/README.md)
+- [get-dataset-openorca](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-dataset-openorca/README.md)
+- [get-dataset-squad](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-dataset-squad/README.md)
+- [get-dataset-squad-vocab](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-dataset-squad-vocab/README.md)
+- [get-preprocessed-dataset-criteo](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-preprocessed-dataset-criteo/README.md)
+- [get-preprocessed-dataset-generic](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-preprocessed-dataset-generic/README.md)
+- [get-preprocessed-dataset-imagenet](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-preprocessed-dataset-imagenet/README.md)
+- [get-preprocessed-dataset-kits19](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-preprocessed-dataset-kits19/README.md)
+- [get-preprocessed-dataset-librispeech](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-preprocessed-dataset-librispeech/README.md)
+- [get-preprocessed-dataset-openimages](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-preprocessed-dataset-openimages/README.md)
+- [get-preprocessed-dataset-openorca](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-preprocessed-dataset-openorca/README.md)
+- [get-preprocessed-dataset-squad](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-preprocessed-dataset-squad/README.md)

docs/AI-ML-frameworks/index.md

@@ -0,0 +1,14 @@
+The AI/ML frameworks category contains the following scripts:
+
+- [get-google-saxml](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-google-saxml/README.md)
+- [get-onnxruntime-prebuilt](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-onnxruntime-prebuilt/README.md)
+- [get-qaic-apps-sdk](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-qaic-apps-sdk/README.md)
+- [get-qaic-platform-sdk](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-qaic-platform-sdk/README.md)
+- [get-qaic-software-kit](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-qaic-software-kit/README.md)
+- [get-rocm](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-rocm/README.md)
+- [get-tvm](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-tvm/README.md)
+- [install-qaic-compute-sdk-from-src](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-qaic-compute-sdk-from-src/README.md)
+- [install-rocm](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-rocm/README.md)
+- [install-tensorflow-for-c](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-tensorflow-for-c/README.md)
+- [install-tensorflow-from-src](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-tensorflow-from-src/README.md)
+- [install-tflite-from-src](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-tflite-from-src/README.md)

docs/AI-ML-models/index.md

@@ -0,0 +1,23 @@
+The AI/ML models category contains the following scripts:
+
+- [convert-ml-model-huggingface-to-onnx](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/convert-ml-model-huggingface-to-onnx/README.md)
+- [get-bert-squad-vocab](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-bert-squad-vocab/README.md)
+- [get-dlrm](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-dlrm/README.md)
+- [get-ml-model-3d-unet-kits19](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-ml-model-3d-unet-kits19/README.md)
+- [get-ml-model-bert-base-squad](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-ml-model-bert-base-squad/README.md)
+- [get-ml-model-bert-large-squad](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-ml-model-bert-large-squad/README.md)
+- [get-ml-model-dlrm-terabyte](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-ml-model-dlrm-terabyte/README.md)
+- [get-ml-model-efficientnet-lite](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-ml-model-efficientnet-lite/README.md)
+- [get-ml-model-gptj](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-ml-model-gptj/README.md)
+- [get-ml-model-huggingface-zoo](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-ml-model-huggingface-zoo/README.md)
+- [get-ml-model-llama2](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-ml-model-llama2/README.md)
+- [get-ml-model-mobilenet](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-ml-model-mobilenet/README.md)
+- [get-ml-model-neuralmagic-zoo](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-ml-model-neuralmagic-zoo/README.md)
+- [get-ml-model-resnet50](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-ml-model-resnet50/README.md)
+- [get-ml-model-retinanet](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-ml-model-retinanet/README.md)
+- [get-ml-model-retinanet-nvidia](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-ml-model-retinanet-nvidia/README.md)
+- [get-ml-model-rnnt](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-ml-model-rnnt/README.md)
+- [get-ml-model-stable-diffusion](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-ml-model-stable-diffusion/README.md)
+- [get-ml-model-tiny-resnet](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-ml-model-tiny-resnet/README.md)
+- [get-ml-model-using-imagenet-from-model-zoo](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-ml-model-using-imagenet-from-model-zoo/README.md)
+- [get-tvm-model](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-tvm-model/README.md)

docs/AI-ML-optimization/index.md

@@ -0,0 +1,5 @@
+The AI/ML optimization category contains the following scripts:
+
+- [calibrate-model-for.qaic](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/calibrate-model-for.qaic/README.md)
+- [compile-model-for.qaic](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/compile-model-for.qaic/README.md)
+- [prune-bert-models](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/prune-bert-models/README.md)

docs/CM-Interface/index.md

@@ -0,0 +1,3 @@
+The CM Interface category contains the following scripts:
+
+- [get-cache-dir](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-cache-dir/README.md)

docs/CM-automation/index.md

@@ -0,0 +1,3 @@
+The CM automation category contains the following scripts:
+
+- [create-custom-cache-entry](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/create-custom-cache-entry/README.md)

docs/CM-interface-prototyping/index.md

@@ -0,0 +1,4 @@
+The CM interface prototyping category contains the following scripts:
+
+- [test-debug](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/test-debug/README.md)
+- [test-mlperf-inference-retinanet](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/test-mlperf-inference-retinanet/README.md)

docs/CUDA-automation/index.md

@@ -0,0 +1,8 @@
+The CUDA automation category contains the following scripts:
+
+- [get-cuda](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-cuda/README.md)
+- [get-cuda-devices](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-cuda-devices/README.md)
+- [get-cudnn](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-cudnn/README.md)
+- [get-tensorrt](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-tensorrt/README.md)
+- [install-cuda-package-manager](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-cuda-package-manager/README.md)
+- [install-cuda-prebuilt](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-cuda-prebuilt/README.md)

docs/Cloud-automation/index.md

@@ -0,0 +1,8 @@
+The Cloud automation category contains the following scripts:
+
+- [destroy-terraform](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/destroy-terraform/README.md)
+- [get-aws-cli](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-aws-cli/README.md)
+- [get-terraform](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-terraform/README.md)
+- [install-aws-cli](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-aws-cli/README.md)
+- [install-terraform-from-src](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-terraform-from-src/README.md)
+- [run-terraform](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/run-terraform/README.md)

docs/Collective-benchmarking/index.md

@@ -0,0 +1,3 @@
+The Collective benchmarking category contains the following scripts:
+
+- [launch-benchmark](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/launch-benchmark/README.md)

docs/Compiler-automation/index.md

@@ -0,0 +1,20 @@
+The Compiler automation category contains the following scripts:
+
+- [get-aocl](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-aocl/README.md)
+- [get-cl](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-cl/README.md)
+- [get-compiler-flags](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-compiler-flags/README.md)
+- [get-compiler-rust](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-compiler-rust/README.md)
+- [get-gcc](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-gcc/README.md)
+- [get-go](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-go/README.md)
+- [get-llvm](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-llvm/README.md)
+- [install-gcc-src](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-gcc-src/README.md)
+- [install-ipex-from-src](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-ipex-from-src/README.md)
+- [install-llvm-prebuilt](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-llvm-prebuilt/README.md)
+- [install-llvm-src](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-llvm-src/README.md)
+- [install-onednn-from-src](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-onednn-from-src/README.md)
+- [install-onnxruntime-from-src](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-onnxruntime-from-src/README.md)
+- [install-pytorch-from-src](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-pytorch-from-src/README.md)
+- [install-pytorch-kineto-from-src](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-pytorch-kineto-from-src/README.md)
+- [install-torchvision-from-src](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-torchvision-from-src/README.md)
+- [install-tpp-pytorch-extension](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-tpp-pytorch-extension/README.md)
+- [install-transformers-from-src](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-transformers-from-src/README.md)

docs/Dashboard-automation/index.md

@@ -0,0 +1,3 @@
+The Dashboard automation category contains the following scripts:
+
+- [publish-results-to-dashboard](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/publish-results-to-dashboard/README.md)

docs/Detection-or-installation-of-tools-and-artifacts/index.md

@@ -0,0 +1,31 @@
+The Detection or installation of tools and artifacts category contains the following scripts:
+
+- [get-android-sdk](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-android-sdk/README.md)
+- [get-aria2](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-aria2/README.md)
+- [get-bazel](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-bazel/README.md)
+- [get-blis](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-blis/README.md)
+- [get-brew](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-brew/README.md)
+- [get-cmake](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-cmake/README.md)
+- [get-cmsis_5](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-cmsis_5/README.md)
+- [get-docker](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-docker/README.md)
+- [get-generic-sys-util](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-generic-sys-util/README.md)
+- [get-google-test](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-google-test/README.md)
+- [get-java](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-java/README.md)
+- [get-javac](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-javac/README.md)
+- [get-lib-armnn](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-lib-armnn/README.md)
+- [get-lib-dnnl](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-lib-dnnl/README.md)
+- [get-lib-protobuf](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-lib-protobuf/README.md)
+- [get-lib-qaic-api](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-lib-qaic-api/README.md)
+- [get-nvidia-docker](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-nvidia-docker/README.md)
+- [get-openssl](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-openssl/README.md)
+- [get-rclone](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-rclone/README.md)
+- [get-sys-utils-cm](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-sys-utils-cm/README.md)
+- [get-sys-utils-min](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-sys-utils-min/README.md)
+- [get-xilinx-sdk](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-xilinx-sdk/README.md)
+- [get-zendnn](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/get-zendnn/README.md)
+- [install-bazel](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-bazel/README.md)
+- [install-cmake-prebuilt](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-cmake-prebuilt/README.md)
+- [install-gflags](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-gflags/README.md)
+- [install-github-cli](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-github-cli/README.md)
+- [install-numactl-from-src](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-numactl-from-src/README.md)
+- [install-openssl](https://github.com/anandhu-eng/cm4mlops/tree/mlperf-inference/script/install-openssl/README.md)