Updated autogenerated READMEs

Ailurus1 · Apr 12, 2023 · b04832e · b04832e
1 parent 29d6e96
commit b04832e
Show file tree

Hide file tree

Showing 147 changed files with 4,139 additions and 2,373 deletions.
diff --git a/cm-mlops/automation/script/template_list_of_scripts.md b/cm-mlops/automation/script/template_list_of_scripts.md
@@ -30,4 +30,4 @@ design space exploration and deployment across continuously changing software an
 
 # Maintainers
 
-* [Open MLCommons taskforce on education and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/mlperf-education-workgroup.md)'
+* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)'
diff --git a/cm-mlops/script/activate-python-venv/README.md b/cm-mlops/script/activate-python-venv/README.md
@@ -44,21 +44,25 @@ ___
 
 [Guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
 
-#### CM script automation help
+##### CM pull repository
+
+```cm pull repo mlcommons@ck```
+
+##### CM script automation help
 
 ```cm run script --help```
 
 #### CM CLI
 
-`cm run script --tags=activate,python,activate-python-venv,python-venv(,variations from below) (flags from below)`
+1. `cm run script --tags=activate,python,activate-python-venv,python-venv `
 
-*or*
+2. `cm run script "activate python activate-python-venv python-venv" `
 
-`cm run script "activate python activate-python-venv python-venv (variations from below)" (flags from below)`
+3. `cm run script fcbbb84946f34c55 `
 
-*or*
+* `variations` can be seen [here](#variations)
 
-`cm run script fcbbb84946f34c55`
+* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
 
 #### CM Python API
 
@@ -104,14 +108,17 @@ ___
 <details>
 <summary>Click here to expand this section.</summary>
 
-These keys can be updated via --env.KEY=VALUE or "env" dictionary in @input.json or using script flags.
+These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.json` or using script flags.
 
 
 </details>
 
 ___
 ### Script workflow, dependencies and native scripts
 
+<details>
+<summary>Click here to expand this section.</summary>
+
   1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/activate-python-venv/_cm.json)
   1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/activate-python-venv/customize.py)***
   1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/activate-python-venv/_cm.json)***
@@ -124,6 +131,8 @@ ___
   1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/activate-python-venv/_cm.json)
   1. Run "postrocess" function from customize.py
   1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/activate-python-venv/_cm.json)
+</details>
+
 ___
 ### Script output
 #### New environment keys (filter)
@@ -133,4 +142,4 @@ ___
 ___
 ### Maintainers
 
-* [Open MLCommons taskforce on education and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/mlperf-education-workgroup.md)
+* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
diff --git a/cm-mlops/script/add-custom-nvidia-system/README.md b/cm-mlops/script/add-custom-nvidia-system/README.md
@@ -42,21 +42,25 @@ ___
 
 [Guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
 
-#### CM script automation help
+##### CM pull repository
+
+```cm pull repo mlcommons@ck```
+
+##### CM script automation help
 
 ```cm run script --help```
 
 #### CM CLI
 
-`cm run script --tags=add,custom,system,nvidia(,variations from below) (flags from below)`
+1. `cm run script --tags=add,custom,system,nvidia `
 
-*or*
+2. `cm run script "add custom system nvidia" `
 
-`cm run script "add custom system nvidia (variations from below)" (flags from below)`
+3. `cm run script b2e6c46c6e8745a3 `
 
-*or*
+* `variations` can be seen [here](#variations)
 
-`cm run script b2e6c46c6e8745a3`
+* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
 
 #### CM Python API
 
@@ -102,14 +106,17 @@ ___
 <details>
 <summary>Click here to expand this section.</summary>
 
-These keys can be updated via --env.KEY=VALUE or "env" dictionary in @input.json or using script flags.
+These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.json` or using script flags.
 
 
 </details>
 
 ___
 ### Script workflow, dependencies and native scripts
 
+<details>
+<summary>Click here to expand this section.</summary>
+
   1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/add-custom-nvidia-system/_cm.yaml)***
      * detect,os
        - CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
@@ -126,8 +133,6 @@ ___
        - CM script: [get-tensorrt](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tensorrt)
      * get,cmake
        - CM script: [get-cmake](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmake)
-     * get,generic-python-lib,_nvidia-tensorrt
-       - CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
      * get,generic-python-lib,_requests
        - CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
      * get,generic,sys-util,_glog-dev
@@ -154,6 +159,8 @@ ___
   1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/add-custom-nvidia-system/_cm.yaml)
   1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/add-custom-nvidia-system/customize.py)***
   1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/add-custom-nvidia-system/_cm.yaml)
+</details>
+
 ___
 ### Script output
 #### New environment keys (filter)
@@ -163,4 +170,4 @@ ___
 ___
 ### Maintainers
 
