Updated docs

mlcommons · Mar 6, 2024 · 5a2aa58 · 5a2aa58
1 parent 85e1da4
commit 5a2aa58
Show file tree

Hide file tree

Showing 4 changed files with 160 additions and 11 deletions.
diff --git a/cm-mlops/script/get-croissant/README.md b/cm-mlops/script/get-croissant/README.md
@@ -28,7 +28,7 @@
 
 * Category: *AI/ML datasets.*
 * CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/master/cm-mlops)*
-* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlcommons-croissant)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-croissant)*
 * CM meta description for this script: *[_cm.json](_cm.json)*
 * CM "database" tags to find this script: *get,mlcommons,croissant*
 * Output cached? *True*
@@ -106,7 +106,7 @@ ___
 <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/get-mlcommons-croissant/_cm.json)***
+  1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-croissant/_cm.json)***
      * detect,os
        - CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
      * get,python3
@@ -115,14 +115,14 @@ ___
      * git,repo,_repo.https://github.com/mlcommons/croissant
        * CM names: `--adr.['git-mlcommons-croissant']...`
        - CM script: [get-git-repo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo)
-  1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlcommons-croissant/customize.py)***
-  1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlcommons-croissant/_cm.json)
+  1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-croissant/customize.py)***
+  1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-croissant/_cm.json)
   1. ***Run native script if exists***
-     * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlcommons-croissant/run.bat)
-     * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlcommons-croissant/run.sh)
-  1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlcommons-croissant/_cm.json)
-  1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlcommons-croissant/customize.py)***
-  1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlcommons-croissant/_cm.json)
+     * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-croissant/run.bat)
+     * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-croissant/run.sh)
+  1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-croissant/_cm.json)
+  1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-croissant/customize.py)***
+  1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-croissant/_cm.json)
 </details>
 
 ___

diff --git a/cm-mlops/script/get-google-saxml/README.md b/cm-mlops/script/get-google-saxml/README.md
@@ -0,0 +1,146 @@
+<details>
+<summary>Click here to see the table of contents.</summary>
+
+* [About](#about)
+* [Summary](#summary)
+* [Reuse this script in your project](#reuse-this-script-in-your-project)
+  * [ Install CM automation language](#install-cm-automation-language)
+  * [ Check CM script flags](#check-cm-script-flags)
+  * [ Run this script from command line](#run-this-script-from-command-line)
+  * [ Run this script from Python](#run-this-script-from-python)
+  * [ Run this script via GUI](#run-this-script-via-gui)
+  * [ Run this script via Docker (beta)](#run-this-script-via-docker-(beta))
+* [Customization](#customization)
+  * [ Default environment](#default-environment)
+* [Versions](#versions)
+* [Script workflow, dependencies and native scripts](#script-workflow-dependencies-and-native-scripts)
+* [Script output](#script-output)
+* [New environment keys (filter)](#new-environment-keys-(filter))
+* [New environment keys auto-detected from customize](#new-environment-keys-auto-detected-from-customize)
+* [Maintainers](#maintainers)
+
+</details>
+
+*Note that this README is automatically generated - don't edit!*
+
+### About
+
+#### Summary
+
+* Category: *AI/ML frameworks.*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/master/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-google-saxml)*
+* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
+* CM "database" tags to find this script: *get,google,saxml*
+* Output cached? *True*
+___
+### Reuse this script in your project
+
+#### Install CM automation language
+
+* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
+* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+
+#### Pull CM repository with this automation
+
+```cm pull repo mlcommons@ck```
+
+
+#### Run this script from command line
+
+1. `cm run script --tags=get,google,saxml `
+
+2. `cmr "get google saxml" `
+
+#### Run this script from Python
+
+<details>
+<summary>Click here to expand this section.</summary>
+
+```python
+
+import cmind
+
+r = cmind.access({'action':'run'
+                  'automation':'script',
+                  'tags':'get,google,saxml'
+                  'out':'con',
+                  ...
+                  (other input keys for this script)
+                  ...
+                 })
+
+if r['return']>0:
+    print (r['error'])
+
+```
+
+</details>
+
+
+#### Run this script via GUI
+
+```cmr "cm gui" --script="get,google,saxml"```
+
+Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,google,saxml) to generate CM CMD.
+
+#### Run this script via Docker (beta)
+
+`cm docker script "get google saxml" `
+
+___
+### Customization
+
+#### Default environment
+
+<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.
+
+
+</details>
+
+#### Versions
+Default version: `master`
+
+___
+### 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/get-google-saxml/_cm.yaml)***
+     * detect,os
+       - CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
+     * get,python3
+       * CM names: `--adr.['python3', 'python']...`
+       - CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
+     * get,git,_repo.https://github.com/google/saxml
+       * CM names: `--adr.['google-saxml-git-src']...`
+       - CM script: [get-git-repo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo)
+     * get,bazel
+       * CM names: `--adr.['bazel']...`
+       - CM script: [get-bazel](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-bazel)
+  1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-google-saxml/customize.py)***
+  1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-google-saxml/_cm.yaml)
+  1. ***Run native script if exists***
+     * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-google-saxml/run.bat)
+     * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-google-saxml/run.sh)
+  1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-google-saxml/_cm.yaml)
+  1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-google-saxml/customize.py)***
+  1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-google-saxml/_cm.yaml)
+</details>
+
+___
+### Script output
+`cmr "get google saxml"  -j`
+#### New environment keys (filter)
+
+* `CM_GOOGLE_SAXML*`
+#### New environment keys auto-detected from customize
+
+___
+### Maintainers
+
+* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
diff --git a/cm-mlops/script/install-bazel/README.md b/cm-mlops/script/install-bazel/README.md
@@ -102,7 +102,7 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
 </details>
 
 #### Versions
-Default version: `5.3.0`
+Default version: `7.0.2`
 
 ___
 ### Script workflow, dependencies and native scripts
@@ -117,6 +117,7 @@ ___
   1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-bazel/_cm.json)
   1. ***Run native script if exists***
      * [run-aarch64.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-bazel/run-aarch64.sh)
+     * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-bazel/run.bat)
      * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-bazel/run.sh)
   1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-bazel/_cm.json)
   1. Run "postrocess" function from customize.py
@@ -135,6 +136,8 @@ ___
 #### New environment keys auto-detected from customize
 
 * `CM_BAZEL_BIN_WITH_PATH`
+* `CM_BAZEL_DOWNLOAD_FILE`
+* `CM_BAZEL_DOWNLOAD_URL`
 * `CM_BAZEL_INSTALLED_PATH`
 ___
 ### Maintainers

diff --git a/cm-mlops/script/run-mlperf-inference-app/README.md b/cm-mlops/script/run-mlperf-inference-app/README.md
@@ -270,7 +270,7 @@ ___
 * --**singlestream_target_latency** Set SingleStream target latency
 * --**target_latency** Set Target latency
 * --**target_qps** Set LoadGen target QPS
-* --**j** Print results dictionary to console at the end of the run (*True*)
+* --**j** Print results dictionary to console at the end of the run (*False*)
 * --**repro** Record input/output/state/info files to make it easier to reproduce results (*False*)
 * --**time** Print script execution time at the end of the run (*True*)