-* [Open MLCommons taskforce on education and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/mlperf-education-workgroup.md)
+* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
diff --git a/cm-mlops/script/app-image-classification-onnx-cpp/README.md b/cm-mlops/script/app-image-classification-onnx-cpp/README.md
@@ -42,21 +42,25 @@ ___
 
 [Guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
 
-#### CM script automation help
+##### CM pull repository
+
+```cm pull repo mlcommons@ck```
+
+##### CM script automation help
 
 ```cm run script --help```
 
 #### CM CLI
 
-`cm run script --tags=app,image-classification,onnx,cpp(,variations from below) (flags from below)`
+1. `cm run script --tags=app,image-classification,onnx,cpp `
 
-*or*
+2. `cm run script "app image-classification onnx cpp" `
 
-`cm run script "app image-classification onnx cpp (variations from below)" (flags from below)`
+3. `cm run script 879ed32e47074033 `
 
-*or*
+* `variations` can be seen [here](#variations)
 
-`cm run script 879ed32e47074033`
+* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
 
 #### CM Python API
 
@@ -102,16 +106,19 @@ ___
 <details>
 <summary>Click here to expand this section.</summary>
 
-These keys can be updated via --env.KEY=VALUE or "env" dictionary in @input.json or using script flags.
+These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.json` or using script flags.
 
-* CM_BATCH_COUNT: **1**
-* CM_BATCH_SIZE: **1**
+* CM_BATCH_COUNT: `1`
+* CM_BATCH_SIZE: `1`
 
 </details>
 
 ___
 ### Script workflow, dependencies and native scripts
 
+<details>
+<summary>Click here to expand this section.</summary>
+
   1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-onnx-cpp/_cm.json)***
      * detect,os
        - CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
@@ -136,6 +143,8 @@ ___
   1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-onnx-cpp/_cm.json)
   1. Run "postrocess" function from customize.py
   1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-onnx-cpp/_cm.json)
+</details>
+
 ___
 ### Script output
 #### New environment keys (filter)
@@ -145,4 +154,4 @@ ___
 ___
 ### Maintainers
 
-* [Open MLCommons taskforce on education and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/mlperf-education-workgroup.md)
+* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
diff --git a/cm-mlops/script/app-image-classification-onnx-py/README.md b/cm-mlops/script/app-image-classification-onnx-py/README.md
@@ -43,21 +43,25 @@ ___
 
 [Guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
 
-#### CM script automation help
+##### CM pull repository
+
+```cm pull repo mlcommons@ck```
+
+##### CM script automation help
 
 ```cm run script --help```
 
 #### CM CLI
 
-`cm run script --tags=app,image-classification,onnx,python(,variations from below) (flags from below)`
+1. `cm run script --tags=app,image-classification,onnx,python[,variations] `
 
-*or*
+2. `cm run script "app image-classification onnx python[,variations]" `
 
-`cm run script "app image-classification onnx python (variations from below)" (flags from below)`
+3. `cm run script 3d5e908e472b417e `
 
-*or*
+* `variations` can be seen [here](#variations)
 
-`cm run script 3d5e908e472b417e`
+* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
 
 #### CM Python API
 
@@ -117,16 +121,19 @@ ___
 <details>
 <summary>Click here to expand this section.</summary>
 
-These keys can be updated via --env.KEY=VALUE or "env" dictionary in @input.json or using script flags.
+These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.json` or using script flags.
 
-* CM_BATCH_COUNT: **1**
-* CM_BATCH_SIZE: **1**
+* CM_BATCH_COUNT: `1`
+* CM_BATCH_SIZE: `1`
 
 </details>
 
 ___
 ### Script workflow, dependencies and native scripts
 
+<details>
+<summary>Click here to expand this section.</summary>
+
   1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-onnx-py/_cm.yaml)***
      * detect,os
        - CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
@@ -160,6 +167,8 @@ ___
   1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-onnx-py/_cm.yaml)
   1. Run "postrocess" function from customize.py
   1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-onnx-py/_cm.yaml)
+</details>
+
 ___
 ### Script output
 #### New environment keys (filter)
@@ -169,4 +178,4 @@ ___
 ___
 ### Maintainers
 
-* [Open MLCommons taskforce on education and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/mlperf-education-workgroup.md)
+* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
diff --git a/cm-mlops/script/app-image-classification-torch-py/README.md b/cm-mlops/script/app-image-classification-torch-py/README.md
@@ -43,21 +43,25 @@ ___
 
 [Guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
 
-#### CM script automation help
+##### CM pull repository
+
+```cm pull repo mlcommons@ck```
+
+##### CM script automation help
 
 ```cm run script --help```
 
 #### CM CLI
 
-`cm run script --tags=app,image-classification,torch,python(,variations from below) (flags from below)`
+1. `cm run script --tags=app,image-classification,torch,python[,variations] `
 
-*or*
+2. `cm run script "app image-classification torch python[,variations]" `
 
-`cm run script "app image-classification torch python (variations from below)" (flags from below)`
+3. `cm run script e3986ae887b84ca8 `
 
-*or*
+* `variations` can be seen [here](#variations)
 
-`cm run script e3986ae887b84ca8`
+* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
 
 #### CM Python API
 
@@ -120,16 +124,19 @@ ___
 <details>
 <summary>Click here to expand this section.</summary>
 
-These keys can be updated via --env.KEY=VALUE or "env" dictionary in @input.json or using script flags.
+These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.json` or using script flags.
 
-* CM_BATCH_COUNT: **1**
-* CM_BATCH_SIZE: **1**
+* CM_BATCH_COUNT: `1`
+* CM_BATCH_SIZE: `1`
 
 </details>
 
 ___
 ### Script workflow, dependencies and native scripts
 
+<details>
+<summary>Click here to expand this section.</summary>
+
   1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-torch-py/_cm.json)***
      * detect,os
        - CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
@@ -167,6 +174,8 @@ ___
   1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-torch-py/_cm.json)
   1. Run "postrocess" function from customize.py
   1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-torch-py/_cm.json)
+</details>
+
 ___
 ### Script output
 #### New environment keys (filter)
@@ -176,4 +185,4 @@ ___
 ___
 ### Maintainers
 
-* [Open MLCommons taskforce on education and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/mlperf-education-workgroup.md)
+* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -30,4 +30,4 @@ design space exploration and deployment across continuously changing software an

		# Maintainers

		* [Open MLCommons taskforce on education and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/mlperf-education-workgroup.md)'
		* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)'