diff --git a/README.md b/README.md
index 3163169579..5116821be5 100755
--- a/README.md
+++ b/README.md
@@ -154,6 +154,11 @@ pip install cmind -U
cm pull repo mlcommons@ck
+cm checkout repo mlcommons@ck --branch=dev
+cm checkout repo mlcommons@ck --branch=master
+
+cm rm cache -f
+
cm run script "python app image-classification onnx"
cmr "python app image-classification onnx"
diff --git a/cm-mlops/automation/cache/README.md b/cm-mlops/automation/cache/README.md
index 3412bc696a..0a3114d3b5 100644
--- a/cm-mlops/automation/cache/README.md
+++ b/cm-mlops/automation/cache/README.md
@@ -62,6 +62,26 @@
print(r['error'])
```
+#### copy_to_remote
+
+ * CM CLI: ```cm copy_to_remote cache``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/cache/module.py#L186))
+ * CM CLI with UID: ```cm copy_to_remote cache,541d6f712a6b464e``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/cache/module.py#L186))
+ * CM Python API:
+ ```python
+ import cmind
+
+ r=cm.access({
+ 'action':'copy_to_remote'
+ 'automation':'cache,541d6f712a6b464e'
+ 'out':'con'
+ ```
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/cache/module.py#L186)
+ ```python
+ })
+ if r['return']>0:
+ print(r['error'])
+ ```
+
### Maintainers
* [Open MLCommons taskforce on automation and reproducibility](https://cKnowledge.org/mlcommons-taskforce)
\ No newline at end of file
diff --git a/cm-mlops/automation/cfg/README.md b/cm-mlops/automation/cfg/README.md
new file mode 100644
index 0000000000..3c82852c8d
--- /dev/null
+++ b/cm-mlops/automation/cfg/README.md
@@ -0,0 +1,27 @@
+*This README is automatically generated - don't edit! Use `README-extra.md` for extra notes!*
+
+### Automation actions
+
+#### test
+
+ * CM CLI: ```cm test cfg``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/cfg/module.py#L15))
+ * CM CLI with UID: ```cm test cfg,88dce9c160324c5d``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/cfg/module.py#L15))
+ * CM Python API:
+ ```python
+ import cmind
+
+ r=cm.access({
+ 'action':'test'
+ 'automation':'cfg,88dce9c160324c5d'
+ 'out':'con'
+ ```
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/cfg/module.py#L15)
+ ```python
+ })
+ if r['return']>0:
+ print(r['error'])
+ ```
+
+### Maintainers
+
+* [Open MLCommons taskforce on automation and reproducibility](https://cKnowledge.org/mlcommons-taskforce)
\ No newline at end of file
diff --git a/cm-mlops/automation/experiment/README.md b/cm-mlops/automation/experiment/README.md
index e8f5c319f0..13ea6ec1a5 100644
--- a/cm-mlops/automation/experiment/README.md
+++ b/cm-mlops/automation/experiment/README.md
@@ -44,8 +44,8 @@
#### rerun
- * CM CLI: ```cm rerun experiment``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L417))
- * CM CLI with UID: ```cm rerun experiment,a0a2d123ef064bcb``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L417))
+ * CM CLI: ```cm rerun experiment``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L428))
+ * CM CLI with UID: ```cm rerun experiment,a0a2d123ef064bcb``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L428))
* CM Python API:
```python
import cmind
@@ -55,7 +55,7 @@
'automation':'experiment,a0a2d123ef064bcb'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L417)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L428)
```python
})
if r['return']>0:
@@ -64,8 +64,8 @@
#### replay
- * CM CLI: ```cm replay experiment``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L440))
- * CM CLI with UID: ```cm replay experiment,a0a2d123ef064bcb``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L440))
+ * CM CLI: ```cm replay experiment``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L451))
+ * CM CLI with UID: ```cm replay experiment,a0a2d123ef064bcb``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L451))
* CM Python API:
```python
import cmind
@@ -75,7 +75,7 @@
'automation':'experiment,a0a2d123ef064bcb'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L440)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L451)
```python
})
if r['return']>0:
diff --git a/cm-mlops/automation/script/README.md b/cm-mlops/automation/script/README.md
index 823c6ee0ce..da54b2a5db 100644
--- a/cm-mlops/automation/script/README.md
+++ b/cm-mlops/automation/script/README.md
@@ -4,8 +4,8 @@
#### run
- * CM CLI: ```cm run script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L72))
- * CM CLI with UID: ```cm run script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L72))
+ * CM CLI: ```cm run script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L77))
+ * CM CLI with UID: ```cm run script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L77))
* CM Python API:
```python
import cmind
@@ -15,7 +15,7 @@
'automation':'script,5b4e0237da074764'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L72)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L77)
```python
})
if r['return']>0:
@@ -24,8 +24,8 @@
#### version
- * CM CLI: ```cm version script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L1749))
- * CM CLI with UID: ```cm version script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L1749))
+ * CM CLI: ```cm version script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2041))
+ * CM CLI with UID: ```cm version script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2041))
* CM Python API:
```python
import cmind
@@ -35,7 +35,7 @@
'automation':'script,5b4e0237da074764'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L1749)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2041)
```python
})
if r['return']>0:
@@ -44,8 +44,8 @@
#### search
- * CM CLI: ```cm search script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L1777))
- * CM CLI with UID: ```cm search script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L1777))
+ * CM CLI: ```cm search script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2069))
+ * CM CLI with UID: ```cm search script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2069))
* CM Python API:
```python
import cmind
@@ -55,7 +55,7 @@
'automation':'script,5b4e0237da074764'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L1777)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2069)
```python
})
if r['return']>0:
@@ -64,8 +64,8 @@
#### test
- * CM CLI: ```cm test script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L1887))
- * CM CLI with UID: ```cm test script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L1887))
+ * CM CLI: ```cm test script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2188))
+ * CM CLI with UID: ```cm test script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2188))
* CM Python API:
```python
import cmind
@@ -75,7 +75,7 @@
'automation':'script,5b4e0237da074764'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L1887)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2188)
```python
})
if r['return']>0:
@@ -84,8 +84,8 @@
#### native_run
- * CM CLI: ```cm native_run script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L1953))
- * CM CLI with UID: ```cm native_run script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L1953))
+ * CM CLI: ```cm native_run script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2254))
+ * CM CLI with UID: ```cm native_run script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2254))
* CM Python API:
```python
import cmind
@@ -95,7 +95,7 @@
'automation':'script,5b4e0237da074764'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L1953)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2254)
```python
})
if r['return']>0:
@@ -104,8 +104,8 @@
#### add
- * CM CLI: ```cm add script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2026))
- * CM CLI with UID: ```cm add script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2026))
+ * CM CLI: ```cm add script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2327))
+ * CM CLI with UID: ```cm add script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2327))
* CM Python API:
```python
import cmind
@@ -115,7 +115,7 @@
'automation':'script,5b4e0237da074764'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2026)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2327)
```python
})
if r['return']>0:
@@ -124,8 +124,8 @@
#### run_native_script
- * CM CLI: ```cm run_native_script script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2624))
- * CM CLI with UID: ```cm run_native_script script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2624))
+ * CM CLI: ```cm run_native_script script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2955))
+ * CM CLI with UID: ```cm run_native_script script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2955))
* CM Python API:
```python
import cmind
@@ -135,7 +135,7 @@
'automation':'script,5b4e0237da074764'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2624)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2955)
```python
})
if r['return']>0:
@@ -144,8 +144,8 @@
#### find_file_in_paths
- * CM CLI: ```cm find_file_in_paths script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2665))
- * CM CLI with UID: ```cm find_file_in_paths script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2665))
+ * CM CLI: ```cm find_file_in_paths script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2996))
+ * CM CLI with UID: ```cm find_file_in_paths script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2996))
* CM Python API:
```python
import cmind
@@ -155,7 +155,7 @@
'automation':'script,5b4e0237da074764'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2665)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2996)
```python
})
if r['return']>0:
@@ -164,8 +164,8 @@
#### detect_version_using_script
- * CM CLI: ```cm detect_version_using_script script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2879))
- * CM CLI with UID: ```cm detect_version_using_script script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2879))
+ * CM CLI: ```cm detect_version_using_script script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3215))
+ * CM CLI with UID: ```cm detect_version_using_script script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3215))
* CM Python API:
```python
import cmind
@@ -175,7 +175,7 @@
'automation':'script,5b4e0237da074764'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2879)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3215)
```python
})
if r['return']>0:
@@ -184,8 +184,8 @@
#### find_artifact
- * CM CLI: ```cm find_artifact script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2952))
- * CM CLI with UID: ```cm find_artifact script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2952))
+ * CM CLI: ```cm find_artifact script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3288))
+ * CM CLI with UID: ```cm find_artifact script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3288))
* CM Python API:
```python
import cmind
@@ -195,7 +195,7 @@
'automation':'script,5b4e0237da074764'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2952)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3288)
```python
})
if r['return']>0:
@@ -204,8 +204,8 @@
#### find_file_deep
- * CM CLI: ```cm find_file_deep script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3110))
- * CM CLI with UID: ```cm find_file_deep script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3110))
+ * CM CLI: ```cm find_file_deep script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3446))
+ * CM CLI with UID: ```cm find_file_deep script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3446))
* CM Python API:
```python
import cmind
@@ -215,7 +215,7 @@
'automation':'script,5b4e0237da074764'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3110)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3446)
```python
})
if r['return']>0:
@@ -224,8 +224,8 @@
#### find_file_back
- * CM CLI: ```cm find_file_back script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3168))
- * CM CLI with UID: ```cm find_file_back script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3168))
+ * CM CLI: ```cm find_file_back script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3504))
+ * CM CLI with UID: ```cm find_file_back script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3504))
* CM Python API:
```python
import cmind
@@ -235,7 +235,7 @@
'automation':'script,5b4e0237da074764'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3168)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3504)
```python
})
if r['return']>0:
@@ -244,8 +244,8 @@
#### parse_version
- * CM CLI: ```cm parse_version script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3209))
- * CM CLI with UID: ```cm parse_version script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3209))
+ * CM CLI: ```cm parse_version script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3545))
+ * CM CLI with UID: ```cm parse_version script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3545))
* CM Python API:
```python
import cmind
@@ -255,7 +255,7 @@
'automation':'script,5b4e0237da074764'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3209)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3545)
```python
})
if r['return']>0:
@@ -264,8 +264,8 @@
#### update_deps
- * CM CLI: ```cm update_deps script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3263))
- * CM CLI with UID: ```cm update_deps script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3263))
+ * CM CLI: ```cm update_deps script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3599))
+ * CM CLI with UID: ```cm update_deps script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3599))
* CM Python API:
```python
import cmind
@@ -275,7 +275,7 @@
'automation':'script,5b4e0237da074764'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3263)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3599)
```python
})
if r['return']>0:
@@ -284,8 +284,8 @@
#### get_default_path_list
- * CM CLI: ```cm get_default_path_list script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3282))
- * CM CLI with UID: ```cm get_default_path_list script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3282))
+ * CM CLI: ```cm get_default_path_list script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3619))
+ * CM CLI with UID: ```cm get_default_path_list script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3619))
* CM Python API:
```python
import cmind
@@ -295,7 +295,7 @@
'automation':'script,5b4e0237da074764'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3282)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3619)
```python
})
if r['return']>0:
@@ -304,8 +304,8 @@
#### doc
- * CM CLI: ```cm doc script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3293))
- * CM CLI with UID: ```cm doc script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3293))
+ * CM CLI: ```cm doc script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3630))
+ * CM CLI with UID: ```cm doc script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3630))
* CM Python API:
```python
import cmind
@@ -315,7 +315,27 @@
'automation':'script,5b4e0237da074764'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3293)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3630)
+ ```python
+ })
+ if r['return']>0:
+ print(r['error'])
+ ```
+
+#### gui
+
+ * CM CLI: ```cm gui script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3658))
+ * CM CLI with UID: ```cm gui script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3658))
+ * CM Python API:
+ ```python
+ import cmind
+
+ r=cm.access({
+ 'action':'gui'
+ 'automation':'script,5b4e0237da074764'
+ 'out':'con'
+ ```
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3658)
```python
})
if r['return']>0:
@@ -324,8 +344,8 @@
#### dockerfile
- * CM CLI: ```cm dockerfile script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3322))
- * CM CLI with UID: ```cm dockerfile script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3322))
+ * CM CLI: ```cm dockerfile script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3695))
+ * CM CLI with UID: ```cm dockerfile script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3695))
* CM Python API:
```python
import cmind
@@ -335,7 +355,7 @@
'automation':'script,5b4e0237da074764'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3322)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3695)
```python
})
if r['return']>0:
@@ -344,8 +364,8 @@
#### docker
- * CM CLI: ```cm docker script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3350))
- * CM CLI with UID: ```cm docker script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3350))
+ * CM CLI: ```cm docker script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3723))
+ * CM CLI with UID: ```cm docker script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3723))
* CM Python API:
```python
import cmind
@@ -355,7 +375,7 @@
'automation':'script,5b4e0237da074764'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3350)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3723)
```python
})
if r['return']>0:
@@ -364,8 +384,8 @@
#### prepare
- * CM CLI: ```cm prepare script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3403))
- * CM CLI with UID: ```cm prepare script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3403))
+ * CM CLI: ```cm prepare script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3777))
+ * CM CLI with UID: ```cm prepare script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3777))
* CM Python API:
```python
import cmind
@@ -375,7 +395,27 @@
'automation':'script,5b4e0237da074764'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3403)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3777)
+ ```python
+ })
+ if r['return']>0:
+ print(r['error'])
+ ```
+
+#### clean_some_tmp_files
+
+ * CM CLI: ```cm clean_some_tmp_files script``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3788))
+ * CM CLI with UID: ```cm clean_some_tmp_files script,5b4e0237da074764``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3788))
+ * CM Python API:
+ ```python
+ import cmind
+
+ r=cm.access({
+ 'action':'clean_some_tmp_files'
+ 'automation':'script,5b4e0237da074764'
+ 'out':'con'
+ ```
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3788)
```python
})
if r['return']>0:
diff --git a/cm-mlops/automation/script/module_misc.py b/cm-mlops/automation/script/module_misc.py
index b9a97b2dea..6931232f3d 100644
--- a/cm-mlops/automation/script/module_misc.py
+++ b/cm-mlops/automation/script/module_misc.py
@@ -125,6 +125,8 @@ def doc(i):
template_file = 'template_list_of_scripts.md'
list_file = 'list_of_scripts.md'
+ public_taskforce = '[Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)'
+
console = i.get('out') == 'con'
repos = i.get('repos','')
@@ -170,17 +172,6 @@ def doc(i):
# Common index for all scripts
md_script = []
- # This readme
- md_script_readme = [
- '',
- 'Click here to see the table of contents.
',
- '{{CM_README_TOC}}',
- ' ',
- '',
- '*Note that this README is automatically generated - don\'t edit!*',
- ''
- ]
-
path = artifact.path
meta = artifact.meta
original_meta = artifact.original_meta
@@ -236,10 +227,10 @@ def doc(i):
url = ''
url_repo = ''
if repo_alias == 'internal':
- url_repo = 'https://github.com/mlcommons/ck/tree/master/cm/cmind/repo'
+ url_repo = 'https://github.com/mlcommons/ck/tree/dev/cm/cmind/repo'
url = url_repo+'/script/'
elif '@' in repo_alias:
- url_repo = 'https://github.com/'+repo_alias.replace('@','/')+'/tree/master'
+ url_repo = 'https://github.com/'+repo_alias.replace('@','/')+'/tree/dev'
if repo_meta.get('prefix','')!='': url_repo+='/'+repo_meta['prefix']
url = url_repo+ '/script/'
@@ -248,18 +239,40 @@ def doc(i):
urls[alias]=url
- x = '* [{}]({})'.format(alias, url)
- if name !='': x+=' *('+name+')*'
- toc.append(x)
+ # Check if there is about doc
+ path_readme = os.path.join(path, 'README.md')
+ path_readme_extra = os.path.join(path, 'README-extra.md')
+ path_readme_about = os.path.join(path, 'README-about.md')
+
+ readme_about = ''
+ if os.path.isfile(path_readme_about):
+ r = utils.load_txt(path_readme_about, split = True)
+ if r['return']>0: return
+
+ s = r['string']
+ readme_about = r['list']
+
+
+ #######################################################################
+ # Start automatically generated README
+ md_script_readme = [
+# '',
+# 'Click here to see the table of contents.
',
+# '{{CM_README_TOC}}',
+# ' ',
+# '',
+ 'Automatically generated README for this automation recipe: **{}**'.format(meta['alias']),
+ ]
+
md_script.append('## '+alias)
md_script.append('')
- x = 'About'
+# x = 'About'
# md_script_readme.append('___')
- md_script_readme.append('### '+x)
- md_script_readme.append('')
- toc_readme.append(x)
+# md_script_readme.append('### '+x)
+# md_script_readme.append('')
+# toc_readme.append(x)
# x = 'About'
# md_script_readme.append('#### '+x)
@@ -271,22 +284,10 @@ def doc(i):
md_script.append('*'+name+'*')
md_script.append('')
- md_script_readme.append('*'+name+'*')
- md_script_readme.append('')
+# md_script_readme.append('*'+name+'*')
+# md_script_readme.append('')
- # Check if there is about doc
- path_readme = os.path.join(path, 'README.md')
- path_readme_extra = os.path.join(path, 'README-extra.md')
- path_readme_about = os.path.join(path, 'README-about.md')
-
- if os.path.isfile(path_readme_about):
- r = utils.load_txt(path_readme_about, split = True)
- if r['return']>0: return
- s = r['string']
- readme_about = r['list']
-
- md_script_readme += readme_about
if os.path.isfile(path_readme):
r = utils.load_txt(path_readme, split = True)
@@ -309,26 +310,62 @@ def doc(i):
os.system('git add README-extra.md')
os.chdir(cur_dir)
- cm_readme_extra = ''
- cm_see_readme_extra = 'Use `README-extra.md` to add more info'
+
+
+ if category!='':
+ md_script_readme.append('')
+ md_script_readme.append('Category: **{}**'.format(category))
+
+ md_script_readme.append('')
+ md_script_readme.append('License: **Apache 2.0**')
+ md_script_readme.append('')
+
+ if developers == '':
+ md_script_readme.append('Maintainers: ' + public_taskforce)
+ else:
+ md_script_readme.append('Developers: ' + developers)
+
+ x = '* [{}]({})'.format(alias, url)
+ if name !='': x+=' *('+name+')*'
+ toc.append(x)
+
+
+ cm_readme_extra = '[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name={},{}) ] '.format(alias, uid)
+
if os.path.isfile(path_readme_extra):
- md_script_readme.append('{{CM_README_EXTRA}}')
+ readme_extra_url = url+'/README-extra.md'
+
+ x = '* Notes from the authors, contributors and users: [*GitHub*]({})'.format(readme_extra_url)
+ md_script.append(x)
+
+ cm_readme_extra += '[ [Notes from the authors, contributors and users](README-extra.md) ] '
+
+ md_script_readme.append('')
+ md_script_readme.append('---')
+ md_script_readme.append('*'+cm_readme_extra.strip()+'*')
+
+
+ if readme_about!='':
+ md_script_readme += ['', '---', ''] + readme_about
+
-# if developers!='':
-# md_script.append('Developers: '+developers)
-# md_script.append('')
x = 'Summary'
-# md_script_readme.append('___')
- md_script_readme.append('#### '+x)
md_script_readme.append('')
+ md_script_readme.append('---')
+ md_script_readme += [
+# '',
+# 'Click to see the summary
',
+ '#### Summary',
+ ''
+ ]
toc_readme.append(x)
- if category != '':
+# if category != '':
# x = 'Category'
# md_script_readme.append('___')
# md_script_readme.append('#### '+x)
@@ -336,8 +373,8 @@ def doc(i):
# md_script_readme.append(category+'.')
# toc_readme.append(x)
- x = '* Category: *{}*'.format(category + '.')
- md_script_readme.append(x)
+# x = '* Category: *{}*'.format(category + '.')
+# md_script_readme.append(x)
# x = 'Origin'
@@ -374,7 +411,7 @@ def doc(i):
if len(variation_keys)>0:
variation_pointer="[,variations]"
- variation_pointer2="[ variations]"
+ variation_pointer2="[variations]"
else:
variation_pointer=''
variation_pointer2=''
@@ -384,12 +421,16 @@ def doc(i):
else:
input_mapping_pointer=''
- cli_all_tags = '`cm run script --tags={}{} {}`'.format(','.join(tags), variation_pointer, input_mapping_pointer)
+ cli_all_tags = '`cm run script --tags={}`'.format(','.join(tags))
+ cli_all_tags3 = '`cm run script --tags={}{} {}`'.format(','.join(tags), variation_pointer, input_mapping_pointer)
x = '* CM CLI with all tags: {}*'.format(cli_all_tags)
md_script.append(x)
- cli_all_tags_alternative = '`cmr "{}{}" {}`'.format(' '.join(tags), variation_pointer2, input_mapping_pointer)
- cli_all_tags_alternative_j = '`cmr "{}{}" {} -j`'.format(' '.join(tags), variation_pointer, input_mapping_pointer)
+ cli_help_tags_alternative = '`cmr "{}" --help`'.format(' '.join(tags))
+
+ cli_all_tags_alternative = '`cmr "{}"`'.format(' '.join(tags))
+ cli_all_tags_alternative3 = '`cmr "{} {}" {}`'.format(' '.join(tags), variation_pointer2, input_mapping_pointer)
+ cli_all_tags_alternative_j = '`cmr "{} {}" {} -j`'.format(' '.join(tags), variation_pointer, input_mapping_pointer)
x = '* CM CLI alternative: {}*'.format(cli_all_tags_alternative)
md_script.append(x)
@@ -421,17 +462,7 @@ def doc(i):
-
- if os.path.isfile(path_readme_extra):
- readme_extra_url = url+'/README-extra.md'
-
- x = '* More info: [*GitHub*]({})'.format(readme_extra_url)
- md_script.append(x)
-
- cm_see_readme_extra = 'See extra [notes](README-extra.md) from the authors and contributors'
- cm_readme_extra='\n'+cm_see_readme_extra+'.\n'
-
-
+
md_script.append('')
# md_script_readme.append('')
@@ -446,7 +477,7 @@ def doc(i):
x = 'Tags'
# md_script_readme.append('___')
# md_script_readme.append('### '+x)
- md_script_readme.append('* CM "database" tags to find this script: *{}*'.format(','.join(tags)))
+ md_script_readme.append('* All CM tags to find and reuse this script (see in above meta description): *{}*'.format(','.join(tags)))
# md_script_readme.append('')
# toc_readme.append(x)
@@ -454,50 +485,101 @@ def doc(i):
cache = meta.get('cache', False)
md_script_readme.append('* Output cached? *{}*'.format(str(cache)))
+ md_script_readme.append('* See [pipeline of dependencies]({}) on other CM scripts'.format('#dependencies-on-other-cm-scripts'))
+
+ md_script_readme += ['',
+# ' '
+ ]
# Add usage
x1 = 'Reuse this script in your project'
- x1a = 'Install CM automation language'
- x1aa = 'Pull CM repository with this automation'
- x1b = 'Check CM script flags'
- x2 = 'Run this script from command line'
+ x1a = 'Install MLCommons CM automation meta-framework'
+ x1aa = 'Pull CM repository with this automation recipe (CM script)'
+ x1b = 'Print CM help from the command line'
+ x2 = 'Customize and run this script from the command line with different variations and flags'
x3 = 'Run this script from Python'
x3a = 'Run this script via GUI'
x4 = 'Run this script via Docker (beta)'
- md_script_readme += ['___',
+ md_script_readme += [
+ '',
+ '---',
'### '+x1,
'',
'#### '+x1a,
'',
- '* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)',
- '* [CM intro](https://doi.org/10.5281/zenodo.8105339)',
+ '* [Install CM](https://access.cknowledge.org/playground/?action=install)',
+ '* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)',
'',
'#### '+x1aa,
'',
'```cm pull repo {}```'.format(repo_alias),
'',
-# '##### '+x1b,
-# '',
-# '```cm run script --help```',
+ '#### '+x1b,
+ '',
+ '```{}```'.format(cli_help_tags_alternative),
'',
'#### '+x2,
'',
- '1. {}'.format(cli_all_tags),
+ '{}'.format(cli_all_tags),
+ '',
+ '{}'.format(cli_all_tags3),
+ '',
+ '*or*',
+ '',
+ '{}'.format(cli_all_tags_alternative),
+ '',
+ '{}'.format(cli_all_tags_alternative3),
'',
- '2. {}'.format(cli_all_tags_alternative),
-# '',
# '3. {}'.format(cli_uid),
'']
+
+
+ x = ' and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.'
if len(variation_keys)>0:
- md_script_readme += ['* `variations` can be seen [here](#variations)',
- ''
- ]
- if len(input_mapping)>0:
- md_script_readme += ['* `input_flags` can be seen [here](#script-flags-mapped-to-environment)',
+ md_script_readme += ['* *See the list of `variations` [here](#variations)'+x+'*',
''
]
+
+ if input_description and len(input_description)>0:
+ x = 'Input Flags'
+ md_script_readme.append('')
+ md_script_readme.append('#### '+x)
+ toc_readme.append(' '+x)
+
+ md_script_readme.append('')
+ key0 = ''
+ for key in input_description:
+ if key0=='': key0=key
+
+ value = input_description[key]
+ desc = value
+
+ if type(value) == dict:
+ desc = value['desc']
+
+ choices = value.get('choices', [])
+ if len(choices) > 0:
+ desc+=' {'+','.join(choices)+'}'
+
+ default = value.get('default','')
+ if default!='':
+ desc+=' (*'+str(default)+'*)'
+
+ md_script_readme.append('* --**{}**={}'.format(key,desc))
+
+ md_script_readme.append('')
+ md_script_readme.append('**Above CLI flags can be used in the Python CM API as follows:**')
+ md_script_readme.append('')
+
+ x = '```python\nr=cm.access({... , "'+key0+'":...}\n```'
+ md_script_readme.append(x)
+
+
+
+
+
md_script_readme += ['#### '+x3,
'',
'',
@@ -714,40 +796,6 @@ def doc(i):
- if input_description and len(input_description)>0:
- x = 'Input description'
- md_script_readme.append('')
- md_script_readme.append('#### '+x)
- toc_readme.append(' '+x)
-
- md_script_readme.append('')
- key0 = ''
- for key in input_description:
- if key0=='': key0=key
-
- value = input_description[key]
- desc = value
-
- if type(value) == dict:
- desc = value['desc']
-
- choices = value.get('choices', [])
- if len(choices) > 0:
- desc+=' {'+','.join(choices)+'}'
-
- default = value.get('default','')
- if default!='':
- desc+=' (*'+str(default)+'*)'
-
- md_script_readme.append('* --**{}** {}'.format(key,desc))
-
- md_script_readme.append('')
- md_script_readme.append('**Above CLI flags can be used in the Python CM API as follows:**')
- md_script_readme.append('')
-
- x = '```python\nr=cm.access({... , "'+key0+'":...}\n```'
- md_script_readme.append(x)
-
# Check input flags
@@ -825,14 +873,14 @@ def doc(i):
# Add workflow
- x = 'Script workflow, dependencies and native scripts'
+ x = 'Dependencies on other CM scripts'
md_script_readme += ['___',
'### '+x,
'']
toc_readme.append(x)
- md_script_readme.append('')
- md_script_readme.append('Click here to expand this section.
')
+# md_script_readme.append('')
+# md_script_readme.append('Click here to expand this section.
')
md_script_readme.append('')
@@ -911,7 +959,7 @@ def doc(i):
md_script_readme.append((' 1. '+x+'Run "postrocess" function from {}'+x).format(y))
process_deps(self_module, meta, meta_url, md_script_readme, 'post_deps')
- md_script_readme.append(' ')
+ # md_script_readme.append(' ')
md_script_readme.append('')
# New environment
@@ -959,12 +1007,12 @@ def doc(i):
# Add maintainers
- x = 'Maintainers'
- md_script_readme.append('___')
- md_script_readme.append('### '+x)
- md_script_readme.append('')
- md_script_readme.append('* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)')
- toc_readme.append(x)
+# x = 'Maintainers'
+# md_script_readme.append('___')
+# md_script_readme.append('### '+x)
+# md_script_readme.append('')
+# md_script_readme.append('* ' + public_taskforce)
+# toc_readme.append(x)
# Process TOC
toc_readme_string = '\n'
@@ -985,7 +1033,7 @@ def doc(i):
s = '\n'.join(md_script_readme)
s = s.replace('{{CM_README_EXTRA}}', cm_readme_extra)
- s = s.replace('{{CM_SEE_README_EXTRA}}', cm_see_readme_extra)
+# s = s.replace('{{CM_SEE_README_EXTRA}}', cm_see_readme_extra)
s = s.replace('{{CM_README_TOC}}', toc_readme_string)
r = utils.save_txt(path_readme, s)
diff --git a/cm-mlops/automation/utils/README.md b/cm-mlops/automation/utils/README.md
index 71af2f6b09..9a844c6566 100644
--- a/cm-mlops/automation/utils/README.md
+++ b/cm-mlops/automation/utils/README.md
@@ -64,8 +64,8 @@
#### unzip_file
- * CM CLI: ```cm unzip_file utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L256))
- * CM CLI with UID: ```cm unzip_file utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L256))
+ * CM CLI: ```cm unzip_file utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L265))
+ * CM CLI with UID: ```cm unzip_file utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L265))
* CM Python API:
```python
import cmind
@@ -75,7 +75,7 @@
'automation':'utils,dc2743f8450541e3'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L256)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L265)
```python
})
if r['return']>0:
@@ -84,8 +84,8 @@
#### compare_versions
- * CM CLI: ```cm compare_versions utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L334))
- * CM CLI with UID: ```cm compare_versions utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L334))
+ * CM CLI: ```cm compare_versions utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L343))
+ * CM CLI with UID: ```cm compare_versions utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L343))
* CM Python API:
```python
import cmind
@@ -95,7 +95,7 @@
'automation':'utils,dc2743f8450541e3'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L334)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L343)
```python
})
if r['return']>0:
@@ -104,8 +104,8 @@
#### json2yaml
- * CM CLI: ```cm json2yaml utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L382))
- * CM CLI with UID: ```cm json2yaml utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L382))
+ * CM CLI: ```cm json2yaml utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L391))
+ * CM CLI with UID: ```cm json2yaml utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L391))
* CM Python API:
```python
import cmind
@@ -115,7 +115,7 @@
'automation':'utils,dc2743f8450541e3'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L382)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L391)
```python
})
if r['return']>0:
@@ -124,8 +124,8 @@
#### yaml2json
- * CM CLI: ```cm yaml2json utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L420))
- * CM CLI with UID: ```cm yaml2json utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L420))
+ * CM CLI: ```cm yaml2json utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L429))
+ * CM CLI with UID: ```cm yaml2json utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L429))
* CM Python API:
```python
import cmind
@@ -135,7 +135,7 @@
'automation':'utils,dc2743f8450541e3'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L420)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L429)
```python
})
if r['return']>0:
@@ -144,8 +144,8 @@
#### sort_json
- * CM CLI: ```cm sort_json utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L458))
- * CM CLI with UID: ```cm sort_json utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L458))
+ * CM CLI: ```cm sort_json utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L467))
+ * CM CLI with UID: ```cm sort_json utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L467))
* CM Python API:
```python
import cmind
@@ -155,7 +155,7 @@
'automation':'utils,dc2743f8450541e3'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L458)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L467)
```python
})
if r['return']>0:
@@ -164,8 +164,8 @@
#### dos2unix
- * CM CLI: ```cm dos2unix utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L495))
- * CM CLI with UID: ```cm dos2unix utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L495))
+ * CM CLI: ```cm dos2unix utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L504))
+ * CM CLI with UID: ```cm dos2unix utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L504))
* CM Python API:
```python
import cmind
@@ -175,7 +175,7 @@
'automation':'utils,dc2743f8450541e3'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L495)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L504)
```python
})
if r['return']>0:
@@ -184,8 +184,8 @@
#### replace_string_in_file
- * CM CLI: ```cm replace_string_in_file utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L532))
- * CM CLI with UID: ```cm replace_string_in_file utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L532))
+ * CM CLI: ```cm replace_string_in_file utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L541))
+ * CM CLI with UID: ```cm replace_string_in_file utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L541))
* CM Python API:
```python
import cmind
@@ -195,7 +195,7 @@
'automation':'utils,dc2743f8450541e3'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L532)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L541)
```python
})
if r['return']>0:
@@ -204,8 +204,8 @@
#### create_toc_from_md
- * CM CLI: ```cm create_toc_from_md utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L582))
- * CM CLI with UID: ```cm create_toc_from_md utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L582))
+ * CM CLI: ```cm create_toc_from_md utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L591))
+ * CM CLI with UID: ```cm create_toc_from_md utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L591))
* CM Python API:
```python
import cmind
@@ -215,7 +215,7 @@
'automation':'utils,dc2743f8450541e3'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L582)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L591)
```python
})
if r['return']>0:
@@ -224,8 +224,8 @@
#### copy_to_clipboard
- * CM CLI: ```cm copy_to_clipboard utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L650))
- * CM CLI with UID: ```cm copy_to_clipboard utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L650))
+ * CM CLI: ```cm copy_to_clipboard utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L659))
+ * CM CLI with UID: ```cm copy_to_clipboard utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L659))
* CM Python API:
```python
import cmind
@@ -235,7 +235,7 @@
'automation':'utils,dc2743f8450541e3'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L650)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L659)
```python
})
if r['return']>0:
@@ -244,8 +244,8 @@
#### list_files_recursively
- * CM CLI: ```cm list_files_recursively utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L728))
- * CM CLI with UID: ```cm list_files_recursively utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L728))
+ * CM CLI: ```cm list_files_recursively utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L737))
+ * CM CLI with UID: ```cm list_files_recursively utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L737))
* CM Python API:
```python
import cmind
@@ -255,7 +255,127 @@
'automation':'utils,dc2743f8450541e3'
'out':'con'
```
- [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L728)
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L737)
+ ```python
+ })
+ if r['return']>0:
+ print(r['error'])
+ ```
+
+#### generate_secret
+
+ * CM CLI: ```cm generate_secret utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L770))
+ * CM CLI with UID: ```cm generate_secret utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L770))
+ * CM Python API:
+ ```python
+ import cmind
+
+ r=cm.access({
+ 'action':'generate_secret'
+ 'automation':'utils,dc2743f8450541e3'
+ 'out':'con'
+ ```
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L770)
+ ```python
+ })
+ if r['return']>0:
+ print(r['error'])
+ ```
+
+#### detect_tags_in_artifact
+
+ * CM CLI: ```cm detect_tags_in_artifact utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L793))
+ * CM CLI with UID: ```cm detect_tags_in_artifact utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L793))
+ * CM Python API:
+ ```python
+ import cmind
+
+ r=cm.access({
+ 'action':'detect_tags_in_artifact'
+ 'automation':'utils,dc2743f8450541e3'
+ 'out':'con'
+ ```
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L793)
+ ```python
+ })
+ if r['return']>0:
+ print(r['error'])
+ ```
+
+#### prune_input
+
+ * CM CLI: ```cm prune_input utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L822))
+ * CM CLI with UID: ```cm prune_input utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L822))
+ * CM Python API:
+ ```python
+ import cmind
+
+ r=cm.access({
+ 'action':'prune_input'
+ 'automation':'utils,dc2743f8450541e3'
+ 'out':'con'
+ ```
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L822)
+ ```python
+ })
+ if r['return']>0:
+ print(r['error'])
+ ```
+
+#### uid
+
+ * CM CLI: ```cm uid utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L864))
+ * CM CLI with UID: ```cm uid utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L864))
+ * CM Python API:
+ ```python
+ import cmind
+
+ r=cm.access({
+ 'action':'uid'
+ 'automation':'utils,dc2743f8450541e3'
+ 'out':'con'
+ ```
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L864)
+ ```python
+ })
+ if r['return']>0:
+ print(r['error'])
+ ```
+
+#### system
+
+ * CM CLI: ```cm system utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L891))
+ * CM CLI with UID: ```cm system utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L891))
+ * CM Python API:
+ ```python
+ import cmind
+
+ r=cm.access({
+ 'action':'system'
+ 'automation':'utils,dc2743f8450541e3'
+ 'out':'con'
+ ```
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L891)
+ ```python
+ })
+ if r['return']>0:
+ print(r['error'])
+ ```
+
+#### load_cfg
+
+ * CM CLI: ```cm load_cfg utils``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L969))
+ * CM CLI with UID: ```cm load_cfg utils,dc2743f8450541e3``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L969))
+ * CM Python API:
+ ```python
+ import cmind
+
+ r=cm.access({
+ 'action':'load_cfg'
+ 'automation':'utils,dc2743f8450541e3'
+ 'out':'con'
+ ```
+ [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L969)
```python
})
if r['return']>0:
diff --git a/cm-mlops/script/activate-python-venv/README.md b/cm-mlops/script/activate-python-venv/README.md
index 231d0a782c..9a804da0fd 100644
--- a/cm-mlops/script/activate-python-venv/README.md
+++ b/cm-mlops/script/activate-python-venv/README.md
@@ -1,60 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
-
-
+Automatically generated README for this automation recipe: **activate-python-venv**
-*Note that this README is automatically generated - don't edit!*
+Category: **Python automation**
-### About
+License: **Apache 2.0**
-*Activate virtual Python environment.*
+Developers: [Grigori Fursin](https://cKnowledge.org/gfursin)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=activate-python-venv,fcbbb84946f34c55) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
-See extra [notes](README-extra.md) from the authors and contributors.
-
+---
#### Summary
-* Category: *Python automation.*
-* 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/activate-python-venv)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/activate-python-venv)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *activate,python-venv*
+* All CM tags to find and reuse this script (see in above meta description): *activate,python-venv*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "activate python-venv" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=activate,python-venv`
-1. `cm run script --tags=activate,python-venv `
+`cm run script --tags=activate,python-venv `
+
+*or*
+
+`cmr "activate python-venv"`
+
+`cmr "activate python-venv " `
-2. `cmr "activate python-venv" `
#### Run this script from Python
@@ -106,33 +99,25 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 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)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/activate-python-venv/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/activate-python-venv/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/activate-python-venv/_cm.json)***
* install,python-venv
* CM names: `--adr.['python-venv']...`
- CM script: [install-python-venv](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-venv)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/activate-python-venv/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/activate-python-venv/run.sh)
- 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)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/activate-python-venv/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/activate-python-venv/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/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)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/activate-python-venv/_cm.json)
___
### Script output
-`cmr "activate python-venv" -j`
+`cmr "activate python-venv " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/add-custom-nvidia-system/README.md b/cm-mlops/script/add-custom-nvidia-system/README.md
index bf3ce9210b..51b160909b 100644
--- a/cm-mlops/script/add-custom-nvidia-system/README.md
+++ b/cm-mlops/script/add-custom-nvidia-system/README.md
@@ -1,62 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ 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)
-
-
+Automatically generated README for this automation recipe: **add-custom-nvidia-system**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=add-custom-nvidia-system,b2e6c46c6e8745a3) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/add-custom-nvidia-system)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/add-custom-nvidia-system)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *add,custom,system,nvidia*
+* All CM tags to find and reuse this script (see in above meta description): *add,custom,system,nvidia*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "add custom system nvidia" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=add,custom,system,nvidia`
-#### Run this script from command line
+`cm run script --tags=add,custom,system,nvidia[,variations] `
-1. `cm run script --tags=add,custom,system,nvidia[,variations] `
+*or*
-2. `cmr "add custom system nvidia[ variations]" `
+`cmr "add custom system nvidia"`
-* `variations` can be seen [here](#variations)
+`cmr "add custom system nvidia [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -92,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=add,custom,system,nvid
#### Run this script via Docker (beta)
-`cm docker script "add custom system nvidia[ variations]" `
+`cm docker script "add custom system nvidia[variations]" `
___
### Customization
@@ -130,12 +123,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
* `r3.0`
* `r3.1`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 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)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/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)
* detect,cpu
@@ -170,23 +161,17 @@ ___
- CM script: [get-mlperf-inference-nvidia-common-code](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-common-code)
* get,generic-python-lib,_pycuda
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/add-custom-nvidia-system/customize.py)***
- 1. Read "prehook_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 "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/add-custom-nvidia-system/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/add-custom-nvidia-system/_cm.yaml)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/add-custom-nvidia-system/run.sh)
- 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)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/add-custom-nvidia-system/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/add-custom-nvidia-system/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/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/dev/cm-mlops/script/add-custom-nvidia-system/_cm.yaml)
___
### Script output
-`cmr "add custom system nvidia[,variations]" -j`
+`cmr "add custom system nvidia [,variations]" -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/app-image-classification-onnx-py/README.md b/cm-mlops/script/app-image-classification-onnx-py/README.md
index fd04daf86c..e74a1be740 100644
--- a/cm-mlops/script/app-image-classification-onnx-py/README.md
+++ b/cm-mlops/script/app-image-classification-onnx-py/README.md
@@ -1,66 +1,68 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Input description](#input-description)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **app-image-classification-onnx-py**
-*Note that this README is automatically generated - don't edit!*
+Category: **Modular AI/ML application pipeline**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=app-image-classification-onnx-py,3d5e908e472b417e) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Modular AI/ML application pipeline.*
-* 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/app-image-classification-onnx-py)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-onnx-py)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *modular,python,app,image-classification,onnx*
+* All CM tags to find and reuse this script (see in above meta description): *modular,python,app,image-classification,onnx*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "modular python app image-classification onnx" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=modular,python,app,image-classification,onnx`
-1. `cm run script --tags=modular,python,app,image-classification,onnx[,variations] [--input_flags]`
+`cm run script --tags=modular,python,app,image-classification,onnx[,variations] [--input_flags]`
-2. `cmr "modular python app image-classification onnx[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "modular python app image-classification onnx"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "modular python app image-classification onnx [variations]" [--input_flags]`
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
+
+
+#### Input Flags
+
+* --**input**=Path to JPEG image to classify
+* --**output**=Output directory (optional)
+* --**j**=Print JSON output
+
+**Above CLI flags can be used in the Python CM API as follows:**
+
+```python
+r=cm.access({... , "input":...}
+```
#### Run this script from Python
@@ -95,7 +97,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=modular,python,app,ima
#### Run this script via Docker (beta)
-`cm docker script "modular python app image-classification onnx[ variations]" [--input_flags]`
+`cm docker script "modular python app image-classification onnx[variations]" [--input_flags]`
___
### Customization
@@ -123,18 +125,6 @@ ___
`_cpu`
-#### Input description
-
-* --**input** Path to JPEG image to classify
-* --**output** Output directory (optional)
-* --**j** Print JSON output
-
-**Above CLI flags can be used in the Python CM API as follows:**
-
-```python
-r=cm.access({... , "input":...}
-```
-
#### Script flags mapped to environment
Click here to expand this section.
@@ -163,12 +153,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 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)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/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)
* get,sys-utils-cm
@@ -205,25 +193,19 @@ ___
* `if (USE_CUDA == True)`
* CM names: `--adr.['onnxruntime']...`
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-onnx-py/customize.py)***
- 1. Read "prehook_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 "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-onnx-py/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-onnx-py/_cm.yaml)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-onnx-py/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-onnx-py/run.sh)
- 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](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-onnx-py/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)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-onnx-py/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-onnx-py/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-onnx-py/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-onnx-py/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-onnx-py/_cm.yaml)
___
### Script output
-`cmr "modular python app image-classification onnx[,variations]" [--input_flags] -j`
+`cmr "modular python app image-classification onnx [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_APP_IMAGE_CLASSIFICATION_ONNX_PY*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/app-image-classification-tf-onnx-cpp/README.md b/cm-mlops/script/app-image-classification-tf-onnx-cpp/README.md
index c0f4990f12..11f9495bd4 100644
--- a/cm-mlops/script/app-image-classification-tf-onnx-cpp/README.md
+++ b/cm-mlops/script/app-image-classification-tf-onnx-cpp/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
-
-
+Automatically generated README for this automation recipe: **app-image-classification-tf-onnx-cpp**
-*Note that this README is automatically generated - don't edit!*
+Category: **Modular AI/ML application pipeline**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=app-image-classification-tf-onnx-cpp,879ed32e47074033) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Modular AI/ML application pipeline.*
-* 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/app-image-classification-tf-onnx-cpp)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-tf-onnx-cpp)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *app,image-classification,cpp,tensorflow,onnx*
+* All CM tags to find and reuse this script (see in above meta description): *app,image-classification,cpp,tensorflow,onnx*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "app image-classification cpp tensorflow onnx" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=app,image-classification,cpp,tensorflow,onnx`
-#### Run this script from command line
+`cm run script --tags=app,image-classification,cpp,tensorflow,onnx `
-1. `cm run script --tags=app,image-classification,cpp,tensorflow,onnx `
+*or*
+
+`cmr "app image-classification cpp tensorflow onnx"`
+
+`cmr "app image-classification cpp tensorflow onnx " `
-2. `cmr "app image-classification cpp tensorflow onnx" `
#### Run this script from Python
@@ -106,12 +101,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-tf-onnx-cpp/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-tf-onnx-cpp/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,sys-utils-cm
@@ -127,22 +120,16 @@ ___
* tensorflow,from-src
- CM script: [install-tensorflow-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tensorflow-from-src)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-tf-onnx-cpp/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-tf-onnx-cpp/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-tf-onnx-cpp/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-tf-onnx-cpp/_cm.json)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-tf-onnx-cpp/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-tf-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-tf-onnx-cpp/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-tf-onnx-cpp/_cm.json)
___
### Script output
-`cmr "app image-classification cpp tensorflow onnx" -j`
+`cmr "app image-classification cpp tensorflow onnx " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/app-image-classification-torch-py/README.md b/cm-mlops/script/app-image-classification-torch-py/README.md
index d0d5fe26a8..107a6a860c 100644
--- a/cm-mlops/script/app-image-classification-torch-py/README.md
+++ b/cm-mlops/script/app-image-classification-torch-py/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **app-image-classification-torch-py**
-*Note that this README is automatically generated - don't edit!*
+Category: **Modular AI/ML application pipeline**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=app-image-classification-torch-py,e3986ae887b84ca8) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Modular AI/ML application pipeline.*
-* 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/app-image-classification-torch-py)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-torch-py)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *app,image-classification,python,torch*
+* All CM tags to find and reuse this script (see in above meta description): *app,image-classification,python,torch*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "app image-classification python torch" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=app,image-classification,python,torch`
-#### Run this script from command line
+`cm run script --tags=app,image-classification,python,torch[,variations] `
-1. `cm run script --tags=app,image-classification,python,torch[,variations] `
+*or*
-2. `cmr "app image-classification python torch[ variations]" `
+`cmr "app image-classification python torch"`
-* `variations` can be seen [here](#variations)
+`cmr "app image-classification python torch [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=app,image-classificati
#### Run this script via Docker (beta)
-`cm docker script "app image-classification python torch[ variations]" `
+`cm docker script "app image-classification python torch[variations]" `
___
### Customization
@@ -126,12 +120,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 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)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/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)
* get,sys-utils-cm
@@ -160,23 +152,17 @@ ___
* `if (USE_CUDA == yes)`
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_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. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-torch-py/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-torch-py/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-torch-py/run.sh)
- 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)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-torch-py/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-torch-py/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/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)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-torch-py/_cm.json)
___
### Script output
-`cmr "app image-classification python torch[,variations]" -j`
+`cmr "app image-classification python torch [,variations]" -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/app-image-classification-tvm-onnx-py/README.md b/cm-mlops/script/app-image-classification-tvm-onnx-py/README.md
index e2ed7d78f1..bd1d4c56aa 100644
--- a/cm-mlops/script/app-image-classification-tvm-onnx-py/README.md
+++ b/cm-mlops/script/app-image-classification-tvm-onnx-py/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **app-image-classification-tvm-onnx-py**
-*Note that this README is automatically generated - don't edit!*
+Category: **Modular AI/ML application pipeline**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=app-image-classification-tvm-onnx-py,63080407db4d4ac4) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Modular AI/ML application pipeline.*
-* 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/app-image-classification-tvm-onnx-py)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-tvm-onnx-py)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *app,image-classification,python,tvm-onnx*
+* All CM tags to find and reuse this script (see in above meta description): *app,image-classification,python,tvm-onnx*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "app image-classification python tvm-onnx" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=app,image-classification,python,tvm-onnx`
-#### Run this script from command line
+`cm run script --tags=app,image-classification,python,tvm-onnx[,variations] `
-1. `cm run script --tags=app,image-classification,python,tvm-onnx[,variations] `
+*or*
-2. `cmr "app image-classification python tvm-onnx[ variations]" `
+`cmr "app image-classification python tvm-onnx"`
-* `variations` can be seen [here](#variations)
+`cmr "app image-classification python tvm-onnx [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=app,image-classificati
#### Run this script via Docker (beta)
-`cm docker script "app image-classification python tvm-onnx[ variations]" `
+`cm docker script "app image-classification python tvm-onnx[variations]" `
___
### Customization
@@ -128,12 +122,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-tvm-onnx-py/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-tvm-onnx-py/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -153,22 +145,16 @@ ___
* CM names: `--adr.['tvm']...`
- CM script: [get-tvm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tvm)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-tvm-onnx-py/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-tvm-onnx-py/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-tvm-onnx-py/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-tvm-onnx-py/_cm.json)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-tvm-onnx-py/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-tvm-onnx-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-tvm-onnx-py/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-tvm-onnx-py/_cm.json)
___
### Script output
-`cmr "app image-classification python tvm-onnx[,variations]" -j`
+`cmr "app image-classification python tvm-onnx [,variations]" -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/app-image-corner-detection/README.md b/cm-mlops/script/app-image-corner-detection/README.md
index 53eaf552a7..dad1c84a9a 100644
--- a/cm-mlops/script/app-image-corner-detection/README.md
+++ b/cm-mlops/script/app-image-corner-detection/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
-
-
+Automatically generated README for this automation recipe: **app-image-corner-detection**
-*Note that this README is automatically generated - don't edit!*
+Category: **Modular application pipeline**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=app-image-corner-detection,998ffee0bc534d0a) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Modular application pipeline.*
-* 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/app-image-corner-detection)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-corner-detection)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *app,image,corner-detection*
+* All CM tags to find and reuse this script (see in above meta description): *app,image,corner-detection*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "app image corner-detection" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=app,image,corner-detection`
-#### Run this script from command line
+`cm run script --tags=app,image,corner-detection `
-1. `cm run script --tags=app,image,corner-detection `
+*or*
+
+`cmr "app image corner-detection"`
+
+`cmr "app image corner-detection " `
-2. `cmr "app image corner-detection" `
#### Run this script from Python
@@ -104,39 +99,31 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-corner-detection/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-corner-detection/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
- CM script: [detect-cpu](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-corner-detection/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-corner-detection/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-corner-detection/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-corner-detection/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-corner-detection/run.sh)
- 1. ***Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-corner-detection/_cm.json)***
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-corner-detection/run.sh)
+ 1. ***Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-corner-detection/_cm.json)***
* compile,cpp-program
* `if (CM_SKIP_COMPILE != on)`
- CM script: [compile-program](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/compile-program)
* benchmark-program
* `if (CM_SKIP_RUN != on)`
- CM script: [benchmark-program](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-corner-detection/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-corner-detection/_cm.json)
-
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-corner-detection/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-corner-detection/_cm.json)
___
### Script output
-`cmr "app image corner-detection" -j`
+`cmr "app image corner-detection " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/app-loadgen-generic-python/README.md b/cm-mlops/script/app-loadgen-generic-python/README.md
index bdf3d2823f..c8e7670e95 100644
--- a/cm-mlops/script/app-loadgen-generic-python/README.md
+++ b/cm-mlops/script/app-loadgen-generic-python/README.md
@@ -1,66 +1,75 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Input description](#input-description)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **app-loadgen-generic-python**
-*Note that this README is automatically generated - don't edit!*
+Category: **Modular MLPerf inference benchmark pipeline**
-### About
+License: **Apache 2.0**
+Developers: [Gaz Iqbal](https://www.linkedin.com/in/gaziqbal), [Arjun Suresh](https://www.linkedin.com/in/arjunsuresh), [Grigori Fursin](https://cKnowledge.org/gfursin)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=app-loadgen-generic-python,d3d949cc361747a6) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Modular MLPerf inference benchmark pipeline.*
-* 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/app-loadgen-generic-python)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-loadgen-generic-python)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *python,app,generic,loadgen*
+* All CM tags to find and reuse this script (see in above meta description): *python,app,generic,loadgen*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "python app generic loadgen" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=python,app,generic,loadgen`
-1. `cm run script --tags=python,app,generic,loadgen[,variations] [--input_flags]`
+`cm run script --tags=python,app,generic,loadgen[,variations] [--input_flags]`
-2. `cmr "python app generic loadgen[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "python app generic loadgen"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "python app generic loadgen [variations]" [--input_flags]`
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
+
+
+#### Input Flags
+
+* --**modelpath**=Full path to a model
+* --**ep**=ONNX Execution provider
+* --**scenario**=MLPerf LoadGen scenario
+* --**samples**=Number of samples (*2*)
+* --**runner**=MLPerf runner
+* --**execmode**=MLPerf exec mode
+* --**output_dir**=MLPerf output directory
+* --**concurrency**=MLPerf concurrency
+* --**intraop**=MLPerf intra op threads
+* --**interop**=MLPerf inter op threads
+
+**Above CLI flags can be used in the Python CM API as follows:**
+
+```python
+r=cm.access({... , "modelpath":...}
+```
#### Run this script from Python
@@ -95,7 +104,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=python,app,generic,loa
#### Run this script via Docker (beta)
-`cm docker script "python app generic loadgen[ variations]" [--input_flags]`
+`cm docker script "python app generic loadgen[variations]" [--input_flags]`
___
### Customization
@@ -183,25 +192,6 @@ ___
`_cpu,_onnxruntime`
-#### Input description
-
-* --**modelpath** Full path to a model
-* --**ep** ONNX Execution provider
-* --**scenario** MLPerf LoadGen scenario
-* --**samples** Number of samples (*2*)
-* --**runner** MLPerf runner
-* --**execmode** MLPerf exec mode
-* --**output_dir** MLPerf output directory
-* --**concurrency** MLPerf concurrency
-* --**intraop** MLPerf intra op threads
-* --**interop** MLPerf inter op threads
-
-**Above CLI flags can be used in the Python CM API as follows:**
-
-```python
-r=cm.access({... , "modelpath":...}
-```
-
#### Script flags mapped to environment
Click here to expand this section.
@@ -238,12 +228,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-loadgen-generic-python/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-loadgen-generic-python/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -280,25 +268,19 @@ ___
* get,ml-model,retinanet,_onnx,_fp32
* `if (CM_MODEL == retinanet)`
- CM script: [get-ml-model-retinanet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-retinanet)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-loadgen-generic-python/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-loadgen-generic-python/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-loadgen-generic-python/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-loadgen-generic-python/_cm.yaml)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-loadgen-generic-python/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-loadgen-generic-python/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-loadgen-generic-python/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-loadgen-generic-python/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-loadgen-generic-python/_cm.yaml)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-loadgen-generic-python/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-loadgen-generic-python/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-loadgen-generic-python/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-loadgen-generic-python/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-loadgen-generic-python/_cm.yaml)
___
### Script output
-`cmr "python app generic loadgen[,variations]" [--input_flags] -j`
+`cmr "python app generic loadgen [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_MLPERF_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/app-loadgen-generic-python/_cm.yaml b/cm-mlops/script/app-loadgen-generic-python/_cm.yaml
index caf4f0f526..d6617e3f3e 100644
--- a/cm-mlops/script/app-loadgen-generic-python/_cm.yaml
+++ b/cm-mlops/script/app-loadgen-generic-python/_cm.yaml
@@ -7,6 +7,8 @@ automation_uid: 5b4e0237da074764
category: "Modular MLPerf inference benchmark pipeline"
+developers: "[Gaz Iqbal](https://www.linkedin.com/in/gaziqbal), [Arjun Suresh](https://www.linkedin.com/in/arjunsuresh), [Grigori Fursin](https://cKnowledge.org/gfursin)"
+
# User-friendly tags to find this CM script
tags:
diff --git a/cm-mlops/script/app-mlperf-inference-ctuning-cpp-tflite/README.md b/cm-mlops/script/app-mlperf-inference-ctuning-cpp-tflite/README.md
index f1f55ad182..a36fc20dc8 100644
--- a/cm-mlops/script/app-mlperf-inference-ctuning-cpp-tflite/README.md
+++ b/cm-mlops/script/app-mlperf-inference-ctuning-cpp-tflite/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **app-mlperf-inference-ctuning-cpp-tflite**
-
+Category: **Modular MLPerf inference benchmark pipeline**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=app-mlperf-inference-ctuning-cpp-tflite,415904407cca404a) ]*
+
+---
#### Summary
-* Category: *Modular MLPerf inference benchmark pipeline.*
-* 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/app-mlperf-inference-ctuning-cpp-tflite)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-ctuning-cpp-tflite)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *app,mlperf,inference,tflite-cpp*
+* All CM tags to find and reuse this script (see in above meta description): *app,mlperf,inference,tflite-cpp*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "app mlperf inference tflite-cpp" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=app,mlperf,inference,tflite-cpp`
-1. `cm run script --tags=app,mlperf,inference,tflite-cpp[,variations] [--input_flags]`
+`cm run script --tags=app,mlperf,inference,tflite-cpp[,variations] [--input_flags]`
-2. `cmr "app mlperf inference tflite-cpp[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "app mlperf inference tflite-cpp"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "app mlperf inference tflite-cpp [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=app,mlperf,inference,t
#### Run this script via Docker (beta)
-`cm docker script "app mlperf inference tflite-cpp[ variations]" [--input_flags]`
+`cm docker script "app mlperf inference tflite-cpp[variations]" [--input_flags]`
___
### Customization
@@ -280,12 +274,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-ctuning-cpp-tflite/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-ctuning-cpp-tflite/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -323,8 +315,8 @@ ___
* `if (CM_MLPERF_TFLITE_USE_ARMNN == yes)`
* CM names: `--adr.['armnn', 'lib-armnn']...`
- CM script: [get-lib-armnn](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-armnn)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-ctuning-cpp-tflite/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-ctuning-cpp-tflite/_cm.json)***
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-ctuning-cpp-tflite/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-ctuning-cpp-tflite/_cm.json)***
* generate,user-conf,mlperf,inference
* CM names: `--adr.['user-conf-generator']...`
- CM script: [generate-mlperf-inference-user-conf](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-inference-user-conf)
@@ -345,9 +337,9 @@ ___
* CM names: `--adr.['imagenet-preprocessed', 'preprocessed-dataset']...`
- CM script: [get-preprocessed-dataset-imagenet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-imagenet)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-ctuning-cpp-tflite/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-ctuning-cpp-tflite/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-ctuning-cpp-tflite/_cm.json)***
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-ctuning-cpp-tflite/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-ctuning-cpp-tflite/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-ctuning-cpp-tflite/_cm.json)***
* compile,program
* `if (CM_MLPERF_SKIP_RUN != yes)`
* CM names: `--adr.['compiler-program']...`
@@ -359,11 +351,10 @@ ___
* save,mlperf,inference,state
* CM names: `--adr.['save-mlperf-inference-state']...`
- CM script: [save-mlperf-inference-implementation-state](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/save-mlperf-inference-implementation-state)
-
___
### Script output
-`cmr "app mlperf inference tflite-cpp[,variations]" [--input_flags] -j`
+`cmr "app mlperf inference tflite-cpp [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_HW_NAME`
@@ -374,8 +365,4 @@ ___
* `CM_MLPERF_CONF`
* `CM_MLPERF_DEVICE`
* `CM_MLPERF_SUT_NAME_RUN_CONFIG_SUFFIX2`
-* `CM_MLPERF_USER_CONF`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_MLPERF_USER_CONF`
\ No newline at end of file
diff --git a/cm-mlops/script/app-mlperf-inference-dummy/README.md b/cm-mlops/script/app-mlperf-inference-dummy/README.md
index 0d131a4f6a..1b0b931bf8 100644
--- a/cm-mlops/script/app-mlperf-inference-dummy/README.md
+++ b/cm-mlops/script/app-mlperf-inference-dummy/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **app-mlperf-inference-dummy**
-
+Category: **Modular MLPerf benchmarks**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=app-mlperf-inference-dummy,5b71627383a94576) ]*
+
+---
#### Summary
-* Category: *Modular MLPerf benchmarks.*
-* 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/app-mlperf-inference-dummy)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-dummy)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *reproduce,mlcommons,mlperf,inference,harness,dummy-harness,dummy*
+* All CM tags to find and reuse this script (see in above meta description): *reproduce,mlcommons,mlperf,inference,harness,dummy-harness,dummy*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "reproduce mlcommons mlperf inference harness dummy-harness dummy" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=reproduce,mlcommons,mlperf,inference,harness,dummy-harness,dummy`
-1. `cm run script --tags=reproduce,mlcommons,mlperf,inference,harness,dummy-harness,dummy[,variations] [--input_flags]`
+`cm run script --tags=reproduce,mlcommons,mlperf,inference,harness,dummy-harness,dummy[,variations] [--input_flags]`
-2. `cmr "reproduce mlcommons mlperf inference harness dummy-harness dummy[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "reproduce mlcommons mlperf inference harness dummy-harness dummy"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "reproduce mlcommons mlperf inference harness dummy-harness dummy [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=reproduce,mlcommons,ml
#### Run this script via Docker (beta)
-`cm docker script "reproduce mlcommons mlperf inference harness dummy-harness dummy[ variations]" [--input_flags]`
+`cm docker script "reproduce mlcommons mlperf inference harness dummy-harness dummy[variations]" [--input_flags]`
___
### Customization
@@ -312,12 +306,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-dummy/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-dummy/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -339,13 +331,13 @@ ___
* get,git,repo
* CM names: `--adr.inference-results inference-code...`
- 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/app-mlperf-inference-dummy/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-dummy/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-dummy/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-dummy/_cm.yaml)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-dummy/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-dummy/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-dummy/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-dummy/_cm.yaml)***
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-dummy/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-dummy/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-dummy/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-dummy/_cm.yaml)***
* benchmark-mlperf
* `if (CM_MLPERF_SKIP_RUN not in ['yes', True])`
* CM names: `--adr.['runner', 'mlperf-runner']...`
@@ -353,11 +345,10 @@ ___
* save,mlperf,inference,state
* CM names: `--adr.['save-mlperf-inference-state']...`
- CM script: [save-mlperf-inference-implementation-state](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/save-mlperf-inference-implementation-state)
-
___
### Script output
-`cmr "reproduce mlcommons mlperf inference harness dummy-harness dummy[,variations]" [--input_flags] -j`
+`cmr "reproduce mlcommons mlperf inference harness dummy-harness dummy [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_DATASET_*`
@@ -368,8 +359,3 @@ ___
* `CM_ML_MODEL_*`
* `CM_SQUAD_ACCURACY_DTYPE`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/app-mlperf-inference-intel/README.md b/cm-mlops/script/app-mlperf-inference-intel/README.md
index 3bcf73b4c1..09ad18c2c7 100644
--- a/cm-mlops/script/app-mlperf-inference-intel/README.md
+++ b/cm-mlops/script/app-mlperf-inference-intel/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **app-mlperf-inference-intel**
-
+Category: **Modular MLPerf benchmarks**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=app-mlperf-inference-intel,c05a90433bb04cc1) ]*
+
+---
#### Summary
-* Category: *Modular MLPerf benchmarks.*
-* 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/app-mlperf-inference-intel)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-intel)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *reproduce,mlcommons,mlperf,inference,harness,intel-harness,intel,intel-harness,intel*
+* All CM tags to find and reuse this script (see in above meta description): *reproduce,mlcommons,mlperf,inference,harness,intel-harness,intel,intel-harness,intel*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "reproduce mlcommons mlperf inference harness intel-harness intel intel-harness intel" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=reproduce,mlcommons,mlperf,inference,harness,intel-harness,intel,intel-harness,intel`
-1. `cm run script --tags=reproduce,mlcommons,mlperf,inference,harness,intel-harness,intel,intel-harness,intel[,variations] [--input_flags]`
+`cm run script --tags=reproduce,mlcommons,mlperf,inference,harness,intel-harness,intel,intel-harness,intel[,variations] [--input_flags]`
-2. `cmr "reproduce mlcommons mlperf inference harness intel-harness intel intel-harness intel[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "reproduce mlcommons mlperf inference harness intel-harness intel intel-harness intel"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "reproduce mlcommons mlperf inference harness intel-harness intel intel-harness intel [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=reproduce,mlcommons,ml
#### Run this script via Docker (beta)
-`cm docker script "reproduce mlcommons mlperf inference harness intel-harness intel intel-harness intel[ variations]" [--input_flags]`
+`cm docker script "reproduce mlcommons mlperf inference harness intel-harness intel intel-harness intel[variations]" [--input_flags]`
___
### Customization
@@ -125,10 +119,6 @@ ___
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
* `_calibration,gptj_`
- Workflow:
- 1. ***Read "deps" on other CM scripts***
- * get,generic-python-lib,_package.texttable
- * CM names: `--adr.['pip-package', 'texttable']...`
- - CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
* `_gptj_`
- Environment variables:
- *CM_BENCHMARK*: `STANDALONE_GPTJ`
@@ -137,6 +127,10 @@ ___
- Environment variables:
- *INTEL_GPTJ_INT4*: `yes`
- Workflow:
+ * `_int8,gptj_`
+ - Environment variables:
+ - *INTEL_GPTJ_INT4*: `no`
+ - Workflow:
@@ -145,10 +139,6 @@ ___
Click here to expand this section.
- * `_activation-count.#`
- - Environment variables:
- - *CM_MODEL_BATCH_SIZE*: `#`
- - Workflow:
* `_bert_,network-client`
- Environment variables:
- *CM_BENCHMARK*: `NETWORK_BERT_CLIENT`
@@ -216,7 +206,7 @@ ___
* `if (INTEL_GPTJ_INT4 == yes)`
- CM script: [install-tpp-pytorch-extension](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tpp-pytorch-extension)
* get,generic-python-lib,_package.transformers
- * CM names: `--adr.['pip-package']...`
+ * CM names: `--adr.['pip-package', 'transformers']...`
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
* get,mlcommons,inference,src
* CM names: `--adr.['inference-src']...`
@@ -241,14 +231,48 @@ ___
* reproduce,mlperf,inference,intel,harness,_calibration
* CM names: `--adr.['calibration']...`
- CM script: [app-mlperf-inference-intel](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-intel)
- * `_loadgen-batch-size.#`
- - Environment variables:
- - *CM_MLPERF_LOADGEN_BATCH_SIZE*: `#`
- - Workflow:
+ * get,generic-python-lib,_package.optimum
+ * CM names: `--adr.['pip-package', 'optimum']...`
+ - CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
* `_resnet50,uint8`
- Environment variables:
- *CM_IMAGENET_ACCURACY_DTYPE*: `int8`
- Workflow:
+ * `_sapphire-rapids.112c,gptj-99,offline,int4`
+ - Environment variables:
+ - *NUM_PROC*: `4`
+ - *KMP_BLOCKTIME*: `1`
+ - *WORKERS_PER_PROC*: `3`
+ - Workflow:
+ * `_sapphire-rapids.112c,gptj-99,offline,int8`
+ - Environment variables:
+ - *KMP_BLOCKTIME*: `1`
+ - *WORKERS_PER_PROC*: `2`
+ - Workflow:
+ * `_sapphire-rapids.112c,gptj-99,server,int4`
+ - Environment variables:
+ - *KMP_BLOCKTIME*: `1`
+ - *WORKERS_PER_PROC*: `4`
+ - Workflow:
+ * `_sapphire-rapids.112c,gptj-99,server,int8`
+ - Environment variables:
+ - *KMP_BLOCKTIME*: `1`
+ - *WORKERS_PER_PROC*: `2`
+ - Workflow:
+ * `_sapphire-rapids.24c,bert-99`
+ - Environment variables:
+ - *WORKERS_PER_PROC*: `1`
+ - Workflow:
+ * `_sapphire-rapids.24c,gptj-99,offline,int4`
+ - Environment variables:
+ - *KMP_BLOCKTIME*: `10`
+ - *WORKERS_PER_PROC*: `1`
+ - Workflow:
+ * `_sapphire-rapids.24c,gptj-99,offline,int8`
+ - Environment variables:
+ - *KMP_BLOCKTIME*: `10`
+ - *WORKERS_PER_PROC*: `1`
+ - Workflow:
@@ -278,6 +302,18 @@ ___
+ * Group "**loadgen-batchsize**"
+
+ Click here to expand this section.
+
+ * `_batch_size.#`
+ - Environment variables:
+ - *CM_MLPERF_LOADGEN_BATCH_SIZE*: `#`
+ - Workflow:
+
+
+
+
* Group "**loadgen-scenario**"
Click here to expand this section.
@@ -447,6 +483,20 @@ ___
+ * Group "**sut**"
+
+ Click here to expand this section.
+
+ * `_sapphire-rapids.112c`
+ - Environment variables:
+ - *WARMUP*: ` --warmup`
+ - Workflow:
+ * `_sapphire-rapids.24c`
+ - Workflow:
+
+
+
+
#### Default variations
`_cpu,_pytorch,_resnet50,_run-harness,_standalone`
@@ -503,12 +553,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-intel/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-intel/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -541,14 +589,14 @@ ___
* get,mlperf,inference,results,_ctuning
* CM names: `--adr.inference-results...`
- CM script: [get-mlperf-inference-results](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-results)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-intel/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-intel/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-intel/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-intel/_cm.yaml)
1. ***Run native script if exists***
- * [run_bert_harness.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-intel/run_bert_harness.sh)
- * [run_gptj_harness.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-intel/run_gptj_harness.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-intel/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-intel/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-intel/_cm.yaml)***
+ * [run_bert_harness.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-intel/run_bert_harness.sh)
+ * [run_gptj_harness.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-intel/run_gptj_harness.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-intel/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-intel/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-intel/_cm.yaml)***
* benchmark-mlperf
* `if (CM_LOCAL_MLPERF_INFERENCE_INTEL_RUN_MODE == run_harness) AND (CM_MLPERF_SKIP_RUN not in ['yes', True])`
* CM names: `--adr.['runner', 'mlperf-runner']...`
@@ -556,16 +604,10 @@ ___
* save,mlperf,inference,state
* CM names: `--adr.['save-mlperf-inference-state']...`
- CM script: [save-mlperf-inference-implementation-state](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/save-mlperf-inference-implementation-state)
-
___
### Script output
-`cmr "reproduce mlcommons mlperf inference harness intel-harness intel intel-harness intel[,variations]" [--input_flags] -j`
+`cmr "reproduce mlcommons mlperf inference harness intel-harness intel intel-harness intel [,variations]" [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/app-mlperf-inference-mlcommons-cpp/README.md b/cm-mlops/script/app-mlperf-inference-mlcommons-cpp/README.md
index e53d8c5b4c..b3ef641462 100644
--- a/cm-mlops/script/app-mlperf-inference-mlcommons-cpp/README.md
+++ b/cm-mlops/script/app-mlperf-inference-mlcommons-cpp/README.md
@@ -1,64 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **app-mlperf-inference-mlcommons-cpp**
-*Note that this README is automatically generated - don't edit!*
+Category: **Modular MLPerf inference benchmark pipeline**
-### About
+License: **Apache 2.0**
+Developers: [Thomas Zhu](https://www.linkedin.com/in/hanwen-zhu-483614189), [Arjun Suresh](https://www.linkedin.com/in/arjunsuresh), [Grigori Fursin](https://cKnowledge.org/gfursin)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=app-mlperf-inference-mlcommons-cpp,bf62405e6c7a44bf) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Modular MLPerf inference benchmark pipeline.*
-* 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/app-mlperf-inference-mlcommons-cpp)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-mlcommons-cpp)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *app,mlcommons,mlperf,inference,cpp*
+* All CM tags to find and reuse this script (see in above meta description): *app,mlcommons,mlperf,inference,cpp*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "app mlcommons mlperf inference cpp" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=app,mlcommons,mlperf,inference,cpp`
-1. `cm run script --tags=app,mlcommons,mlperf,inference,cpp[,variations] [--input_flags]`
+`cm run script --tags=app,mlcommons,mlperf,inference,cpp[,variations] [--input_flags]`
-2. `cmr "app mlcommons mlperf inference cpp[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "app mlcommons mlperf inference cpp"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "app mlcommons mlperf inference cpp [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -94,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=app,mlcommons,mlperf,i
#### Run this script via Docker (beta)
-`cm docker script "app mlcommons mlperf inference cpp[ variations]" [--input_flags]`
+`cm docker script "app mlcommons mlperf inference cpp[variations]" [--input_flags]`
___
### Customization
@@ -261,12 +252,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-mlcommons-cpp/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-mlcommons-cpp/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -305,12 +294,12 @@ ___
* generate,user-conf,mlperf,inference
* CM names: `--adr.['user-conf-generator']...`
- CM script: [generate-mlperf-inference-user-conf](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-inference-user-conf)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-mlcommons-cpp/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-mlcommons-cpp/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-mlcommons-cpp/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-mlcommons-cpp/_cm.yaml)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-mlcommons-cpp/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-mlcommons-cpp/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-mlcommons-cpp/_cm.yaml)***
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-mlcommons-cpp/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-mlcommons-cpp/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-mlcommons-cpp/_cm.yaml)***
* compile,cpp-program
* `if (CM_MLPERF_SKIP_RUN != yes)`
* CM names: `--adr.['compile-program']...`
@@ -322,11 +311,10 @@ ___
* save,mlperf,inference,state
* CM names: `--adr.['save-mlperf-inference-state']...`
- CM script: [save-mlperf-inference-implementation-state](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/save-mlperf-inference-implementation-state)
-
___
### Script output
-`cmr "app mlcommons mlperf inference cpp[,variations]" [--input_flags] -j`
+`cmr "app mlcommons mlperf inference cpp [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_DATASET_*`
@@ -338,8 +326,4 @@ ___
* `CM_DATASET_LIST`
* `CM_MLPERF_CONF`
* `CM_MLPERF_DEVICE`
-* `CM_MLPERF_USER_CONF`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_MLPERF_USER_CONF`
\ No newline at end of file
diff --git a/cm-mlops/script/app-mlperf-inference-mlcommons-python/README.md b/cm-mlops/script/app-mlperf-inference-mlcommons-python/README.md
index 9e14eec57d..1704ba155f 100644
--- a/cm-mlops/script/app-mlperf-inference-mlcommons-python/README.md
+++ b/cm-mlops/script/app-mlperf-inference-mlcommons-python/README.md
@@ -1,30 +1,15 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **app-mlperf-inference-mlcommons-python**
-
+Category: **Modular MLPerf inference benchmark pipeline**
+
+License: **Apache 2.0**
+
+Developers: [Arjun Suresh](https://www.linkedin.com/in/arjunsuresh), [Thomas Zhu](https://www.linkedin.com/in/hanwen-zhu-483614189), [Grigori Fursin](https://cKnowledge.org/gfursin)
-*Note that this README is automatically generated - don't edit!*
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=app-mlperf-inference-mlcommons-python,ff149e9781fc4b65) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
-### About
+---
This portable CM script is being developed by the [MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/mlperf-education-workgroup.md)
to modularize the *python reference implementations* of the [MLPerf inference benchmark](https://github.com/mlcommons/inference)
@@ -35,38 +20,47 @@ across diverse platforms with continuously changing software and hardware.
See the current coverage of different models, devices and backends [here](README-extra.md#current-coverage).
-See extra [notes](README-extra.md) from the authors and contributors.
-
+---
#### Summary
-* Category: *Modular MLPerf inference benchmark pipeline.*
-* 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/app-mlperf-inference-mlcommons-python)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-mlcommons-python)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *app,vision,language,mlcommons,mlperf,inference,reference,ref*
+* All CM tags to find and reuse this script (see in above meta description): *app,vision,language,mlcommons,mlperf,inference,reference,ref*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "app vision language mlcommons mlperf inference reference ref" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=app,vision,language,mlcommons,mlperf,inference,reference,ref`
-#### Run this script from command line
+`cm run script --tags=app,vision,language,mlcommons,mlperf,inference,reference,ref[,variations] [--input_flags]`
-1. `cm run script --tags=app,vision,language,mlcommons,mlperf,inference,reference,ref[,variations] [--input_flags]`
+*or*
-2. `cmr "app vision language mlcommons mlperf inference reference ref[ variations]" [--input_flags]`
+`cmr "app vision language mlcommons mlperf inference reference ref"`
-* `variations` can be seen [here](#variations)
+`cmr "app vision language mlcommons mlperf inference reference ref [variations]" [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -102,7 +96,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=app,vision,language,ml
#### Run this script via Docker (beta)
-`cm docker script "app vision language mlcommons mlperf inference reference ref[ variations]" [--input_flags]`
+`cm docker script "app vision language mlcommons mlperf inference reference ref[variations]" [--input_flags]`
___
### Customization
@@ -553,6 +547,24 @@ ___
+ * Group "**network**"
+
+ Click here to expand this section.
+
+ * `_network-lon`
+ - Environment variables:
+ - *CM_NETWORK_LOADGEN*: `lon`
+ - *CM_MLPERF_SUT_NAME_RUN_CONFIG_SUFFIX1*: `network_loadgen`
+ - Workflow:
+ * `_network-sut`
+ - Environment variables:
+ - *CM_MLPERF_SUT_NAME_RUN_CONFIG_SUFFIX1*: `network_sut`
+ - *CM_NETWORK_LOADGEN*: `sut`
+ - Workflow:
+
+
+
+
* Group "**precision**"
Click here to expand this section.
@@ -648,12 +660,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-mlcommons-python/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-mlcommons-python/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -831,28 +841,27 @@ ___
- CM script: [get-mlperf-inference-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-src)
* get,generic-python-lib,_package.psutil
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-mlcommons-python/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-mlcommons-python/_cm.yaml)***
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-mlcommons-python/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-mlcommons-python/_cm.yaml)***
* remote,run,cmds
* `if (CM_ASSH_RUN_COMMANDS == on)`
* CM names: `--adr.['remote-run-cmds']...`
- CM script: [remote-run-commands](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/remote-run-commands)
1. ***Run native script if exists***
- 1. ***Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-mlcommons-python/_cm.yaml)***
+ 1. ***Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-mlcommons-python/_cm.yaml)***
* benchmark-mlperf
* `if (CM_MLPERF_SKIP_RUN != on)`
* CM names: `--adr.['mlperf-runner']...`
- CM script: [benchmark-program-mlperf](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program-mlperf)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-mlcommons-python/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-mlcommons-python/_cm.yaml)***
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-mlcommons-python/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-mlcommons-python/_cm.yaml)***
* save,mlperf,inference,state
* CM names: `--adr.['save-mlperf-inference-state']...`
- CM script: [save-mlperf-inference-implementation-state](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/save-mlperf-inference-implementation-state)
-
___
### Script output
-`cmr "app vision language mlcommons mlperf inference reference ref[,variations]" [--input_flags] -j`
+`cmr "app vision language mlcommons mlperf inference reference ref [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_DATASET_*`
@@ -871,8 +880,4 @@ ___
* `CM_MLPERF_LOADGEN_SCENARIO`
* `CM_MLPERF_OUTPUT_DIR`
* `CM_MLPERF_RUN_CMD`
-* `CM_ML_MODEL_FILE_WITH_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_ML_MODEL_FILE_WITH_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/app-mlperf-inference-nvidia/README.md b/cm-mlops/script/app-mlperf-inference-nvidia/README.md
index 8c74e3f81e..4ecf00b7d7 100644
--- a/cm-mlops/script/app-mlperf-inference-nvidia/README.md
+++ b/cm-mlops/script/app-mlperf-inference-nvidia/README.md
@@ -1,30 +1,15 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **app-mlperf-inference-nvidia**
-
+Category: **Reproduce MLPerf benchmarks**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=app-mlperf-inference-nvidia,bc3b17fb430f4732) ]*
+
+---
This script is a CM wrapper to the official [Nvidia submission code](https://github.com/mlcommons/inference_results_v3.0/tree/master/closed/NVIDIA) used for MLPerf inference submissions.
@@ -164,36 +149,48 @@ Assuming all the downloaded files are to the user home directory please do the f
* Nvidia's MLPerf inference implementation was developed by Zhihan Jiang, Ethan Cheng, Yiheng Zhang and Jinho Suh.
+
+---
#### Summary
-* Category: *Reproduce MLPerf benchmarks.*
-* 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/app-mlperf-inference-nvidia)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-nvidia)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *reproduce,mlcommons,mlperf,inference,harness,nvidia-harness,nvidia*
+* All CM tags to find and reuse this script (see in above meta description): *reproduce,mlcommons,mlperf,inference,harness,nvidia-harness,nvidia*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "reproduce mlcommons mlperf inference harness nvidia-harness nvidia" --help````
-#### Run this script from command line
+#### Customize and run this script from the command line with different variations and flags
-1. `cm run script --tags=reproduce,mlcommons,mlperf,inference,harness,nvidia-harness,nvidia[,variations] [--input_flags]`
+`cm run script --tags=reproduce,mlcommons,mlperf,inference,harness,nvidia-harness,nvidia`
-2. `cmr "reproduce mlcommons mlperf inference harness nvidia-harness nvidia[ variations]" [--input_flags]`
+`cm run script --tags=reproduce,mlcommons,mlperf,inference,harness,nvidia-harness,nvidia[,variations] [--input_flags]`
-* `variations` can be seen [here](#variations)
+*or*
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "reproduce mlcommons mlperf inference harness nvidia-harness nvidia"`
+
+`cmr "reproduce mlcommons mlperf inference harness nvidia-harness nvidia [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -229,7 +226,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=reproduce,mlcommons,ml
#### Run this script via Docker (beta)
-`cm docker script "reproduce mlcommons mlperf inference harness nvidia-harness nvidia[ variations]" [--input_flags]`
+`cm docker script "reproduce mlcommons mlperf inference harness nvidia-harness nvidia[variations]" [--input_flags]`
___
### Customization
@@ -1201,12 +1198,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-nvidia/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-nvidia/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -1279,17 +1274,17 @@ ___
- CM script: [generate-mlperf-inference-user-conf](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-inference-user-conf)
* get,generic-python-lib,_package.nvmitten,_path./opt/nvmitten-0.1.3-cp38-cp38-linux_x86_64.whl
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-nvidia/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-nvidia/_cm.yaml)***
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-nvidia/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-nvidia/_cm.yaml)***
* get,ml-model,gptj,_pytorch,_rclone
* `if (CM_REQUIRE_GPTJ_MODEL_DOWNLOAD == yes AND CM_MLPERF_NVIDIA_HARNESS_RUN_MODE in ['download_model', 'preprocess_data'])`
* CM names: `--adr.['gptj-model']...`
- CM script: [get-ml-model-gptj](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-gptj)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-nvidia/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-nvidia/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-nvidia/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-nvidia/_cm.yaml)***
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-nvidia/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-nvidia/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-nvidia/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-nvidia/_cm.yaml)***
* benchmark-mlperf
* `if (CM_CALL_MLPERF_RUNNER == True) AND (CM_MLPERF_SKIP_RUN not in ['yes', True])`
* CM names: `--adr.['runner', 'mlperf-runner']...`
@@ -1297,16 +1292,10 @@ ___
* save,mlperf,inference,state
* CM names: `--adr.['save-mlperf-inference-state']...`
- CM script: [save-mlperf-inference-implementation-state](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/save-mlperf-inference-implementation-state)
-
___
### Script output
-`cmr "reproduce mlcommons mlperf inference harness nvidia-harness nvidia[,variations]" [--input_flags] -j`
+`cmr "reproduce mlcommons mlperf inference harness nvidia-harness nvidia [,variations]" [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/app-mlperf-inference-qualcomm/README.md b/cm-mlops/script/app-mlperf-inference-qualcomm/README.md
index 7306facada..c070d9d4df 100644
--- a/cm-mlops/script/app-mlperf-inference-qualcomm/README.md
+++ b/cm-mlops/script/app-mlperf-inference-qualcomm/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **app-mlperf-inference-qualcomm**
-
+Category: **Modular MLPerf benchmarks**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=app-mlperf-inference-qualcomm,eef1aca5d7c0470e) ]*
+
+---
#### Summary
-* Category: *Modular MLPerf benchmarks.*
-* 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/app-mlperf-inference-qualcomm)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-qualcomm)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *reproduce,mlcommons,mlperf,inference,harness,qualcomm-harness,qualcomm,kilt-harness,kilt*
+* All CM tags to find and reuse this script (see in above meta description): *reproduce,mlcommons,mlperf,inference,harness,qualcomm-harness,qualcomm,kilt-harness,kilt*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "reproduce mlcommons mlperf inference harness qualcomm-harness qualcomm kilt-harness kilt" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=reproduce,mlcommons,mlperf,inference,harness,qualcomm-harness,qualcomm,kilt-harness,kilt`
-1. `cm run script --tags=reproduce,mlcommons,mlperf,inference,harness,qualcomm-harness,qualcomm,kilt-harness,kilt[,variations] [--input_flags]`
+`cm run script --tags=reproduce,mlcommons,mlperf,inference,harness,qualcomm-harness,qualcomm,kilt-harness,kilt[,variations] [--input_flags]`
-2. `cmr "reproduce mlcommons mlperf inference harness qualcomm-harness qualcomm kilt-harness kilt[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "reproduce mlcommons mlperf inference harness qualcomm-harness qualcomm kilt-harness kilt"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "reproduce mlcommons mlperf inference harness qualcomm-harness qualcomm kilt-harness kilt [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=reproduce,mlcommons,ml
#### Run this script via Docker (beta)
-`cm docker script "reproduce mlcommons mlperf inference harness qualcomm-harness qualcomm kilt-harness kilt[ variations]" [--input_flags]`
+`cm docker script "reproduce mlcommons mlperf inference harness qualcomm-harness qualcomm kilt-harness kilt[variations]" [--input_flags]`
___
### Customization
@@ -654,12 +648,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-qualcomm/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-qualcomm/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -715,13 +707,13 @@ ___
* get,lib,onnxruntime,lang-cpp,_cuda
* `if (CM_MLPERF_BACKEND == onnxruntime AND CM_MLPERF_DEVICE == gpu)`
- CM script: [get-onnxruntime-prebuilt](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-onnxruntime-prebuilt)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-qualcomm/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-qualcomm/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-qualcomm/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-qualcomm/_cm.yaml)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-qualcomm/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-qualcomm/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-qualcomm/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-qualcomm/_cm.yaml)***
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-qualcomm/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-qualcomm/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-qualcomm/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-qualcomm/_cm.yaml)***
* compile,cpp-program
* `if (CM_MLPERF_SKIP_RUN != True)`
* CM names: `--adr.['compile-program']...`
@@ -733,11 +725,10 @@ ___
* save,mlperf,inference,state
* CM names: `--adr.['save-mlperf-inference-state']...`
- CM script: [save-mlperf-inference-implementation-state](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/save-mlperf-inference-implementation-state)
-
___
### Script output
-`cmr "reproduce mlcommons mlperf inference harness qualcomm-harness qualcomm kilt-harness kilt[,variations]" [--input_flags] -j`
+`cmr "reproduce mlcommons mlperf inference harness qualcomm-harness qualcomm kilt-harness kilt [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_DATASET_*`
@@ -752,8 +743,4 @@ ___
* `CM_DATASET_LIST`
* `CM_MLPERF_CONF`
* `CM_MLPERF_DEVICE`
-* `CM_MLPERF_USER_CONF`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_MLPERF_USER_CONF`
\ No newline at end of file
diff --git a/cm-mlops/script/app-mlperf-inference/README.md b/cm-mlops/script/app-mlperf-inference/README.md
index 86381a1f3d..81bbd528cd 100644
--- a/cm-mlops/script/app-mlperf-inference/README.md
+++ b/cm-mlops/script/app-mlperf-inference/README.md
@@ -1,32 +1,15 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Unsupported or invalid variation combinations](#unsupported-or-invalid-variation-combinations)
- * [ Input description](#input-description)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **app-mlperf-inference**
-
+Category: **Modular MLPerf inference benchmark pipeline**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Developers: [Arjun Suresh](https://www.linkedin.com/in/arjunsuresh), [Thomas Zhu](https://www.linkedin.com/in/hanwen-zhu-483614189), [Grigori Fursin](https://cKnowledge.org/gfursin)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=app-mlperf-inference,d775cac873ee4231) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+
+---
This CM script provides a unified interface to prepare and run a modular version of the [MLPerf inference benchmark](https://arxiv.org/abs/1911.02549)
across diverse ML models, data sets, frameworks, libraries, run-time systems and platforms
@@ -52,39 +35,77 @@ if you need help with your submission or if you would like to participate in fur
and collaborative design space exploration and optimization of ML Systems.
-See extra [notes](README-extra.md) from the authors and contributors.
-
+---
#### Summary
-* Category: *Modular MLPerf inference benchmark pipeline.*
-* 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/app-mlperf-inference)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *app,vision,language,mlcommons,mlperf,inference,generic*
+* All CM tags to find and reuse this script (see in above meta description): *app,vision,language,mlcommons,mlperf,inference,generic*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "app vision language mlcommons mlperf inference generic" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=app,vision,language,mlcommons,mlperf,inference,generic`
-1. `cm run script --tags=app,vision,language,mlcommons,mlperf,inference,generic[,variations] [--input_flags]`
+`cm run script --tags=app,vision,language,mlcommons,mlperf,inference,generic[,variations] [--input_flags]`
-2. `cmr "app vision language mlcommons mlperf inference generic[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "app vision language mlcommons mlperf inference generic"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "app vision language mlcommons mlperf inference generic [variations]" [--input_flags]`
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
+
+
+#### Input Flags
+
+* --**scenario**=MLPerf inference scenario {Offline,Server,SingleStream,MultiStream} (*Offline*)
+* --**mode**=MLPerf inference mode {performance,accuracy} (*accuracy*)
+* --**test_query_count**=Specifies the number of samples to be processed during a test run
+* --**target_qps**=Target QPS
+* --**target_latency**=Target Latency
+* --**max_batchsize**=Maximum batchsize to be used
+* --**num_threads**=Number of CPU threads to launch the application with
+* --**hw_name**=Valid value - any system description which has a config file (under same name) defined [here](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-configs-sut-mlperf-inference/configs)
+* --**output_dir**=Location where the outputs are produced
+* --**rerun**=Redo the run even if previous run files exist (*True*)
+* --**regenerate_files**=Regenerates measurement files including accuracy.txt files even if a previous run exists. This option is redundant if `--rerun` is used
+* --**adr.python.name**=Python virtual environment name (optional) (*mlperf*)
+* --**adr.python.version_min**=Minimal Python version (*3.8*)
+* --**adr.python.version**=Force Python version (must have all system deps)
+* --**adr.compiler.tags**=Compiler for loadgen (*gcc*)
+* --**adr.inference-src-loadgen.env.CM_GIT_URL**=Git URL for MLPerf inference sources to build LoadGen (to enable non-reference implementations)
+* --**adr.inference-src.env.CM_GIT_URL**=Git URL for MLPerf inference sources to run benchmarks (to enable non-reference implementations)
+* --**quiet**=Quiet run (select default values for all questions) (*False*)
+* --**readme**=Generate README with the reproducibility report
+* --**debug**=Debug MLPerf script
+
+**Above CLI flags can be used in the Python CM API as follows:**
+
+```python
+r=cm.access({... , "scenario":...}
+```
#### Run this script from Python
@@ -119,7 +140,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=app,vision,language,ml
#### Run this script via Docker (beta)
-`cm docker script "app vision language mlcommons mlperf inference generic[ variations]" [--input_flags]`
+`cm docker script "app vision language mlcommons mlperf inference generic[variations]" [--input_flags]`
___
### Customization
@@ -567,15 +588,27 @@ ___
Click here to expand this section.
+ * `_intel-original,bert-99`
+ - Workflow:
+ * `_intel-original,bert-99.9`
+ - Workflow:
+ * `_intel-original,gptj-99`
+ - Workflow:
+ * `_intel-original,gptj-99.9`
+ - Workflow:
* `_intel-original,gptj_,build-harness`
- Workflow:
- * `_kilt,qualcomm,bert-99`
+ * `_intel-original,resnet50`
- Workflow:
- * `_kilt,qualcomm,bert-99.9`
+ * `_intel-original,retinanet`
- Workflow:
- * `_kilt,qualcomm,resnet50`
+ * `_kilt,qaic,bert-99`
- Workflow:
- * `_kilt,qualcomm,retinanet`
+ * `_kilt,qaic,bert-99.9`
+ - Workflow:
+ * `_kilt,qaic,resnet50`
+ - Workflow:
+ * `_kilt,qaic,retinanet`
- Workflow:
* `_power`
- Environment variables:
@@ -650,35 +683,6 @@ ___
`_cpu,_float32,_offline,_reference,_resnet50,_test`
-#### Input description
-
-* --**scenario** MLPerf inference scenario {Offline,Server,SingleStream,MultiStream} (*Offline*)
-* --**mode** MLPerf inference mode {performance,accuracy} (*accuracy*)
-* --**test_query_count** Specifies the number of samples to be processed during a test run
-* --**target_qps** Target QPS
-* --**target_latency** Target Latency
-* --**max_batchsize** Maximum batchsize to be used
-* --**num_threads** Number of CPU threads to launch the application with
-* --**hw_name** Valid value - any system description which has a config file (under same name) defined [here](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-configs-sut-mlperf-inference/configs)
-* --**output_dir** Location where the outputs are produced
-* --**rerun** Redo the run even if previous run files exist (*True*)
-* --**regenerate_files** Regenerates measurement files including accuracy.txt files even if a previous run exists. This option is redundant if `--rerun` is used
-* --**adr.python.name** Python virtual environment name (optional) (*mlperf*)
-* --**adr.python.version_min** Minimal Python version (*3.8*)
-* --**adr.python.version** Force Python version (must have all system deps)
-* --**adr.compiler.tags** Compiler for loadgen (*gcc*)
-* --**adr.inference-src-loadgen.env.CM_GIT_URL** Git URL for MLPerf inference sources to build LoadGen (to enable non-reference implementations)
-* --**adr.inference-src.env.CM_GIT_URL** Git URL for MLPerf inference sources to run benchmarks (to enable non-reference implementations)
-* --**quiet** Quiet run (select default values for all questions) (*False*)
-* --**readme** Generate README with the reproducibility report
-* --**debug** Debug MLPerf script
-
-**Above CLI flags can be used in the Python CM API as follows:**
-
-```python
-r=cm.access({... , "scenario":...}
-```
-
#### Script flags mapped to environment
Click here to expand this section.
@@ -736,12 +740,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,sys-utils-cm
@@ -754,27 +756,22 @@ ___
- CM script: [get-mlperf-inference-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-src)
* get,mlperf,inference,utils
- CM script: [get-mlperf-inference-utils](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-utils)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference/_cm.yaml)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference/run.sh)
- 1. ***Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference/_cm.yaml)***
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference/run.sh)
+ 1. ***Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference/_cm.yaml)***
* get,mlperf,sut,description
- CM script: [get-mlperf-inference-sut-description](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-sut-description)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference/_cm.yaml)
-
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference/_cm.yaml)
___
### Script output
-`cmr "app vision language mlcommons mlperf inference generic[,variations]" [--input_flags] -j`
+`cmr "app vision language mlcommons mlperf inference generic [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_MLPERF_*`
#### New environment keys auto-detected from customize
-* `CM_MLPERF_LOADGEN_COMPLIANCE_TEST`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_MLPERF_LOADGEN_COMPLIANCE_TEST`
\ No newline at end of file
diff --git a/cm-mlops/script/app-mlperf-training-nvidia/README.md b/cm-mlops/script/app-mlperf-training-nvidia/README.md
index 7ff7a463f7..fcc4a83f94 100644
--- a/cm-mlops/script/app-mlperf-training-nvidia/README.md
+++ b/cm-mlops/script/app-mlperf-training-nvidia/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **app-mlperf-training-nvidia**
-
+Category: **Modular MLPerf training benchmark pipeline**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=app-mlperf-training-nvidia,1e2e357618cc4674) ]*
+
+---
#### Summary
-* Category: *Modular MLPerf training benchmark pipeline.*
-* 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/app-mlperf-training-nvidia)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-nvidia)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *app,vision,language,mlcommons,mlperf,training,nvidia*
+* All CM tags to find and reuse this script (see in above meta description): *app,vision,language,mlcommons,mlperf,training,nvidia*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "app vision language mlcommons mlperf training nvidia" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=app,vision,language,mlcommons,mlperf,training,nvidia`
-1. `cm run script --tags=app,vision,language,mlcommons,mlperf,training,nvidia[,variations] [--input_flags]`
+`cm run script --tags=app,vision,language,mlcommons,mlperf,training,nvidia[,variations] [--input_flags]`
-2. `cmr "app vision language mlcommons mlperf training nvidia[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "app vision language mlcommons mlperf training nvidia"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "app vision language mlcommons mlperf training nvidia [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=app,vision,language,ml
#### Run this script via Docker (beta)
-`cm docker script "app vision language mlcommons mlperf training nvidia[ variations]" [--input_flags]`
+`cm docker script "app vision language mlcommons mlperf training nvidia[variations]" [--input_flags]`
___
### Customization
@@ -193,12 +187,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-nvidia/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-nvidia/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -227,19 +219,18 @@ ___
* `if (CM_MLPERF_MODEL == bert)`
* CM names: `--adr.['prepare-data', 'bert-model']...`
- CM script: [prepare-training-data-bert](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-bert)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-nvidia/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-nvidia/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-nvidia/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-nvidia/_cm.yaml)
1. ***Run native script if exists***
- * [run-bert-training.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-nvidia/run-bert-training.sh)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-nvidia/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-nvidia/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-nvidia/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-nvidia/_cm.yaml)
-
+ * [run-bert-training.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-nvidia/run-bert-training.sh)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-nvidia/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-nvidia/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-nvidia/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-nvidia/_cm.yaml)
___
### Script output
-`cmr "app vision language mlcommons mlperf training nvidia[,variations]" [--input_flags] -j`
+`cmr "app vision language mlcommons mlperf training nvidia [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_DATASET_*`
@@ -247,8 +238,3 @@ ___
* `CM_MLPERF_*`
* `CM_ML_MODEL_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/app-mlperf-training-reference/README.md b/cm-mlops/script/app-mlperf-training-reference/README.md
index 7535c0378e..479f01d0eb 100644
--- a/cm-mlops/script/app-mlperf-training-reference/README.md
+++ b/cm-mlops/script/app-mlperf-training-reference/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **app-mlperf-training-reference**
-
+Category: **Modular MLPerf training benchmark pipeline**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=app-mlperf-training-reference,0c4b11bdcf494b4f) ]*
+
+---
#### Summary
-* Category: *Modular MLPerf training benchmark pipeline.*
-* 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/app-mlperf-training-reference)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-reference)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *app,vision,language,mlcommons,mlperf,training,reference,ref*
+* All CM tags to find and reuse this script (see in above meta description): *app,vision,language,mlcommons,mlperf,training,reference,ref*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "app vision language mlcommons mlperf training reference ref" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=app,vision,language,mlcommons,mlperf,training,reference,ref`
-1. `cm run script --tags=app,vision,language,mlcommons,mlperf,training,reference,ref[,variations] [--input_flags]`
+`cm run script --tags=app,vision,language,mlcommons,mlperf,training,reference,ref[,variations] [--input_flags]`
-2. `cmr "app vision language mlcommons mlperf training reference ref[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "app vision language mlcommons mlperf training reference ref"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "app vision language mlcommons mlperf training reference ref [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=app,vision,language,ml
#### Run this script via Docker (beta)
-`cm docker script "app vision language mlcommons mlperf training reference ref[ variations]" [--input_flags]`
+`cm docker script "app vision language mlcommons mlperf training reference ref[variations]" [--input_flags]`
___
### Customization
@@ -194,12 +188,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-reference/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-reference/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -225,19 +217,18 @@ ___
* `if (CM_MLPERF_MODEL == bert)`
* CM names: `--adr.['prepare-data', 'bert-model']...`
- CM script: [prepare-training-data-bert](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-bert)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-reference/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-reference/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-reference/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-reference/_cm.yaml)
1. ***Run native script if exists***
- * [run-bert-training.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-reference/run-bert-training.sh)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-reference/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-reference/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-reference/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-reference/_cm.yaml)
-
+ * [run-bert-training.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-reference/run-bert-training.sh)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-reference/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-reference/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-reference/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-reference/_cm.yaml)
___
### Script output
-`cmr "app vision language mlcommons mlperf training reference ref[,variations]" [--input_flags] -j`
+`cmr "app vision language mlcommons mlperf training reference ref [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_DATASET_*`
@@ -245,8 +236,3 @@ ___
* `CM_MLPERF_*`
* `CM_ML_MODEL_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/app-stable-diffusion-onnx-py/README.md b/cm-mlops/script/app-stable-diffusion-onnx-py/README.md
index 5f820009bb..48302cf769 100644
--- a/cm-mlops/script/app-stable-diffusion-onnx-py/README.md
+++ b/cm-mlops/script/app-stable-diffusion-onnx-py/README.md
@@ -1,66 +1,67 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Input description](#input-description)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **app-stable-diffusion-onnx-py**
-*Note that this README is automatically generated - don't edit!*
+Category: **Modular AI/ML application pipeline**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=app-stable-diffusion-onnx-py,4d33981ac3534b3b) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Modular AI/ML application pipeline.*
-* 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/app-stable-diffusion-onnx-py)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-stable-diffusion-onnx-py)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *modular,python,app,stable-diffusion,onnx*
+* All CM tags to find and reuse this script (see in above meta description): *modular,python,app,stable-diffusion,onnx*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "modular python app stable-diffusion onnx" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=modular,python,app,stable-diffusion,onnx`
-1. `cm run script --tags=modular,python,app,stable-diffusion,onnx[,variations] [--input_flags]`
+`cm run script --tags=modular,python,app,stable-diffusion,onnx[,variations] [--input_flags]`
-2. `cmr "modular python app stable-diffusion onnx[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "modular python app stable-diffusion onnx"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "modular python app stable-diffusion onnx [variations]" [--input_flags]`
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
+
+
+#### Input Flags
+
+* --**text**=Text to generate image
+* --**output**=Output directory
+
+**Above CLI flags can be used in the Python CM API as follows:**
+
+```python
+r=cm.access({... , "text":...}
+```
#### Run this script from Python
@@ -95,7 +96,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=modular,python,app,sta
#### Run this script via Docker (beta)
-`cm docker script "modular python app stable-diffusion onnx[ variations]" [--input_flags]`
+`cm docker script "modular python app stable-diffusion onnx[variations]" [--input_flags]`
___
### Customization
@@ -125,17 +126,6 @@ ___
`_cpu`
-#### Input description
-
-* --**text** Text to generate image
-* --**output** Output directory
-
-**Above CLI flags can be used in the Python CM API as follows:**
-
-```python
-r=cm.access({... , "text":...}
-```
-
#### Script flags mapped to environment
Click here to expand this section.
@@ -162,12 +152,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-stable-diffusion-onnx-py/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-stable-diffusion-onnx-py/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,sys-utils-cm
@@ -197,23 +185,17 @@ ___
* get,ml-model,huggingface,zoo,_model-stub.runwayml/stable-diffusion-v1-5
- CM script: [get-ml-model-huggingface-zoo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-huggingface-zoo)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-stable-diffusion-onnx-py/_cm.yaml)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-stable-diffusion-onnx-py/_cm.yaml)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-stable-diffusion-onnx-py/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-stable-diffusion-onnx-py/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-stable-diffusion-onnx-py/_cm.yaml)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-stable-diffusion-onnx-py/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-stable-diffusion-onnx-py/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-stable-diffusion-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-stable-diffusion-onnx-py/_cm.yaml)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-stable-diffusion-onnx-py/_cm.yaml)
___
### Script output
-`cmr "modular python app stable-diffusion onnx[,variations]" [--input_flags] -j`
+`cmr "modular python app stable-diffusion onnx [,variations]" [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/benchmark-any-mlperf-inference-implementation/README.md b/cm-mlops/script/benchmark-any-mlperf-inference-implementation/README.md
index 4fc2a24b56..373ddc45c6 100644
--- a/cm-mlops/script/benchmark-any-mlperf-inference-implementation/README.md
+++ b/cm-mlops/script/benchmark-any-mlperf-inference-implementation/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **benchmark-any-mlperf-inference-implementation**
-
+Category: **MLPerf benchmark support**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=benchmark-any-mlperf-inference-implementation,8d3cd46f54464810) ]*
+
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/benchmark-any-mlperf-inference-implementation)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-any-mlperf-inference-implementation)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *benchmark,run,natively,all,inference,any,mlperf,mlperf-implementation,implementation,mlperf-models*
+* All CM tags to find and reuse this script (see in above meta description): *benchmark,run,natively,all,inference,any,mlperf,mlperf-implementation,implementation,mlperf-models*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "benchmark run natively all inference any mlperf mlperf-implementation implementation mlperf-models" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=benchmark,run,natively,all,inference,any,mlperf,mlperf-implementation,implementation,mlperf-models`
-1. `cm run script --tags=benchmark,run,natively,all,inference,any,mlperf,mlperf-implementation,implementation,mlperf-models[,variations] [--input_flags]`
+`cm run script --tags=benchmark,run,natively,all,inference,any,mlperf,mlperf-implementation,implementation,mlperf-models[,variations] [--input_flags]`
-2. `cmr "benchmark run natively all inference any mlperf mlperf-implementation implementation mlperf-models[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "benchmark run natively all inference any mlperf mlperf-implementation implementation mlperf-models"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "benchmark run natively all inference any mlperf mlperf-implementation implementation mlperf-models [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=benchmark,run,natively
#### Run this script via Docker (beta)
-`cm docker script "benchmark run natively all inference any mlperf mlperf-implementation implementation mlperf-models[ variations]" [--input_flags]`
+`cm docker script "benchmark run natively all inference any mlperf mlperf-implementation implementation mlperf-models[variations]" [--input_flags]`
___
### Customization
@@ -254,31 +248,23 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-any-mlperf-inference-implementation/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-any-mlperf-inference-implementation/_cm.yaml)***
* detect,cpu
- CM script: [detect-cpu](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-any-mlperf-inference-implementation/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-any-mlperf-inference-implementation/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-any-mlperf-inference-implementation/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-any-mlperf-inference-implementation/_cm.yaml)
1. ***Run native script if exists***
- * [run-template.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-any-mlperf-inference-implementation/run-template.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-any-mlperf-inference-implementation/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-any-mlperf-inference-implementation/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-any-mlperf-inference-implementation/_cm.yaml)
-
+ * [run-template.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-any-mlperf-inference-implementation/run-template.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-any-mlperf-inference-implementation/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-any-mlperf-inference-implementation/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-any-mlperf-inference-implementation/_cm.yaml)
___
### Script output
-`cmr "benchmark run natively all inference any mlperf mlperf-implementation implementation mlperf-models[,variations]" [--input_flags] -j`
+`cmr "benchmark run natively all inference any mlperf mlperf-implementation implementation mlperf-models [,variations]" [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/benchmark-program-mlperf/README.md b/cm-mlops/script/benchmark-program-mlperf/README.md
index d81b0bb059..14e32bb1ac 100644
--- a/cm-mlops/script/benchmark-program-mlperf/README.md
+++ b/cm-mlops/script/benchmark-program-mlperf/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **benchmark-program-mlperf**
-
+Category: **Modular MLPerf inference benchmark pipeline**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=benchmark-program-mlperf,cfff0132a8aa4018) ]*
+---
#### Summary
-* Category: *Modular MLPerf inference benchmark pipeline.*
-* 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/benchmark-program-mlperf)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-program-mlperf)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *mlperf,benchmark-mlperf*
+* All CM tags to find and reuse this script (see in above meta description): *mlperf,benchmark-mlperf*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "mlperf benchmark-mlperf" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=mlperf,benchmark-mlperf`
-#### Run this script from command line
+`cm run script --tags=mlperf,benchmark-mlperf[,variations] `
-1. `cm run script --tags=mlperf,benchmark-mlperf[,variations] `
+*or*
-2. `cmr "mlperf benchmark-mlperf[ variations]" `
+`cmr "mlperf benchmark-mlperf"`
-* `variations` can be seen [here](#variations)
+`cmr "mlperf benchmark-mlperf [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=mlperf,benchmark-mlper
#### Run this script via Docker (beta)
-`cm docker script "mlperf benchmark-mlperf[ variations]" `
+`cm docker script "mlperf benchmark-mlperf[variations]" `
___
### Customization
@@ -137,28 +134,20 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program-mlperf/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program-mlperf/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program-mlperf/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-program-mlperf/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-program-mlperf/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-program-mlperf/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program-mlperf/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program-mlperf/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program-mlperf/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-program-mlperf/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-program-mlperf/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-program-mlperf/_cm.json)
___
### Script output
-`cmr "mlperf benchmark-mlperf[,variations]" -j`
+`cmr "mlperf benchmark-mlperf [,variations]" -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/benchmark-program/README.md b/cm-mlops/script/benchmark-program/README.md
index 926c916db4..5cd6ce2cca 100644
--- a/cm-mlops/script/benchmark-program/README.md
+++ b/cm-mlops/script/benchmark-program/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **benchmark-program**
-
+Category: **DevOps automation**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=benchmark-program,19f369ef47084895) ]*
+---
#### Summary
-* Category: *DevOps automation.*
-* 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/benchmark-program)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-program)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *benchmark,program*
+* All CM tags to find and reuse this script (see in above meta description): *benchmark,program*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "benchmark program" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=benchmark,program`
-#### Run this script from command line
+`cm run script --tags=benchmark,program[,variations] `
-1. `cm run script --tags=benchmark,program[,variations] `
+*or*
-2. `cmr "benchmark program[ variations]" `
+`cmr "benchmark program"`
-* `variations` can be seen [here](#variations)
+`cmr "benchmark program [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=benchmark,program) to
#### Run this script via Docker (beta)
-`cm docker script "benchmark program[ variations]" `
+`cm docker script "benchmark program[variations]" `
___
### Customization
@@ -125,38 +122,31 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-program/_cm.json)***
* detect,cpu
- CM script: [detect-cpu](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
* set,performance,mode,_performance
* `if (CM_SET_PERFORMANCE_MODE in ['on', 'yes', 'True', True])`
- CM script: [set-performance-mode](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-performance-mode)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-program/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-program/_cm.json)
1. ***Run native script if exists***
- * [run-ubuntu.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program/run-ubuntu.sh)
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program/_cm.json)
-
+ * [run-ubuntu.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-program/run-ubuntu.sh)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-program/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-program/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-program/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-program/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-program/_cm.json)
___
### Script output
-`cmr "benchmark program[,variations]" -j`
+`cmr "benchmark program [,variations]" -j`
#### New environment keys (filter)
* `CM_RUN_CMD`
#### New environment keys auto-detected from customize
-* `CM_RUN_CMD`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_RUN_CMD`
\ No newline at end of file
diff --git a/cm-mlops/script/build-docker-image/README.md b/cm-mlops/script/build-docker-image/README.md
index d5391e38a5..49d7369483 100644
--- a/cm-mlops/script/build-docker-image/README.md
+++ b/cm-mlops/script/build-docker-image/README.md
@@ -1,61 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **build-docker-image**
-*Note that this README is automatically generated - don't edit!*
+Category: **Docker automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=build-docker-image,2c3c4ba2413442e7) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Docker automation.*
-* 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/build-docker-image)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-docker-image)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *build,docker,image,docker-image,dockerimage*
+* All CM tags to find and reuse this script (see in above meta description): *build,docker,image,docker-image,dockerimage*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "build docker image docker-image dockerimage" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=build,docker,image,docker-image,dockerimage`
-1. `cm run script --tags=build,docker,image,docker-image,dockerimage [--input_flags]`
+`cm run script --tags=build,docker,image,docker-image,dockerimage [--input_flags]`
-2. `cmr "build docker image docker-image dockerimage" [--input_flags]`
+*or*
+
+`cmr "build docker image docker-image dockerimage"`
+
+`cmr "build docker image docker-image dockerimage " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -136,28 +128,25 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-docker-image/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-docker-image/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-docker-image/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-docker-image/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-docker-image/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-docker-image/_cm.json)***
* build,dockerfile
* `if (CM_BUILD_DOCKERFILE in ['yes', '1'])`
- CM script: [build-dockerfile](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-dockerfile)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-docker-image/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-docker-image/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-docker-image/_cm.json)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-docker-image/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-docker-image/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-docker-image/_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/build-docker-image/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-docker-image/_cm.json)
___
### Script output
-`cmr "build docker image docker-image dockerimage" [--input_flags] -j`
+`cmr "build docker image docker-image dockerimage " [--input_flags] -j`
#### New environment keys (filter)
* `CM_DOCKER_*`
@@ -167,8 +156,4 @@ ___
* `CM_DOCKER_CACHE_ARG`
* `CM_DOCKER_IMAGE_NAME`
* `CM_DOCKER_IMAGE_REPO`
-* `CM_DOCKER_IMAGE_TAG`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_DOCKER_IMAGE_TAG`
\ No newline at end of file
diff --git a/cm-mlops/script/build-dockerfile/README.md b/cm-mlops/script/build-dockerfile/README.md
index e1542b89d7..5c7aa7eb7a 100644
--- a/cm-mlops/script/build-dockerfile/README.md
+++ b/cm-mlops/script/build-dockerfile/README.md
@@ -1,64 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **build-dockerfile**
-*Note that this README is automatically generated - don't edit!*
+Category: **Docker automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=build-dockerfile,e66a7483230d4641) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Docker automation.*
-* 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/build-dockerfile)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-dockerfile)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *build,dockerfile*
+* All CM tags to find and reuse this script (see in above meta description): *build,dockerfile*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "build dockerfile" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=build,dockerfile`
-1. `cm run script --tags=build,dockerfile[,variations] [--input_flags]`
+`cm run script --tags=build,dockerfile[,variations] [--input_flags]`
-2. `cmr "build dockerfile[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "build dockerfile"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "build dockerfile [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -94,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=build,dockerfile) to g
#### Run this script via Docker (beta)
-`cm docker script "build dockerfile[ variations]" [--input_flags]`
+`cm docker script "build dockerfile[variations]" [--input_flags]`
___
### Customization
@@ -165,34 +156,27 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-dockerfile/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-dockerfile/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-dockerfile/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-dockerfile/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-dockerfile/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-dockerfile/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-dockerfile/_cm.json)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-dockerfile/_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/build-dockerfile/_cm.json)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-dockerfile/_cm.json)***
* build,docker,image
* `if (CM_BUILD_DOCKER_IMAGE in ['yes', '1'])`
* CM names: `--adr.['build-docker-image']...`
- CM script: [build-docker-image](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-docker-image)
-
___
### Script output
-`cmr "build dockerfile[,variations]" [--input_flags] -j`
+`cmr "build dockerfile [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_DOCKERFILE_*`
#### New environment keys auto-detected from customize
-* `CM_DOCKERFILE_WITH_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_DOCKERFILE_WITH_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/build-mlperf-inference-server-nvidia/README.md b/cm-mlops/script/build-mlperf-inference-server-nvidia/README.md
index 84edb08c6d..2b58170af5 100644
--- a/cm-mlops/script/build-mlperf-inference-server-nvidia/README.md
+++ b/cm-mlops/script/build-mlperf-inference-server-nvidia/README.md
@@ -1,65 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ 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)
-
-
+Automatically generated README for this automation recipe: **build-mlperf-inference-server-nvidia**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=build-mlperf-inference-server-nvidia,f37403af5e9f4541) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/build-mlperf-inference-server-nvidia)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-mlperf-inference-server-nvidia)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *build,mlcommons,mlperf,inference,inference-server,server,nvidia-harness,nvidia*
+* All CM tags to find and reuse this script (see in above meta description): *build,mlcommons,mlperf,inference,inference-server,server,nvidia-harness,nvidia*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "build mlcommons mlperf inference inference-server server nvidia-harness nvidia" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=build,mlcommons,mlperf,inference,inference-server,server,nvidia-harness,nvidia`
-1. `cm run script --tags=build,mlcommons,mlperf,inference,inference-server,server,nvidia-harness,nvidia[,variations] [--input_flags]`
+`cm run script --tags=build,mlcommons,mlperf,inference,inference-server,server,nvidia-harness,nvidia[,variations] [--input_flags]`
-2. `cmr "build mlcommons mlperf inference inference-server server nvidia-harness nvidia[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "build mlcommons mlperf inference inference-server server nvidia-harness nvidia"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "build mlcommons mlperf inference inference-server server nvidia-harness nvidia [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -95,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=build,mlcommons,mlperf
#### Run this script via Docker (beta)
-`cm docker script "build mlcommons mlperf inference inference-server server nvidia-harness nvidia[ variations]" [--input_flags]`
+`cm docker script "build mlcommons mlperf inference inference-server server nvidia-harness nvidia[variations]" [--input_flags]`
___
### Customization
@@ -179,12 +169,10 @@ Default version: `r3.1`
* `r3.0`
* `r3.1`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-mlperf-inference-server-nvidia/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-mlperf-inference-server-nvidia/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -235,28 +223,22 @@ ___
* get,mlperf,inference,nvidia,scratch,space
* CM names: `--adr.['nvidia-scratch-space']...`
- CM script: [get-mlperf-inference-nvidia-scratch-space](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-mlperf-inference-server-nvidia/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-mlperf-inference-server-nvidia/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-mlperf-inference-server-nvidia/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-mlperf-inference-server-nvidia/_cm.yaml)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-mlperf-inference-server-nvidia/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-mlperf-inference-server-nvidia/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-mlperf-inference-server-nvidia/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-mlperf-inference-server-nvidia/_cm.yaml)***
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-mlperf-inference-server-nvidia/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-mlperf-inference-server-nvidia/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-mlperf-inference-server-nvidia/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-mlperf-inference-server-nvidia/_cm.yaml)***
* add,custom,system,nvidia
* `if (CM_CUSTOM_SYSTEM_NVIDIA not in ['no', False, 'False'])`
* CM names: `--adr.['custom-system-nvidia', 'nvidia-inference-common-code']...`
- CM script: [add-custom-nvidia-system](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/add-custom-nvidia-system)
-
___
### Script output
-`cmr "build mlcommons mlperf inference inference-server server nvidia-harness nvidia[,variations]" [--input_flags] -j`
+`cmr "build mlcommons mlperf inference inference-server server nvidia-harness nvidia [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_MLPERF_INFERENCE_NVIDIA_CODE_PATH`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/calibrate-model-for.qaic/README.md b/cm-mlops/script/calibrate-model-for.qaic/README.md
index 5e2eaaeafb..0ab6ec1c12 100644
--- a/cm-mlops/script/calibrate-model-for.qaic/README.md
+++ b/cm-mlops/script/calibrate-model-for.qaic/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **calibrate-model-for.qaic**
-
+Category: **AI/ML optimization**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=calibrate-model-for.qaic,817bad70df2f4e45) ]*
+
+---
#### Summary
-* Category: *AI/ML optimization.*
-* 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/calibrate-model-for.qaic)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/calibrate-model-for.qaic)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *qaic,calibrate,profile,qaic-profile,qaic-calibrate*
+* All CM tags to find and reuse this script (see in above meta description): *qaic,calibrate,profile,qaic-profile,qaic-calibrate*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "qaic calibrate profile qaic-profile qaic-calibrate" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=qaic,calibrate,profile,qaic-profile,qaic-calibrate`
-1. `cm run script --tags=qaic,calibrate,profile,qaic-profile,qaic-calibrate[,variations] `
+`cm run script --tags=qaic,calibrate,profile,qaic-profile,qaic-calibrate[,variations] `
-2. `cmr "qaic calibrate profile qaic-profile qaic-calibrate[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "qaic calibrate profile qaic-profile qaic-calibrate"`
+
+`cmr "qaic calibrate profile qaic-profile qaic-calibrate [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=qaic,calibrate,profile
#### Run this script via Docker (beta)
-`cm docker script "qaic calibrate profile qaic-profile qaic-calibrate[ variations]" `
+`cm docker script "qaic calibrate profile qaic-profile qaic-calibrate[variations]" `
___
### Customization
@@ -231,12 +228,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/calibrate-model-for.qaic/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/calibrate-model-for.qaic/_cm.json)***
* detect,cpu
- CM script: [detect-cpu](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
* get,qaic,apps,sdk
@@ -274,25 +269,20 @@ ___
- CM script: [get-ml-model-stable-diffusion](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-stable-diffusion)
- CM script: [get-ml-model-tiny-resnet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-tiny-resnet)
- CM script: [get-ml-model-using-imagenet-from-model-zoo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/calibrate-model-for.qaic/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/calibrate-model-for.qaic/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/calibrate-model-for.qaic/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/calibrate-model-for.qaic/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/calibrate-model-for.qaic/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/calibrate-model-for.qaic/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/calibrate-model-for.qaic/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/calibrate-model-for.qaic/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/calibrate-model-for.qaic/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/calibrate-model-for.qaic/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/calibrate-model-for.qaic/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/calibrate-model-for.qaic/_cm.json)
___
### Script output
-`cmr "qaic calibrate profile qaic-profile qaic-calibrate[,variations]" -j`
+`cmr "qaic calibrate profile qaic-profile qaic-calibrate [,variations]" -j`
#### New environment keys (filter)
* `CM_QAIC_MODEL_PROFILE_*`
#### New environment keys auto-detected from customize
-* `CM_QAIC_MODEL_PROFILE_WITH_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_QAIC_MODEL_PROFILE_WITH_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/compile-model-for.qaic/README.md b/cm-mlops/script/compile-model-for.qaic/README.md
index 0210dc704a..92cf19fce7 100644
--- a/cm-mlops/script/compile-model-for.qaic/README.md
+++ b/cm-mlops/script/compile-model-for.qaic/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **compile-model-for.qaic**
-
+Category: **AI/ML optimization**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=compile-model-for.qaic,3f0f43b5d0304d1c) ]*
+
+---
#### Summary
-* Category: *AI/ML optimization.*
-* 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/compile-model-for.qaic)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/compile-model-for.qaic)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *qaic,compile,model,model-compile,qaic-compile*
+* All CM tags to find and reuse this script (see in above meta description): *qaic,compile,model,model-compile,qaic-compile*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "qaic compile model model-compile qaic-compile" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=qaic,compile,model,model-compile,qaic-compile`
-1. `cm run script --tags=qaic,compile,model,model-compile,qaic-compile[,variations] [--input_flags]`
+`cm run script --tags=qaic,compile,model,model-compile,qaic-compile[,variations] [--input_flags]`
-2. `cmr "qaic compile model model-compile qaic-compile[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "qaic compile model model-compile qaic-compile"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "qaic compile model model-compile qaic-compile [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=qaic,compile,model,mod
#### Run this script via Docker (beta)
-`cm docker script "qaic compile model model-compile qaic-compile[ variations]" [--input_flags]`
+`cm docker script "qaic compile model model-compile qaic-compile[variations]" [--input_flags]`
___
### Customization
@@ -381,12 +375,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/compile-model-for.qaic/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/compile-model-for.qaic/_cm.json)***
* detect,cpu
- CM script: [detect-cpu](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
* get,qaic,apps,sdk
@@ -421,18 +413,17 @@ ___
- CM script: [get-ml-model-stable-diffusion](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-stable-diffusion)
- CM script: [get-ml-model-tiny-resnet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-tiny-resnet)
- CM script: [get-ml-model-using-imagenet-from-model-zoo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/compile-model-for.qaic/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/compile-model-for.qaic/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/compile-model-for.qaic/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/compile-model-for.qaic/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/compile-model-for.qaic/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/compile-model-for.qaic/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/compile-model-for.qaic/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/compile-model-for.qaic/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/compile-model-for.qaic/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/compile-model-for.qaic/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/compile-model-for.qaic/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/compile-model-for.qaic/_cm.json)
___
### Script output
-`cmr "qaic compile model model-compile qaic-compile[,variations]" [--input_flags] -j`
+`cmr "qaic compile model model-compile qaic-compile [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_ML_MODEL_FILE_WITH_PATH`
@@ -441,8 +432,4 @@ ___
* `CM_ML_MODEL_FILE_WITH_PATH`
* `CM_QAIC_MODEL_COMPILED_BINARY_WITH_PATH`
-* `CM_QAIC_MODEL_FINAL_COMPILATION_CMD`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_QAIC_MODEL_FINAL_COMPILATION_CMD`
\ No newline at end of file
diff --git a/cm-mlops/script/compile-program/README.md b/cm-mlops/script/compile-program/README.md
index c8ef588db5..5d909e2eea 100644
--- a/cm-mlops/script/compile-program/README.md
+++ b/cm-mlops/script/compile-program/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
-
-
+Automatically generated README for this automation recipe: **compile-program**
-*Note that this README is automatically generated - don't edit!*
+Category: **DevOps automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=compile-program,c05042ba005a4bfa) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *DevOps automation.*
-* 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/compile-program)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/compile-program)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *compile,program,c-program,cpp-program,compile-program,compile-c-program,compile-cpp-program*
+* All CM tags to find and reuse this script (see in above meta description): *compile,program,c-program,cpp-program,compile-program,compile-c-program,compile-cpp-program*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "compile program c-program cpp-program compile-program compile-c-program compile-cpp-program" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=compile,program,c-program,cpp-program,compile-program,compile-c-program,compile-cpp-program`
-#### Run this script from command line
+`cm run script --tags=compile,program,c-program,cpp-program,compile-program,compile-c-program,compile-cpp-program `
-1. `cm run script --tags=compile,program,c-program,cpp-program,compile-program,compile-c-program,compile-cpp-program `
+*or*
+
+`cmr "compile program c-program cpp-program compile-program compile-c-program compile-cpp-program"`
+
+`cmr "compile program c-program cpp-program compile-program compile-c-program compile-cpp-program " `
-2. `cmr "compile program c-program cpp-program compile-program compile-c-program compile-cpp-program" `
#### Run this script from Python
@@ -105,12 +100,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/compile-program/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/compile-program/_cm.json)***
* detect,cpu
- CM script: [detect-cpu](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
* get,compiler
@@ -120,24 +113,18 @@ ___
- CM script: [get-llvm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-llvm)
* get,compiler-flags
- CM script: [get-compiler-flags](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-compiler-flags)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/compile-program/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/compile-program/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/compile-program/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/compile-program/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/compile-program/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/compile-program/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/compile-program/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/compile-program/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/compile-program/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/compile-program/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/compile-program/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/compile-program/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/compile-program/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/compile-program/_cm.json)
___
### Script output
-`cmr "compile program c-program cpp-program compile-program compile-c-program compile-cpp-program" -j`
+`cmr "compile program c-program cpp-program compile-program compile-c-program compile-cpp-program " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/convert-csv-to-md/README.md b/cm-mlops/script/convert-csv-to-md/README.md
index fb29728c04..34a4faf22e 100644
--- a/cm-mlops/script/convert-csv-to-md/README.md
+++ b/cm-mlops/script/convert-csv-to-md/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **convert-csv-to-md**
-
+Category: **DevOps automation**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=convert-csv-to-md,200a95b80bee4a25) ]*
+
+---
#### Summary
-* Category: *DevOps automation.*
-* 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/convert-csv-to-md)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/convert-csv-to-md)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *csv-to-md,convert,to-md,from-csv*
+* All CM tags to find and reuse this script (see in above meta description): *csv-to-md,convert,to-md,from-csv*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "csv-to-md convert to-md from-csv" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=csv-to-md,convert,to-md,from-csv`
-1. `cm run script --tags=csv-to-md,convert,to-md,from-csv [--input_flags]`
+`cm run script --tags=csv-to-md,convert,to-md,from-csv [--input_flags]`
-2. `cmr "csv-to-md convert to-md from-csv" [--input_flags]`
+*or*
+
+`cmr "csv-to-md convert to-md from-csv"`
+
+`cmr "csv-to-md convert to-md from-csv " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -120,12 +115,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/convert-csv-to-md/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/convert-csv-to-md/_cm.json)***
* get,python3
* CM names: `--adr.['python, python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
@@ -135,24 +128,18 @@ ___
* get,generic-python-lib,_package.tabulate
* CM names: `--adr.['tabulate']...`
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/convert-csv-to-md/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/convert-csv-to-md/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/convert-csv-to-md/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/convert-csv-to-md/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/convert-csv-to-md/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/convert-csv-to-md/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/convert-csv-to-md/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/convert-csv-to-md/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/convert-csv-to-md/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/convert-csv-to-md/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/convert-csv-to-md/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/convert-csv-to-md/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/convert-csv-to-md/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/convert-csv-to-md/_cm.json)
___
### Script output
-`cmr "csv-to-md convert to-md from-csv" [--input_flags] -j`
+`cmr "csv-to-md convert to-md from-csv " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/convert-ml-model-huggingface-to-onnx/README.md b/cm-mlops/script/convert-ml-model-huggingface-to-onnx/README.md
index 24c80f3981..ecc8afcd28 100644
--- a/cm-mlops/script/convert-ml-model-huggingface-to-onnx/README.md
+++ b/cm-mlops/script/convert-ml-model-huggingface-to-onnx/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **convert-ml-model-huggingface-to-onnx**
-
+Category: **AI/ML models**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=convert-ml-model-huggingface-to-onnx,eacb01655d7e49ac) ]*
+---
#### Summary
-* Category: *AI/ML models.*
-* 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/convert-ml-model-huggingface-to-onnx)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/convert-ml-model-huggingface-to-onnx)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *ml-model,model,huggingface-to-onnx,onnx,huggingface,convert*
+* All CM tags to find and reuse this script (see in above meta description): *ml-model,model,huggingface-to-onnx,onnx,huggingface,convert*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "ml-model model huggingface-to-onnx onnx huggingface convert" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=ml-model,model,huggingface-to-onnx,onnx,huggingface,convert`
-#### Run this script from command line
+`cm run script --tags=ml-model,model,huggingface-to-onnx,onnx,huggingface,convert[,variations] `
-1. `cm run script --tags=ml-model,model,huggingface-to-onnx,onnx,huggingface,convert[,variations] `
+*or*
-2. `cmr "ml-model model huggingface-to-onnx onnx huggingface convert[ variations]" `
+`cmr "ml-model model huggingface-to-onnx onnx huggingface convert"`
-* `variations` can be seen [here](#variations)
+`cmr "ml-model model huggingface-to-onnx onnx huggingface convert [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=ml-model,model,hugging
#### Run this script via Docker (beta)
-`cm docker script "ml-model model huggingface-to-onnx onnx huggingface convert[ variations]" `
+`cm docker script "ml-model model huggingface-to-onnx onnx huggingface convert[variations]" `
___
### Customization
@@ -118,12 +115,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/convert-ml-model-huggingface-to-onnx/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/convert-ml-model-huggingface-to-onnx/_cm.json)***
* get,python3
* CM names: `--adr.['python3', 'python']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
@@ -131,26 +126,20 @@ ___
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
* get,generic-python-lib,_onnxruntime
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/convert-ml-model-huggingface-to-onnx/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/convert-ml-model-huggingface-to-onnx/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/convert-ml-model-huggingface-to-onnx/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/convert-ml-model-huggingface-to-onnx/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/convert-ml-model-huggingface-to-onnx/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/convert-ml-model-huggingface-to-onnx/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/convert-ml-model-huggingface-to-onnx/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/convert-ml-model-huggingface-to-onnx/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/convert-ml-model-huggingface-to-onnx/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/convert-ml-model-huggingface-to-onnx/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/convert-ml-model-huggingface-to-onnx/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/convert-ml-model-huggingface-to-onnx/_cm.json)
___
### Script output
-`cmr "ml-model model huggingface-to-onnx onnx huggingface convert[,variations]" -j`
+`cmr "ml-model model huggingface-to-onnx onnx huggingface convert [,variations]" -j`
#### New environment keys (filter)
* `CM_ML_MODEL*`
* `CM_MODEL_HUGG_PATH`
* `HUGGINGFACE_ONNX_FILE_PATH`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/copy-to-clipboard/README.md b/cm-mlops/script/copy-to-clipboard/README.md
index cb721240fe..289e4d4e37 100644
--- a/cm-mlops/script/copy-to-clipboard/README.md
+++ b/cm-mlops/script/copy-to-clipboard/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **copy-to-clipboard**
-
+Category: **DevOps automation**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=copy-to-clipboard,8b3aaa97ce58474d) ]*
+
+---
#### Summary
-* Category: *DevOps automation.*
-* 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/copy-to-clipboard)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/copy-to-clipboard)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *copy,to,clipboard,copy-to-clipboard*
+* All CM tags to find and reuse this script (see in above meta description): *copy,to,clipboard,copy-to-clipboard*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "copy to clipboard copy-to-clipboard" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=copy,to,clipboard,copy-to-clipboard`
-1. `cm run script --tags=copy,to,clipboard,copy-to-clipboard [--input_flags]`
+`cm run script --tags=copy,to,clipboard,copy-to-clipboard [--input_flags]`
-2. `cmr "copy to clipboard copy-to-clipboard" [--input_flags]`
+*or*
+
+`cmr "copy to clipboard copy-to-clipboard"`
+
+`cmr "copy to clipboard copy-to-clipboard " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -122,35 +117,27 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/copy-to-clipboard/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/copy-to-clipboard/_cm.yaml)***
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
* get,generic-python-lib,_package.pyperclip
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/copy-to-clipboard/_cm.yaml)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/copy-to-clipboard/_cm.yaml)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/copy-to-clipboard/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/copy-to-clipboard/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/copy-to-clipboard/_cm.yaml)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/copy-to-clipboard/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/copy-to-clipboard/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/copy-to-clipboard/_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/copy-to-clipboard/_cm.yaml)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/copy-to-clipboard/_cm.yaml)
___
### Script output
-`cmr "copy to clipboard copy-to-clipboard" [--input_flags] -j`
+`cmr "copy to clipboard copy-to-clipboard " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/create-conda-env/README.md b/cm-mlops/script/create-conda-env/README.md
index 204182842c..2ff16cb9ca 100644
--- a/cm-mlops/script/create-conda-env/README.md
+++ b/cm-mlops/script/create-conda-env/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **create-conda-env**
-
+Category: **DevOps automation**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=create-conda-env,e39e0b04c86a40f2) ]*
+---
#### Summary
-* Category: *DevOps automation.*
-* 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/create-conda-env)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-conda-env)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *create,get,env,conda-env,conda-environment,create-conda-environment*
+* All CM tags to find and reuse this script (see in above meta description): *create,get,env,conda-env,conda-environment,create-conda-environment*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "create get env conda-env conda-environment create-conda-environment" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=create,get,env,conda-env,conda-environment,create-conda-environment`
-#### Run this script from command line
+`cm run script --tags=create,get,env,conda-env,conda-environment,create-conda-environment[,variations] `
-1. `cm run script --tags=create,get,env,conda-env,conda-environment,create-conda-environment[,variations] `
+*or*
-2. `cmr "create get env conda-env conda-environment create-conda-environment[ variations]" `
+`cmr "create get env conda-env conda-environment create-conda-environment"`
-* `variations` can be seen [here](#variations)
+`cmr "create get env conda-env conda-environment create-conda-environment [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=create,get,env,conda-e
#### Run this script via Docker (beta)
-`cm docker script "create get env conda-env conda-environment create-conda-environment[ variations]" `
+`cm docker script "create get env conda-env conda-environment create-conda-environment[variations]" `
___
### Customization
@@ -118,29 +115,26 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-conda-env/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-conda-env/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,conda
* CM names: `--adr.['conda']...`
- CM script: [get-conda](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-conda)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-conda-env/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-conda-env/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-conda-env/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-conda-env/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-conda-env/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-conda-env/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-conda-env/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-conda-env/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-conda-env/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-conda-env/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-conda-env/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-conda-env/_cm.json)
___
### Script output
-`cmr "create get env conda-env conda-environment create-conda-environment[,variations]" -j`
+`cmr "create get env conda-env conda-environment create-conda-environment [,variations]" -j`
#### New environment keys (filter)
* `+LD_LIBRARY_PATH`
@@ -153,8 +147,4 @@ ___
* `CM_CONDA_BIN_PATH`
* `CM_CONDA_LIB_PATH`
-* `CM_CONDA_PREFIX`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_CONDA_PREFIX`
\ No newline at end of file
diff --git a/cm-mlops/script/create-fpgaconvnet-app-tinyml/README.md b/cm-mlops/script/create-fpgaconvnet-app-tinyml/README.md
index fd829b033f..c7220c0aeb 100644
--- a/cm-mlops/script/create-fpgaconvnet-app-tinyml/README.md
+++ b/cm-mlops/script/create-fpgaconvnet-app-tinyml/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **create-fpgaconvnet-app-tinyml**
-
+Category: **TinyML automation**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=create-fpgaconvnet-app-tinyml,618f3520e98e4728) ]*
+---
#### Summary
-* Category: *TinyML automation.*
-* 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/create-fpgaconvnet-app-tinyml)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-fpgaconvnet-app-tinyml)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *create,app,fpgaconvnet*
+* All CM tags to find and reuse this script (see in above meta description): *create,app,fpgaconvnet*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "create app fpgaconvnet" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=create,app,fpgaconvnet`
-#### Run this script from command line
+`cm run script --tags=create,app,fpgaconvnet[,variations] `
-1. `cm run script --tags=create,app,fpgaconvnet[,variations] `
+*or*
-2. `cmr "create app fpgaconvnet[ variations]" `
+`cmr "create app fpgaconvnet"`
-* `variations` can be seen [here](#variations)
+`cmr "create app fpgaconvnet [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=create,app,fpgaconvnet
#### Run this script via Docker (beta)
-`cm docker script "create app fpgaconvnet[ variations]" `
+`cm docker script "create app fpgaconvnet[variations]" `
___
### Customization
@@ -132,12 +129,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-fpgaconvnet-app-tinyml/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-fpgaconvnet-app-tinyml/_cm.json)***
* create,fpgaconvnet,config
* CM names: `--adr.['config-generator']...`
- CM script: [create-fpgaconvnet-config-tinyml](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-fpgaconvnet-config-tinyml)
@@ -147,23 +142,17 @@ ___
* get,tensorflow
* CM names: `--adr.['tensorflow']...`
- CM script: [install-tensorflow-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tensorflow-from-src)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-fpgaconvnet-app-tinyml/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-fpgaconvnet-app-tinyml/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-fpgaconvnet-app-tinyml/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-fpgaconvnet-app-tinyml/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-fpgaconvnet-app-tinyml/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-fpgaconvnet-app-tinyml/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-fpgaconvnet-app-tinyml/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-fpgaconvnet-app-tinyml/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-fpgaconvnet-app-tinyml/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-fpgaconvnet-app-tinyml/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-fpgaconvnet-app-tinyml/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-fpgaconvnet-app-tinyml/_cm.json)
___
### Script output
-`cmr "create app fpgaconvnet[,variations]" -j`
+`cmr "create app fpgaconvnet [,variations]" -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/create-fpgaconvnet-config-tinyml/README.md b/cm-mlops/script/create-fpgaconvnet-config-tinyml/README.md
index 4b9f12c859..f60bc75d9d 100644
--- a/cm-mlops/script/create-fpgaconvnet-config-tinyml/README.md
+++ b/cm-mlops/script/create-fpgaconvnet-config-tinyml/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **create-fpgaconvnet-config-tinyml**
-
+Category: **TinyML automation**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=create-fpgaconvnet-config-tinyml,f6cdad166cfa47bc) ]*
+
+---
#### Summary
-* Category: *TinyML automation.*
-* 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/create-fpgaconvnet-config-tinyml)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-fpgaconvnet-config-tinyml)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *create,config,fpgaconvnet*
+* All CM tags to find and reuse this script (see in above meta description): *create,config,fpgaconvnet*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "create config fpgaconvnet" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=create,config,fpgaconvnet`
-1. `cm run script --tags=create,config,fpgaconvnet[,variations] `
+`cm run script --tags=create,config,fpgaconvnet[,variations] `
-2. `cmr "create config fpgaconvnet[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "create config fpgaconvnet"`
+
+`cmr "create config fpgaconvnet [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=create,config,fpgaconv
#### Run this script via Docker (beta)
-`cm docker script "create config fpgaconvnet[ variations]" `
+`cm docker script "create config fpgaconvnet[variations]" `
___
### Customization
@@ -144,12 +141,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-fpgaconvnet-config-tinyml/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-fpgaconvnet-config-tinyml/_cm.json)***
* get,python3
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
* get,ml-model,tiny
@@ -157,18 +152,17 @@ ___
- CM script: [get-ml-model-tiny-resnet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-tiny-resnet)
* get,git,repo,_repo.https://github.com/mlcommons/submissions_tiny_v1.1
- 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/create-fpgaconvnet-config-tinyml/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-fpgaconvnet-config-tinyml/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-fpgaconvnet-config-tinyml/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-fpgaconvnet-config-tinyml/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-fpgaconvnet-config-tinyml/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-fpgaconvnet-config-tinyml/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-fpgaconvnet-config-tinyml/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-fpgaconvnet-config-tinyml/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-fpgaconvnet-config-tinyml/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-fpgaconvnet-config-tinyml/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-fpgaconvnet-config-tinyml/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-fpgaconvnet-config-tinyml/_cm.json)
___
### Script output
-`cmr "create config fpgaconvnet[,variations]" -j`
+`cmr "create config fpgaconvnet [,variations]" -j`
#### New environment keys (filter)
* `CM_TINY_FPGACONVNET*`
@@ -178,8 +172,4 @@ ___
* `CM_TINY_FPGACONVNET_' + network_env_name + '_RUN_DIR`
* `CM_TINY_FPGACONVNET_CONFIG_FILE_' + network_env_name + '_PATH`
* `CM_TINY_FPGACONVNET_NETWORK_ENV_NAME`
-* `CM_TINY_FPGACONVNET_NETWORK_NAME`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_TINY_FPGACONVNET_NETWORK_NAME`
\ No newline at end of file
diff --git a/cm-mlops/script/create-patch/README.md b/cm-mlops/script/create-patch/README.md
index 8897009453..c967ad3fb0 100644
--- a/cm-mlops/script/create-patch/README.md
+++ b/cm-mlops/script/create-patch/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **create-patch**
-
+Category: **DevOps automation**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=create-patch,0659dc1f75664c65) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+
+---
#### Summary
-* Category: *DevOps automation.*
-* 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/create-patch)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-patch)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *create,patch*
+* All CM tags to find and reuse this script (see in above meta description): *create,patch*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "create patch" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=create,patch`
-1. `cm run script --tags=create,patch [--input_flags]`
+`cm run script --tags=create,patch [--input_flags]`
-2. `cmr "create patch" [--input_flags]`
+*or*
+
+`cmr "create patch"`
+
+`cmr "create patch " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -98,13 +93,14 @@ ___
Click here to expand this section.
+* `--exclude=value` → `CM_CREATE_PATCH_EXCLUDE=value`
* `--new=value` → `CM_CREATE_PATCH_NEW=value`
* `--old=value` → `CM_CREATE_PATCH_OLD=value`
**Above CLI flags can be used in the Python CM API as follows:**
```python
-r=cm.access({... , "new":...}
+r=cm.access({... , "exclude":...}
```
@@ -120,28 +116,22 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-patch/_cm.yaml)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-patch/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-patch/_cm.yaml)
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-patch/_cm.yaml)***
+ * detect,os
+ - CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-patch/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-patch/_cm.yaml)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-patch/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-patch/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-patch/_cm.yaml)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-patch/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-patch/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-patch/_cm.yaml)
___
### Script output
-`cmr "create patch" [--input_flags] -j`
+`cmr "create patch " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/destroy-terraform/README.md b/cm-mlops/script/destroy-terraform/README.md
index b49e4d1572..2be7cf8237 100644
--- a/cm-mlops/script/destroy-terraform/README.md
+++ b/cm-mlops/script/destroy-terraform/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
-
-
+Automatically generated README for this automation recipe: **destroy-terraform**
-*Note that this README is automatically generated - don't edit!*
+Category: **Cloud automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=destroy-terraform,3463458d03054856) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Cloud automation.*
-* 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/destroy-terraform)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/destroy-terraform)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *destroy,terraform,cmd*
+* All CM tags to find and reuse this script (see in above meta description): *destroy,terraform,cmd*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "destroy terraform cmd" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=destroy,terraform,cmd`
-#### Run this script from command line
+`cm run script --tags=destroy,terraform,cmd `
-1. `cm run script --tags=destroy,terraform,cmd `
+*or*
+
+`cmr "destroy terraform cmd"`
+
+`cmr "destroy terraform cmd " `
-2. `cmr "destroy terraform cmd" `
#### Run this script from Python
@@ -104,33 +99,25 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/destroy-terraform/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/destroy-terraform/_cm.json)***
* get,terraform
* CM names: `--adr.['terraform']...`
- CM script: [get-terraform](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-terraform)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/destroy-terraform/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/destroy-terraform/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/destroy-terraform/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/destroy-terraform/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/destroy-terraform/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/destroy-terraform/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/destroy-terraform/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/destroy-terraform/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/destroy-terraform/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/destroy-terraform/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/destroy-terraform/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/destroy-terraform/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/destroy-terraform/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/destroy-terraform/_cm.json)
___
### Script output
-`cmr "destroy terraform cmd" -j`
+`cmr "destroy terraform cmd " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/detect-cpu/README.md b/cm-mlops/script/detect-cpu/README.md
index 4ca8825a53..fcd2e31cc0 100644
--- a/cm-mlops/script/detect-cpu/README.md
+++ b/cm-mlops/script/detect-cpu/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
-
-
+Automatically generated README for this automation recipe: **detect-cpu**
-*Note that this README is automatically generated - don't edit!*
+Category: **Platform information**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=detect-cpu,586c8a43320142f7) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Platform information.*
-* 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/detect-cpu)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-cpu)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *detect,cpu,detect-cpu,info*
+* All CM tags to find and reuse this script (see in above meta description): *detect,cpu,detect-cpu,info*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "detect cpu detect-cpu info" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=detect,cpu,detect-cpu,info`
-1. `cm run script --tags=detect,cpu,detect-cpu,info `
+`cm run script --tags=detect,cpu,detect-cpu,info `
+
+*or*
+
+`cmr "detect cpu detect-cpu info"`
+
+`cmr "detect cpu detect-cpu info " `
-2. `cmr "detect cpu detect-cpu info" `
#### Run this script from Python
@@ -104,27 +99,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-cpu/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-cpu/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-cpu/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-cpu/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-cpu/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-cpu/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-cpu/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-cpu/_cm.json)
___
### Script output
-`cmr "detect cpu detect-cpu info" -j`
+`cmr "detect cpu detect-cpu info " -j`
#### New environment keys (filter)
* `CM_HOST_CPU_*`
@@ -135,8 +127,4 @@ ___
* `CM_HOST_CPU_PHYSICAL_CORES_PER_SOCKET`
* `CM_HOST_CPU_SOCKETS`
* `CM_HOST_CPU_THREADS_PER_CORE`
-* `CM_HOST_CPU_TOTAL_LOGICAL_CORES`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_HOST_CPU_TOTAL_LOGICAL_CORES`
\ No newline at end of file
diff --git a/cm-mlops/script/detect-os/README.md b/cm-mlops/script/detect-os/README.md
index 462b59e64c..5df1e04825 100644
--- a/cm-mlops/script/detect-os/README.md
+++ b/cm-mlops/script/detect-os/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **detect-os**
-
+Category: **Platform information**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=detect-os,863735b7db8c44fc) ]*
+---
#### Summary
-* Category: *Platform information.*
-* 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/detect-os)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-os)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *detect-os,detect,os,info*
+* All CM tags to find and reuse this script (see in above meta description): *detect-os,detect,os,info*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "detect-os detect os info" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=detect-os,detect,os,info`
-#### Run this script from command line
+`cm run script --tags=detect-os,detect,os,info `
-1. `cm run script --tags=detect-os,detect,os,info `
+*or*
+
+`cmr "detect-os detect os info"`
+
+`cmr "detect-os detect os info " `
-2. `cmr "detect-os detect os info" `
#### Run this script from Python
@@ -101,28 +99,25 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-os/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-os/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-os/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os/_cm.json)***
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-os/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-os/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-os/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-os/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-os/_cm.json)***
* get,sys-utils-min
* `if (CM_HOST_OS_TYPE == windows)`
- CM script: [get-sys-utils-min](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-min)
-
___
### Script output
-`cmr "detect-os detect os info" -j`
+`cmr "detect-os detect os info " -j`
#### New environment keys (filter)
* `+CM_HOST_OS_*`
@@ -141,8 +136,4 @@ ___
* `CM_HOST_OS_PACKAGE_MANAGER_UPDATE_CMD`
* `CM_HOST_OS_TYPE`
* `CM_HOST_PYTHON_BITS`
-* `CM_HOST_SYSTEM_NAME`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_HOST_SYSTEM_NAME`
\ No newline at end of file
diff --git a/cm-mlops/script/detect-sudo/README.md b/cm-mlops/script/detect-sudo/README.md
index cac189235d..b7590ec23b 100644
--- a/cm-mlops/script/detect-sudo/README.md
+++ b/cm-mlops/script/detect-sudo/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **detect-sudo**
-
+Category: **DevOps automation**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=detect-sudo,1d47ffc556e248dc) ]*
+
+---
#### Summary
-* Category: *DevOps automation.*
-* 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/detect-sudo)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-sudo)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *detect,sudo,access*
+* All CM tags to find and reuse this script (see in above meta description): *detect,sudo,access*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "detect sudo access" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=detect,sudo,access`
-1. `cm run script --tags=detect,sudo,access `
+`cm run script --tags=detect,sudo,access `
+
+*or*
+
+`cmr "detect sudo access"`
+
+`cmr "detect sudo access " `
-2. `cmr "detect sudo access" `
#### Run this script from Python
@@ -101,31 +99,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-sudo/_cm.yaml)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-sudo/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-sudo/_cm.yaml)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-sudo/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-sudo/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-sudo/_cm.yaml)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-sudo/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-sudo/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-sudo/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-sudo/_cm.yaml)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-sudo/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-sudo/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-sudo/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-sudo/_cm.yaml)
___
### Script output
-`cmr "detect sudo access" -j`
+`cmr "detect sudo access " -j`
#### New environment keys (filter)
* `CM_SUDO_*`
#### New environment keys auto-detected from customize
-* `CM_SUDO_USER`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_SUDO_USER`
\ No newline at end of file
diff --git a/cm-mlops/script/download-and-extract/README.md b/cm-mlops/script/download-and-extract/README.md
index 773daa3add..af0a40906b 100644
--- a/cm-mlops/script/download-and-extract/README.md
+++ b/cm-mlops/script/download-and-extract/README.md
@@ -1,64 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **download-and-extract**
-*Note that this README is automatically generated - don't edit!*
+Category: **DevOps automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=download-and-extract,c67e81a4ce2649f5) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *DevOps automation.*
-* 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/download-and-extract)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-and-extract)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *download-and-extract,file*
+* All CM tags to find and reuse this script (see in above meta description): *download-and-extract,file*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "download-and-extract file" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=download-and-extract,file`
-1. `cm run script --tags=download-and-extract,file[,variations] [--input_flags]`
+`cm run script --tags=download-and-extract,file[,variations] [--input_flags]`
-2. `cmr "download-and-extract file[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "download-and-extract file"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "download-and-extract file [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -94,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=download-and-extract,f
#### Run this script via Docker (beta)
-`cm docker script "download-and-extract file[ variations]" [--input_flags]`
+`cm docker script "download-and-extract file[variations]" [--input_flags]`
___
### Customization
@@ -191,31 +182,28 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-and-extract/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-and-extract/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-and-extract/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-and-extract/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-and-extract/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-and-extract/_cm.json)***
* download,file
* `if (CM_DAE_DOWNLOAD_USING_TORRENT not in ['yes', 'True'])`
* CM names: `--adr.['download-script']...`
- CM script: [download-file](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-file)
1. ***Run native script if exists***
- 1. ***Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-and-extract/_cm.json)***
+ 1. ***Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-and-extract/_cm.json)***
* extract,file
* `if (CM_DAE_EXTRACT_DOWNLOADED in ['yes', 'True'])`
* CM names: `--adr.['extract-script']...`
- CM script: [extract-file](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/extract-file)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-and-extract/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-and-extract/_cm.json)
-
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-and-extract/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-and-extract/_cm.json)
___
### Script output
-`cmr "download-and-extract file[,variations]" [--input_flags] -j`
+`cmr "download-and-extract file [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `<<>>`
@@ -225,8 +213,4 @@ ___
* `CM_GET_DEPENDENT_CACHED_PATH`
#### New environment keys auto-detected from customize
-* `CM_GET_DEPENDENT_CACHED_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_GET_DEPENDENT_CACHED_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/download-file/README.md b/cm-mlops/script/download-file/README.md
index bbfb862976..ba19cd3b6c 100644
--- a/cm-mlops/script/download-file/README.md
+++ b/cm-mlops/script/download-file/README.md
@@ -1,64 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **download-file**
-*Note that this README is automatically generated - don't edit!*
+Category: **DevOps automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=download-file,9cdc8dc41aae437e) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *DevOps automation.*
-* 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/download-file)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-file)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *download,file*
+* All CM tags to find and reuse this script (see in above meta description): *download,file*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "download file" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=download,file`
-1. `cm run script --tags=download,file[,variations] [--input_flags]`
+`cm run script --tags=download,file[,variations] [--input_flags]`
-2. `cmr "download file[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "download file"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "download file [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -94,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=download,file) to gene
#### Run this script via Docker (beta)
-`cm docker script "download file[ variations]" [--input_flags]`
+`cm docker script "download file[variations]" [--input_flags]`
___
### Customization
@@ -184,27 +175,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-file/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-file/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-file/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-file/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-file/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-file/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-file/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-file/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-file/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-file/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-file/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-file/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-file/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-file/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-file/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-file/_cm.json)
___
### Script output
-`cmr "download file[,variations]" [--input_flags] -j`
+`cmr "download file [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `<<>>`
@@ -213,8 +201,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_DOWNLOAD_DOWNLOADED_PATH`
-* `CM_GET_DEPENDENT_CACHED_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_GET_DEPENDENT_CACHED_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/download-torrent/README.md b/cm-mlops/script/download-torrent/README.md
index 90731db9f2..9128bf3cf6 100644
--- a/cm-mlops/script/download-torrent/README.md
+++ b/cm-mlops/script/download-torrent/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **download-torrent**
-
+Category: **DevOps automation**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=download-torrent,69b752c5618e45bb) ]*
+
+---
#### Summary
-* Category: *DevOps automation.*
-* 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/download-torrent)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-torrent)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *download,torrent,download-torrent*
+* All CM tags to find and reuse this script (see in above meta description): *download,torrent,download-torrent*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "download torrent download-torrent" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=download,torrent,download-torrent`
-1. `cm run script --tags=download,torrent,download-torrent[,variations] [--input_flags]`
+`cm run script --tags=download,torrent,download-torrent[,variations] [--input_flags]`
-2. `cmr "download torrent download-torrent[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "download torrent download-torrent"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "download torrent download-torrent [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=download,torrent,downl
#### Run this script via Docker (beta)
-`cm docker script "download torrent download-torrent[ variations]" [--input_flags]`
+`cm docker script "download torrent download-torrent[variations]" [--input_flags]`
___
### Customization
@@ -137,34 +131,27 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-torrent/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-torrent/_cm.json)***
* get,generic-sys-util,_transmission
- CM script: [get-generic-sys-util](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-sys-util)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-torrent/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-torrent/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-torrent/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-torrent/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-torrent/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-torrent/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-torrent/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-torrent/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-torrent/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-torrent/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-torrent/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-torrent/_cm.json)
___
### Script output
-`cmr "download torrent download-torrent[,variations]" [--input_flags] -j`
+`cmr "download torrent download-torrent [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `<<>>`
* `CM_TORRENT_DOWNLOADED_PATH`
#### New environment keys auto-detected from customize
-* `CM_TORRENT_DOWNLOADED_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_TORRENT_DOWNLOADED_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/dump-pip-freeze/README.md b/cm-mlops/script/dump-pip-freeze/README.md
index 3f09d1b055..b0e1a0a372 100644
--- a/cm-mlops/script/dump-pip-freeze/README.md
+++ b/cm-mlops/script/dump-pip-freeze/README.md
@@ -1,54 +1,51 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **dump-pip-freeze**
-
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=dump-pip-freeze,33eb0a8006664cae) ]*
+---
#### Summary
-* 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/dump-pip-freeze)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/dump-pip-freeze)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *dump,pip,freeze*
+* All CM tags to find and reuse this script (see in above meta description): *dump,pip,freeze*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "dump pip freeze" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=dump,pip,freeze`
-#### Run this script from command line
+`cm run script --tags=dump,pip,freeze `
-1. `cm run script --tags=dump,pip,freeze `
+*or*
+
+`cmr "dump pip freeze"`
+
+`cmr "dump pip freeze " `
-2. `cmr "dump pip freeze" `
#### Run this script from Python
@@ -100,33 +97,25 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/dump-pip-freeze/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/dump-pip-freeze/_cm.yaml)***
* get,python
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/dump-pip-freeze/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/dump-pip-freeze/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/dump-pip-freeze/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/dump-pip-freeze/_cm.yaml)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/dump-pip-freeze/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/dump-pip-freeze/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/dump-pip-freeze/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/dump-pip-freeze/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/dump-pip-freeze/_cm.yaml)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/dump-pip-freeze/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/dump-pip-freeze/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/dump-pip-freeze/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/dump-pip-freeze/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/dump-pip-freeze/_cm.yaml)
___
### Script output
-`cmr "dump pip freeze" -j`
+`cmr "dump pip freeze " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/extract-file/README.md b/cm-mlops/script/extract-file/README.md
index 46ad21fb50..9b7fcc0704 100644
--- a/cm-mlops/script/extract-file/README.md
+++ b/cm-mlops/script/extract-file/README.md
@@ -1,64 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **extract-file**
-*Note that this README is automatically generated - don't edit!*
+Category: **DevOps automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=extract-file,3f0b76219d004817) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *DevOps automation.*
-* 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/extract-file)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/extract-file)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *extract,file*
+* All CM tags to find and reuse this script (see in above meta description): *extract,file*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "extract file" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=extract,file`
-1. `cm run script --tags=extract,file[,variations] [--input_flags]`
+`cm run script --tags=extract,file[,variations] [--input_flags]`
-2. `cmr "extract file[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "extract file"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "extract file [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -94,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=extract,file) to gener
#### Run this script via Docker (beta)
-`cm docker script "extract file[ variations]" [--input_flags]`
+`cm docker script "extract file[variations]" [--input_flags]`
___
### Customization
@@ -150,27 +141,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/extract-file/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/extract-file/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/extract-file/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/extract-file/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/extract-file/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/extract-file/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/extract-file/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/extract-file/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/extract-file/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/extract-file/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/extract-file/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/extract-file/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/extract-file/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/extract-file/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/extract-file/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/extract-file/_cm.json)
___
### Script output
-`cmr "extract file[,variations]" [--input_flags] -j`
+`cmr "extract file [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `<<>>`
@@ -179,8 +167,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_EXTRACT_EXTRACTED_PATH`
-* `CM_GET_DEPENDENT_CACHED_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_GET_DEPENDENT_CACHED_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/fail/README.md b/cm-mlops/script/fail/README.md
index ba7c98dd26..6a84f0efa8 100644
--- a/cm-mlops/script/fail/README.md
+++ b/cm-mlops/script/fail/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **fail**
-*Note that this README is automatically generated - don't edit!*
+Category: **DevOps automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=fail,3aaee82e19d243cd) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *DevOps automation.*
-* 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/fail)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/fail)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *fail,filter*
+* All CM tags to find and reuse this script (see in above meta description): *fail,filter*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "fail filter" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=fail,filter`
-#### Run this script from command line
+`cm run script --tags=fail,filter[,variations] `
-1. `cm run script --tags=fail,filter[,variations] `
+*or*
-2. `cmr "fail filter[ variations]" `
+`cmr "fail filter"`
-* `variations` can be seen [here](#variations)
+`cmr "fail filter [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=fail,filter) to genera
#### Run this script via Docker (beta)
-`cm docker script "fail filter[ variations]" `
+`cm docker script "fail filter[variations]" `
___
### Customization
@@ -121,28 +115,20 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/fail/_cm.yaml)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/fail/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/fail/_cm.yaml)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/fail/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/fail/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/fail/_cm.yaml)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/fail/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/fail/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/fail/_cm.yaml)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/fail/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/fail/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/fail/_cm.yaml)
___
### Script output
-`cmr "fail filter[,variations]" -j`
+`cmr "fail filter [,variations]" -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/flash-tinyml-binary/README.md b/cm-mlops/script/flash-tinyml-binary/README.md
index fd7fb53f36..0dc325131b 100644
--- a/cm-mlops/script/flash-tinyml-binary/README.md
+++ b/cm-mlops/script/flash-tinyml-binary/README.md
@@ -1,65 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ 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)
-
-
+Automatically generated README for this automation recipe: **flash-tinyml-binary**
-*Note that this README is automatically generated - don't edit!*
+Category: **TinyML automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=flash-tinyml-binary,98913babb43f4fcb) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *TinyML automation.*
-* 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/flash-tinyml-binary)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/flash-tinyml-binary)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *flash,tiny,mlperf,mlcommons*
+* All CM tags to find and reuse this script (see in above meta description): *flash,tiny,mlperf,mlcommons*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "flash tiny mlperf mlcommons" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=flash,tiny,mlperf,mlcommons`
-1. `cm run script --tags=flash,tiny,mlperf,mlcommons[,variations] [--input_flags]`
+`cm run script --tags=flash,tiny,mlperf,mlcommons[,variations] [--input_flags]`
-2. `cmr "flash tiny mlperf mlcommons[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "flash tiny mlperf mlcommons"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "flash tiny mlperf mlcommons [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -95,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=flash,tiny,mlperf,mlco
#### Run this script via Docker (beta)
-`cm docker script "flash tiny mlperf mlcommons[ variations]" [--input_flags]`
+`cm docker script "flash tiny mlperf mlcommons[variations]" [--input_flags]`
___
### Customization
@@ -155,12 +145,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
Default version: `r1.0`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/flash-tinyml-binary/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/flash-tinyml-binary/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,zephyr
@@ -172,23 +160,17 @@ ___
* reproduce,tiny,mlperf
* `if (CM_TINY_BUILD_DIR != on)`
- CM script: [reproduce-mlperf-octoml-tinyml-results](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/flash-tinyml-binary/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/flash-tinyml-binary/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/flash-tinyml-binary/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/flash-tinyml-binary/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/flash-tinyml-binary/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/flash-tinyml-binary/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/flash-tinyml-binary/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/flash-tinyml-binary/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/flash-tinyml-binary/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/flash-tinyml-binary/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/flash-tinyml-binary/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/flash-tinyml-binary/_cm.json)
___
### Script output
-`cmr "flash tiny mlperf mlcommons[,variations]" [--input_flags] -j`
+`cmr "flash tiny mlperf mlcommons [,variations]" [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/generate-mlperf-inference-submission/README.md b/cm-mlops/script/generate-mlperf-inference-submission/README.md
index 3af3fe27cd..c29c2ad73c 100644
--- a/cm-mlops/script/generate-mlperf-inference-submission/README.md
+++ b/cm-mlops/script/generate-mlperf-inference-submission/README.md
@@ -1,61 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **generate-mlperf-inference-submission**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=generate-mlperf-inference-submission,5f8ab2d0b5874d53) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/generate-mlperf-inference-submission)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-inference-submission)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *generate,submission,mlperf,mlperf-inference,inference,mlcommons,inference-submission,mlperf-inference-submission,mlcommons-inference-submission*
+* All CM tags to find and reuse this script (see in above meta description): *generate,submission,mlperf,mlperf-inference,inference,mlcommons,inference-submission,mlperf-inference-submission,mlcommons-inference-submission*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "generate submission mlperf mlperf-inference inference mlcommons inference-submission mlperf-inference-submission mlcommons-inference-submission" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=generate,submission,mlperf,mlperf-inference,inference,mlcommons,inference-submission,mlperf-inference-submission,mlcommons-inference-submission`
-1. `cm run script --tags=generate,submission,mlperf,mlperf-inference,inference,mlcommons,inference-submission,mlperf-inference-submission,mlcommons-inference-submission [--input_flags]`
+`cm run script --tags=generate,submission,mlperf,mlperf-inference,inference,mlcommons,inference-submission,mlperf-inference-submission,mlcommons-inference-submission [--input_flags]`
-2. `cmr "generate submission mlperf mlperf-inference inference mlcommons inference-submission mlperf-inference-submission mlcommons-inference-submission" [--input_flags]`
+*or*
+
+`cmr "generate submission mlperf mlperf-inference inference mlcommons inference-submission mlperf-inference-submission mlcommons-inference-submission"`
+
+`cmr "generate submission mlperf mlperf-inference inference mlcommons inference-submission mlperf-inference-submission mlcommons-inference-submission " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -145,12 +137,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-inference-submission/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-inference-submission/_cm.json)***
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
@@ -171,12 +161,12 @@ ___
* `if (CM_MLPERF_INFERENCE_SUBMISSION_DIR != on)`
* CM names: `--adr.['get-mlperf-submission-dir']...`
- CM script: [get-mlperf-inference-submission-dir](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-submission-dir)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-inference-submission/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-inference-submission/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-inference-submission/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-inference-submission/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-inference-submission/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-inference-submission/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-inference-submission/_cm.json)***
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-inference-submission/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-inference-submission/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-inference-submission/_cm.json)***
* accuracy,truncate,mlc
* `if (CM_RUN_MLPERF_ACCURACY == on) AND (CM_SKIP_TRUNCATE_ACCURACY != yes)`
- CM script: [truncate-mlperf-inference-accuracy-log](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/truncate-mlperf-inference-accuracy-log)
@@ -187,16 +177,10 @@ ___
* `if (CM_RUN_SUBMISSION_CHECKER == yes)`
* CM names: `--adr.['mlperf-inference-submission-checker', 'submission-checker']...`
- CM script: [run-mlperf-inference-submission-checker](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-submission-checker)
-
___
### Script output
-`cmr "generate submission mlperf mlperf-inference inference mlcommons inference-submission mlperf-inference-submission mlcommons-inference-submission" [--input_flags] -j`
+`cmr "generate submission mlperf mlperf-inference inference mlcommons inference-submission mlperf-inference-submission mlcommons-inference-submission " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/generate-mlperf-inference-user-conf/README.md b/cm-mlops/script/generate-mlperf-inference-user-conf/README.md
index 2573798ad0..c06cd2f223 100644
--- a/cm-mlops/script/generate-mlperf-inference-user-conf/README.md
+++ b/cm-mlops/script/generate-mlperf-inference-user-conf/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **generate-mlperf-inference-user-conf**
-
+Category: **MLPerf benchmark support**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Developers: [Arjun Suresh](https://www.linkedin.com/in/arjunsuresh), [Thomas Zhu](https://www.linkedin.com/in/hanwen-zhu-483614189), [Grigori Fursin](https://cKnowledge.org/gfursin)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=generate-mlperf-inference-user-conf,3af4475745964b93) ]*
+
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/generate-mlperf-inference-user-conf)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-inference-user-conf)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *generate,mlperf,inference,user-conf,inference-user-conf*
+* All CM tags to find and reuse this script (see in above meta description): *generate,mlperf,inference,user-conf,inference-user-conf*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "generate mlperf inference user-conf inference-user-conf" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=generate,mlperf,inference,user-conf,inference-user-conf`
-1. `cm run script --tags=generate,mlperf,inference,user-conf,inference-user-conf [--input_flags]`
+`cm run script --tags=generate,mlperf,inference,user-conf,inference-user-conf [--input_flags]`
-2. `cmr "generate mlperf inference user-conf inference-user-conf" [--input_flags]`
+*or*
+
+`cmr "generate mlperf inference user-conf inference-user-conf"`
+
+`cmr "generate mlperf inference user-conf inference-user-conf " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -142,12 +137,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-inference-user-conf/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-inference-user-conf/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -164,17 +157,16 @@ ___
- CM script: [get-mlperf-inference-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-src)
* get,sut,configs
- CM script: [get-mlperf-inference-sut-configs](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-sut-configs)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-inference-user-conf/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-inference-user-conf/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-inference-user-conf/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-inference-user-conf/_cm.yaml)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-inference-user-conf/_cm.yaml)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-inference-user-conf/_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/generate-mlperf-inference-user-conf/_cm.yaml)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-inference-user-conf/_cm.yaml)
___
### Script output
-`cmr "generate mlperf inference user-conf inference-user-conf" [--input_flags] -j`
+`cmr "generate mlperf inference user-conf inference-user-conf " [--input_flags] -j`
#### New environment keys (filter)
* `CM_HW_*`
@@ -205,8 +197,4 @@ ___
* `CM_MLPERF_SKIP_RUN`
* `CM_MLPERF_TESTING_USER_CONF`
* `CM_MLPERF_USER_CONF`
-* `CM_MLPERF_USE_MAX_DURATION`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_MLPERF_USE_MAX_DURATION`
\ No newline at end of file
diff --git a/cm-mlops/script/generate-mlperf-tiny-report/README.md b/cm-mlops/script/generate-mlperf-tiny-report/README.md
index 41299f6b36..20d12a419d 100644
--- a/cm-mlops/script/generate-mlperf-tiny-report/README.md
+++ b/cm-mlops/script/generate-mlperf-tiny-report/README.md
@@ -1,61 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **generate-mlperf-tiny-report**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Developers: [Grigori Fursin](https://cKnowledge.org/gfursin)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=generate-mlperf-tiny-report,709c3f3f9b3e4783) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/generate-mlperf-tiny-report)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-tiny-report)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *generate,mlperf,tiny,mlperf-tiny,report*
+* All CM tags to find and reuse this script (see in above meta description): *generate,mlperf,tiny,mlperf-tiny,report*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "generate mlperf tiny mlperf-tiny report" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=generate,mlperf,tiny,mlperf-tiny,report`
-1. `cm run script --tags=generate,mlperf,tiny,mlperf-tiny,report [--input_flags]`
+`cm run script --tags=generate,mlperf,tiny,mlperf-tiny,report [--input_flags]`
-2. `cmr "generate mlperf tiny mlperf-tiny report" [--input_flags]`
+*or*
+
+`cmr "generate mlperf tiny mlperf-tiny report"`
+
+`cmr "generate mlperf tiny mlperf-tiny report " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -123,12 +115,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-tiny-report/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-tiny-report/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,sys-utils-cm
@@ -140,24 +130,18 @@ ___
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
* get,generic-python-lib,_pandas
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-tiny-report/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-tiny-report/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-tiny-report/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-tiny-report/_cm.yaml)
1. ***Run native script if exists***
- * [run_submission_checker.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-tiny-report/run_submission_checker.bat)
- * [run_submission_checker.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-tiny-report/run_submission_checker.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-tiny-report/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-tiny-report/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-tiny-report/_cm.yaml)
-
+ * [run_submission_checker.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-tiny-report/run_submission_checker.bat)
+ * [run_submission_checker.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-tiny-report/run_submission_checker.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-tiny-report/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-tiny-report/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-tiny-report/_cm.yaml)
___
### Script output
-`cmr "generate mlperf tiny mlperf-tiny report" [--input_flags] -j`
+`cmr "generate mlperf tiny mlperf-tiny report " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/generate-mlperf-tiny-submission/README.md b/cm-mlops/script/generate-mlperf-tiny-submission/README.md
index 0a23a3dd7a..eb811bf017 100644
--- a/cm-mlops/script/generate-mlperf-tiny-submission/README.md
+++ b/cm-mlops/script/generate-mlperf-tiny-submission/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
-
-
+Automatically generated README for this automation recipe: **generate-mlperf-tiny-submission**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=generate-mlperf-tiny-submission,04289b9fc07b42b6) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/generate-mlperf-tiny-submission)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-tiny-submission)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *generate,submission,mlperf,mlperf-tiny,tiny,mlcommons,tiny-submission,mlperf-tiny-submission,mlcommons-tiny-submission*
+* All CM tags to find and reuse this script (see in above meta description): *generate,submission,mlperf,mlperf-tiny,tiny,mlcommons,tiny-submission,mlperf-tiny-submission,mlcommons-tiny-submission*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "generate submission mlperf mlperf-tiny tiny mlcommons tiny-submission mlperf-tiny-submission mlcommons-tiny-submission" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=generate,submission,mlperf,mlperf-tiny,tiny,mlcommons,tiny-submission,mlperf-tiny-submission,mlcommons-tiny-submission`
-#### Run this script from command line
+`cm run script --tags=generate,submission,mlperf,mlperf-tiny,tiny,mlcommons,tiny-submission,mlperf-tiny-submission,mlcommons-tiny-submission `
-1. `cm run script --tags=generate,submission,mlperf,mlperf-tiny,tiny,mlcommons,tiny-submission,mlperf-tiny-submission,mlcommons-tiny-submission `
+*or*
+
+`cmr "generate submission mlperf mlperf-tiny tiny mlcommons tiny-submission mlperf-tiny-submission mlcommons-tiny-submission"`
+
+`cmr "generate submission mlperf mlperf-tiny tiny mlcommons tiny-submission mlperf-tiny-submission mlcommons-tiny-submission " `
-2. `cmr "generate submission mlperf mlperf-tiny tiny mlcommons tiny-submission mlperf-tiny-submission mlcommons-tiny-submission" `
#### Run this script from Python
@@ -104,25 +99,53 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-tiny-submission/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-tiny-submission/_cm.json)***
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
* get,sut,system-description
- CM script: [get-mlperf-inference-sut-description](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-sut-description)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-tiny-submission/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-tiny-submission/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-tiny-submission/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-tiny-submission/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-tiny-submission/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-tiny-submission/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-tiny-submission/_cm.json)***
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-tiny-submission/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-tiny-submission/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-tiny-submission/_cm.json)***
*
* `if (CM_MLPERF_RUN_STYLE == valid)`
+ - CM script: [test-script1](https://github.com/gfursin/cm-tests/tree/master/script/test-script1)
+ - CM script: [test-script2](https://github.com/gfursin/cm-tests/tree/master/script/test-script2)
+ - CM script: [test-script3](https://github.com/gfursin/cm-tests/tree/master/script/test-script3)
+ - CM script: [test-script4](https://github.com/gfursin/cm-tests/tree/master/script/test-script4)
+ - CM script: [test-script5](https://github.com/gfursin/cm-tests/tree/master/script/test-script5)
+ - CM script: [app-generate-image-dalle-mini-jax-py](https://github.com/cknowledge/tests/tree/master/cm/script/app-generate-image-dalle-mini-jax-py)
+ - CM script: [app-generate-image-stable-diffusion2-pytorch-cuda-py](https://github.com/cknowledge/tests/tree/master/cm/script/app-generate-image-stable-diffusion2-pytorch-cuda-py)
+ - CM script: [app-image-classification-onnx-py-ck](https://github.com/cknowledge/tests/tree/master/cm/script/app-image-classification-onnx-py-ck)
+ - CM script: [app-image-corner-detection-old](https://github.com/cknowledge/tests/tree/master/cm/script/app-image-corner-detection-old)
+ - CM script: [app-ipol-demo](https://github.com/cknowledge/tests/tree/master/cm/script/app-ipol-demo)
+ - CM script: [app-stable-diffusion-pytorch-cuda-py](https://github.com/cknowledge/tests/tree/master/cm/script/app-stable-diffusion-pytorch-cuda-py)
+ - CM script: [not-needed--get-android-cmdline-tools](https://github.com/cknowledge/tests/tree/master/cm/script/not-needed--get-android-cmdline-tools)
+ - CM script: [not-needed--install-android-cmdline-tools](https://github.com/cknowledge/tests/tree/master/cm/script/not-needed--install-android-cmdline-tools)
+ - CM script: [gui-llm](https://github.com/cknowledge/cm-private/tree/master/script/gui-llm)
+ - CM script: [run-refiners-hello-world](https://github.com/cknowledge/cm-reproduce/tree/master/script/run-refiners-hello-world)
+ - CM script: [reproduce-ieee-acm-micro2023-paper-22](https://github.com/ctuning/cm-reproduce-research-projects/tree/master/script/reproduce-ieee-acm-micro2023-paper-22)
+ - CM script: [reproduce-ieee-acm-micro2023-paper-28](https://github.com/ctuning/cm-reproduce-research-projects/tree/master/script/reproduce-ieee-acm-micro2023-paper-28)
+ - CM script: [reproduce-ieee-acm-micro2023-paper-33](https://github.com/ctuning/cm-reproduce-research-projects/tree/master/script/reproduce-ieee-acm-micro2023-paper-33)
+ - CM script: [reproduce-ieee-acm-micro2023-paper-38](https://github.com/ctuning/cm-reproduce-research-projects/tree/master/script/reproduce-ieee-acm-micro2023-paper-38)
+ - CM script: [reproduce-ieee-acm-micro2023-paper-5](https://github.com/ctuning/cm-reproduce-research-projects/tree/master/script/reproduce-ieee-acm-micro2023-paper-5)
+ - CM script: [reproduce-ieee-acm-micro2023-paper-8](https://github.com/ctuning/cm-reproduce-research-projects/tree/master/script/reproduce-ieee-acm-micro2023-paper-8)
+ - CM script: [reproduce-ieee-acm-micro2023-paper-85](https://github.com/ctuning/cm-reproduce-research-projects/tree/master/script/reproduce-ieee-acm-micro2023-paper-85)
+ - CM script: [reproduce-ieee-acm-micro2023-paper-87](https://github.com/ctuning/cm-reproduce-research-projects/tree/master/script/reproduce-ieee-acm-micro2023-paper-87)
+ - CM script: [reproduce-ieee-acm-micro2023-paper-96](https://github.com/ctuning/cm-reproduce-research-projects/tree/master/script/reproduce-ieee-acm-micro2023-paper-96)
+ - CM script: [reproduce-ipol-paper-2022-439a](https://github.com/ctuning/cm-reproduce-research-projects/tree/master/script/reproduce-ipol-paper-2022-439a)
+ - CM script: [reproduce-neurips-paper-2022-arxiv-2204.09656](https://github.com/ctuning/cm-reproduce-research-projects/tree/master/script/reproduce-neurips-paper-2022-arxiv-2204.09656)
+ - CM script: [run-how-to-run-server](https://github.com/how-to-run/server/tree/master/script/run-how-to-run-server)
+ - CM script: [app-mlperf-inference-nvidia](https://github.com/cknowledge/cm-tests/tree/master/script/app-mlperf-inference-nvidia)
+ - CM script: [get-axs](https://github.com/cknowledge/cm-tests/tree/master/script/get-axs)
+ - CM script: [process-mlperf-inference-results](https://github.com/mlcommons/ck_mlperf_results/tree/master/script/process-mlperf-inference-results)
- CM script: [activate-python-venv](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/activate-python-venv)
- CM script: [add-custom-nvidia-system](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/add-custom-nvidia-system)
- CM script: [app-image-classification-onnx-py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-onnx-py)
@@ -132,15 +155,17 @@ ___
- CM script: [app-image-corner-detection](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-corner-detection)
- CM script: [app-loadgen-generic-python](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-loadgen-generic-python)
- CM script: [app-mlperf-inference](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference)
- - CM script: [app-mlperf-inference-cpp](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-cpp)
+ - CM script: [app-mlperf-inference-ctuning-cpp-tflite](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-ctuning-cpp-tflite)
+ - CM script: [app-mlperf-inference-dummy](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-dummy)
+ - CM script: [app-mlperf-inference-intel](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-intel)
+ - CM script: [app-mlperf-inference-mlcommons-cpp](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-mlcommons-cpp)
+ - CM script: [app-mlperf-inference-mlcommons-python](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-mlcommons-python)
- CM script: [app-mlperf-inference-nvidia](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-nvidia)
- - CM script: [app-mlperf-inference-reference](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-reference)
- - CM script: [app-mlperf-inference-tflite-cpp](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-tflite-cpp)
+ - CM script: [app-mlperf-inference-qualcomm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-qualcomm)
- CM script: [app-mlperf-training-nvidia](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-nvidia)
- CM script: [app-mlperf-training-reference](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-reference)
- CM script: [app-stable-diffusion-onnx-py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-stable-diffusion-onnx-py)
- CM script: [benchmark-any-mlperf-inference-implementation](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-any-mlperf-inference-implementation)
- - CM script: [benchmark-object-detection-loadgen](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-object-detection-loadgen)
- CM script: [benchmark-program](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program)
- CM script: [benchmark-program-mlperf](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program-mlperf)
- CM script: [build-docker-image](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-docker-image)
@@ -187,6 +212,7 @@ ___
- CM script: [get-compiler-flags](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-compiler-flags)
- CM script: [get-compiler-rust](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-compiler-rust)
- CM script: [get-conda](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-conda)
+ - CM script: [get-croissant](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-croissant)
- CM script: [get-cuda](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda)
- CM script: [get-cuda-devices](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda-devices)
- CM script: [get-cudnn](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cudnn)
@@ -218,6 +244,7 @@ ___
- CM script: [get-git-repo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo)
- CM script: [get-github-cli](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-github-cli)
- CM script: [get-go](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-go)
+ - CM script: [get-google-saxml](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-google-saxml)
- CM script: [get-google-test](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-google-test)
- CM script: [get-ipol-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ipol-src)
- CM script: [get-java](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-java)
@@ -246,7 +273,6 @@ ___
- CM script: [get-ml-model-stable-diffusion](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-stable-diffusion)
- CM script: [get-ml-model-tiny-resnet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-tiny-resnet)
- CM script: [get-ml-model-using-imagenet-from-model-zoo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo)
- - CM script: [get-mlcommons-croissant](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlcommons-croissant)
- CM script: [get-mlperf-inference-intel-scratch-space](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-intel-scratch-space)
- CM script: [get-mlperf-inference-loadgen](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-loadgen)
- CM script: [get-mlperf-inference-nvidia-common-code](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-common-code)
@@ -312,6 +338,7 @@ ___
- CM script: [install-llvm-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-llvm-src)
- CM script: [install-mlperf-logging-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-mlperf-logging-from-src)
- CM script: [install-nccl-libs](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-nccl-libs)
+ - CM script: [install-numactl-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-numactl-from-src)
- CM script: [install-onednn-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-onednn-from-src)
- CM script: [install-onnxruntime-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-onnxruntime-from-src)
- CM script: [install-openssl](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-openssl)
@@ -326,11 +353,14 @@ ___
- CM script: [install-tensorflow-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tensorflow-from-src)
- CM script: [install-terraform-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-terraform-from-src)
- CM script: [install-tflite-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tflite-from-src)
+ - CM script: [install-torchvision-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-torchvision-from-src)
+ - CM script: [install-tpp-pytorch-extension](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tpp-pytorch-extension)
- CM script: [install-transformers-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-transformers-from-src)
- CM script: [launch-benchmark](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/launch-benchmark)
- CM script: [prepare-training-data-bert](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-bert)
- CM script: [prepare-training-data-resnet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-resnet)
- CM script: [preprocess-mlperf-inference-submission](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/preprocess-mlperf-inference-submission)
+ - CM script: [print-croissant-desc](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-croissant-desc)
- CM script: [print-hello-world](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world)
- CM script: [print-hello-world-java](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-java)
- CM script: [print-hello-world-javac](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-javac)
@@ -345,10 +375,6 @@ ___
- CM script: [push-mlperf-inference-results-to-github](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/push-mlperf-inference-results-to-github)
- CM script: [remote-run-commands](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/remote-run-commands)
- CM script: [reproduce-ipol-paper-2022-439](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-ipol-paper-2022-439)
- - CM script: [reproduce-micro-paper-2023-victima](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-micro-paper-2023-victima)
- - CM script: [reproduce-mlperf-inference-intel](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-inference-intel)
- - CM script: [reproduce-mlperf-inference-nvidia](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-inference-nvidia)
- - CM script: [reproduce-mlperf-inference-qualcomm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-inference-qualcomm)
- CM script: [reproduce-mlperf-octoml-tinyml-results](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results)
- CM script: [reproduce-mlperf-training-nvidia](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-training-nvidia)
- CM script: [run-docker-container](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-docker-container)
@@ -374,48 +400,10 @@ ___
- CM script: [truncate-mlperf-inference-accuracy-log](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/truncate-mlperf-inference-accuracy-log)
- CM script: [upgrade-python-pip](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/upgrade-python-pip)
- CM script: [wrapper-reproduce-octoml-tinyml-submission](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission)
- - CM script: [test-script1](https://github.com/gfursin/cm-tests/tree/master/script/test-script1)
- - CM script: [test-script2](https://github.com/gfursin/cm-tests/tree/master/script/test-script2)
- - CM script: [test-script3](https://github.com/gfursin/cm-tests/tree/master/script/test-script3)
- - CM script: [test-script4](https://github.com/gfursin/cm-tests/tree/master/script/test-script4)
- - CM script: [test-script5](https://github.com/gfursin/cm-tests/tree/master/script/test-script5)
- - CM script: [app-generate-image-dalle-mini-jax-py](https://github.com/cknowledge/tests/tree/master/cm/script/app-generate-image-dalle-mini-jax-py)
- - CM script: [app-generate-image-stable-diffusion2-pytorch-cuda-py](https://github.com/cknowledge/tests/tree/master/cm/script/app-generate-image-stable-diffusion2-pytorch-cuda-py)
- - CM script: [app-image-classification-onnx-py-ck](https://github.com/cknowledge/tests/tree/master/cm/script/app-image-classification-onnx-py-ck)
- - CM script: [app-image-corner-detection-old](https://github.com/cknowledge/tests/tree/master/cm/script/app-image-corner-detection-old)
- - CM script: [app-ipol-demo](https://github.com/cknowledge/tests/tree/master/cm/script/app-ipol-demo)
- - CM script: [app-stable-diffusion-pytorch-cuda-py](https://github.com/cknowledge/tests/tree/master/cm/script/app-stable-diffusion-pytorch-cuda-py)
- - CM script: [not-needed--get-android-cmdline-tools](https://github.com/cknowledge/tests/tree/master/cm/script/not-needed--get-android-cmdline-tools)
- - CM script: [not-needed--install-android-cmdline-tools](https://github.com/cknowledge/tests/tree/master/cm/script/not-needed--install-android-cmdline-tools)
- - CM script: [gui-llm](https://github.com/cknowledge/cm-private/tree/master/script/gui-llm)
- - CM script: [run-refiners-hello-world](https://github.com/cknowledge/cm-reproduce/tree/master/script/run-refiners-hello-world)
- - CM script: [install_dep](install_dep)
- - CM script: [produce-plots](produce-plots)
- - CM script: [reproduce-micro-2023-paper-victima](reproduce-micro-2023-paper-victima)
- - CM script: [run-experiments](run-experiments)
- - CM script: [process-mlperf-inference-results](https://github.com/mlcommons/ck_mlperf_results/tree/master/script/process-mlperf-inference-results)
- - CM script: [reproduce-ieee-acm-micro2023-paper-22](https://github.com/ctuning/cm-reproduce-research-projects/tree/master/script/reproduce-ieee-acm-micro2023-paper-22)
- - CM script: [reproduce-ieee-acm-micro2023-paper-28](https://github.com/ctuning/cm-reproduce-research-projects/tree/master/script/reproduce-ieee-acm-micro2023-paper-28)
- - CM script: [reproduce-ieee-acm-micro2023-paper-33](https://github.com/ctuning/cm-reproduce-research-projects/tree/master/script/reproduce-ieee-acm-micro2023-paper-33)
- - CM script: [reproduce-ieee-acm-micro2023-paper-38](https://github.com/ctuning/cm-reproduce-research-projects/tree/master/script/reproduce-ieee-acm-micro2023-paper-38)
- - CM script: [reproduce-ieee-acm-micro2023-paper-5](https://github.com/ctuning/cm-reproduce-research-projects/tree/master/script/reproduce-ieee-acm-micro2023-paper-5)
- - CM script: [reproduce-ieee-acm-micro2023-paper-8](https://github.com/ctuning/cm-reproduce-research-projects/tree/master/script/reproduce-ieee-acm-micro2023-paper-8)
- - CM script: [reproduce-ieee-acm-micro2023-paper-85](https://github.com/ctuning/cm-reproduce-research-projects/tree/master/script/reproduce-ieee-acm-micro2023-paper-85)
- - CM script: [reproduce-ieee-acm-micro2023-paper-87](https://github.com/ctuning/cm-reproduce-research-projects/tree/master/script/reproduce-ieee-acm-micro2023-paper-87)
- - CM script: [reproduce-ipol-paper-2022-439a](https://github.com/ctuning/cm-reproduce-research-projects/tree/master/script/reproduce-ipol-paper-2022-439a)
- - CM script: [reproduce-neurips-paper-2022-arxiv-2204.09656](https://github.com/ctuning/cm-reproduce-research-projects/tree/master/script/reproduce-neurips-paper-2022-arxiv-2204.09656)
- - CM script: [run-how-to-run-server](https://github.com/how-to-run/server/tree/master/script/run-how-to-run-server)
- - CM script: [get-dataset-cognata-mlcommons](https://github.com/mlcommons/abtf-ssd-pytorch/tree/master/cm/script/get-dataset-cognata-mlcommons)
-
___
### Script output
-`cmr "generate submission mlperf mlperf-tiny tiny mlcommons tiny-submission mlperf-tiny-submission mlcommons-tiny-submission" -j`
+`cmr "generate submission mlperf mlperf-tiny tiny mlcommons tiny-submission mlperf-tiny-submission mlcommons-tiny-submission " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/generate-nvidia-engine/README.md b/cm-mlops/script/generate-nvidia-engine/README.md
index b2d22a908f..1224a924fe 100644
--- a/cm-mlops/script/generate-nvidia-engine/README.md
+++ b/cm-mlops/script/generate-nvidia-engine/README.md
@@ -1,63 +1,60 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **generate-nvidia-engine**
-
+Category: **MLPerf benchmark support**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=generate-nvidia-engine,0eef9f05b272401f) ]*
+
+---
This CM script is in draft stage
+
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/generate-nvidia-engine)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-nvidia-engine)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *generate,engine,mlperf,inference,nvidia*
+* All CM tags to find and reuse this script (see in above meta description): *generate,engine,mlperf,inference,nvidia*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "generate engine mlperf inference nvidia" --help````
-#### Run this script from command line
+#### Customize and run this script from the command line with different variations and flags
-1. `cm run script --tags=generate,engine,mlperf,inference,nvidia[,variations] [--input_flags]`
+`cm run script --tags=generate,engine,mlperf,inference,nvidia`
-2. `cmr "generate engine mlperf inference nvidia[ variations]" [--input_flags]`
+`cm run script --tags=generate,engine,mlperf,inference,nvidia[,variations] [--input_flags]`
-* `variations` can be seen [here](#variations)
+*or*
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "generate engine mlperf inference nvidia"`
+
+`cmr "generate engine mlperf inference nvidia [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -93,7 +90,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=generate,engine,mlperf
#### Run this script via Docker (beta)
-`cm docker script "generate engine mlperf inference nvidia[ variations]" [--input_flags]`
+`cm docker script "generate engine mlperf inference nvidia[variations]" [--input_flags]`
___
### Customization
@@ -184,12 +181,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-nvidia-engine/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-nvidia-engine/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -229,25 +224,19 @@ ___
* `if (CM_MODEL == retinanet)`
* CM names: `--adr.['ml-model', 'retinanet-model']...`
- CM script: [get-ml-model-retinanet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-retinanet)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-nvidia-engine/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-nvidia-engine/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-nvidia-engine/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-nvidia-engine/_cm.yaml)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-nvidia-engine/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-nvidia-engine/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-nvidia-engine/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-nvidia-engine/_cm.yaml)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-nvidia-engine/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-nvidia-engine/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-nvidia-engine/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-nvidia-engine/_cm.yaml)
___
### Script output
-`cmr "generate engine mlperf inference nvidia[,variations]" [--input_flags] -j`
+`cmr "generate engine mlperf inference nvidia [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_DATASET_*`
* `CM_MLPERF_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-android-sdk/README.md b/cm-mlops/script/get-android-sdk/README.md
index d3c93e9731..e9345d8316 100644
--- a/cm-mlops/script/get-android-sdk/README.md
+++ b/cm-mlops/script/get-android-sdk/README.md
@@ -1,61 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-android-sdk**
-*Note that this README is automatically generated - don't edit!*
+Category: **Detection or installation of tools and artifacts**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-android-sdk,8c5b4b83d49c441a) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-android-sdk)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-android-sdk)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,android,sdk,android-sdk*
+* All CM tags to find and reuse this script (see in above meta description): *get,android,sdk,android-sdk*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get android sdk android-sdk" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,android,sdk,android-sdk`
-1. `cm run script --tags=get,android,sdk,android-sdk [--input_flags]`
+`cm run script --tags=get,android,sdk,android-sdk [--input_flags]`
-2. `cmr "get android sdk android-sdk" [--input_flags]`
+*or*
+
+`cmr "get android sdk android-sdk"`
+
+`cmr "get android sdk android-sdk " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -132,27 +124,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-android-sdk/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-android-sdk/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,java
- CM script: [get-java](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-java)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-android-sdk/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-android-sdk/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-android-sdk/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-android-sdk/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-android-sdk/_cm.json)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-android-sdk/_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/get-android-sdk/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-android-sdk/_cm.json)
___
### Script output
-`cmr "get android sdk android-sdk" [--input_flags] -j`
+`cmr "get android sdk android-sdk " [--input_flags] -j`
#### New environment keys (filter)
* `+PATH`
@@ -161,8 +150,4 @@ ___
* `CM_ANDROID_HOME`
#### New environment keys auto-detected from customize
-* `CM_ANDROID_HOME`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_ANDROID_HOME`
\ No newline at end of file
diff --git a/cm-mlops/script/get-aocl/README.md b/cm-mlops/script/get-aocl/README.md
index 9aefb8a3e3..48e352bb66 100644
--- a/cm-mlops/script/get-aocl/README.md
+++ b/cm-mlops/script/get-aocl/README.md
@@ -1,59 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-aocl**
-*Note that this README is automatically generated - don't edit!*
+Category: **Compiler automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-aocl,a65d3088f57d413d) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Compiler automation.*
-* 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-aocl)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-aocl)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,lib,aocl,amd-optimized,amd*
+* All CM tags to find and reuse this script (see in above meta description): *get,lib,aocl,amd-optimized,amd*
* Output cached? *true*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get lib aocl amd-optimized amd" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,lib,aocl,amd-optimized,amd`
-#### Run this script from command line
+`cm run script --tags=get,lib,aocl,amd-optimized,amd `
-1. `cm run script --tags=get,lib,aocl,amd-optimized,amd `
+*or*
+
+`cmr "get lib aocl amd-optimized amd"`
+
+`cmr "get lib aocl amd-optimized amd " `
-2. `cmr "get lib aocl amd-optimized amd" `
#### Run this script from Python
@@ -110,30 +104,27 @@ Default version: `4.0`
* `4.0`
* `master`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-aocl/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-aocl/_cm.json)***
* get,generic,sys-util,_libmpfr-dev
- CM script: [get-generic-sys-util](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-sys-util)
* get,generic-python-lib,_scons
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
* get,git,_repo.https://github.com/amd/aocl-libm-ose
- 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-aocl/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-aocl/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-aocl/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-aocl/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-aocl/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-aocl/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-aocl/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-aocl/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-aocl/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-aocl/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-aocl/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-aocl/_cm.json)
___
### Script output
-`cmr "get lib aocl amd-optimized amd" -j`
+`cmr "get lib aocl amd-optimized amd " -j`
#### New environment keys (filter)
* `+LD_LIBRARY_PATH`
@@ -145,8 +136,4 @@ ___
* `CM_AOCL_BUILD_PATH`
* `CM_AOCL_LIB_PATH`
-* `CM_AOCL_SRC_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_AOCL_SRC_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-aws-cli/README.md b/cm-mlops/script/get-aws-cli/README.md
index 8762deea24..e1f8094538 100644
--- a/cm-mlops/script/get-aws-cli/README.md
+++ b/cm-mlops/script/get-aws-cli/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-aws-cli**
-*Note that this README is automatically generated - don't edit!*
+Category: **Cloud automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-aws-cli,dad67944229942a3) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Cloud automation.*
-* 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-aws-cli)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-aws-cli)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,aws-cli,aws,cli*
+* All CM tags to find and reuse this script (see in above meta description): *get,aws-cli,aws,cli*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get aws-cli aws cli" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,aws-cli,aws,cli`
-1. `cm run script --tags=get,aws-cli,aws,cli `
+`cm run script --tags=get,aws-cli,aws,cli `
+
+*or*
+
+`cmr "get aws-cli aws cli"`
+
+`cmr "get aws-cli aws cli " `
-2. `cmr "get aws-cli aws cli" `
#### Run this script from Python
@@ -104,35 +99,28 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-aws-cli/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-aws-cli/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-aws-cli/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-aws-cli/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-aws-cli/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-aws-cli/_cm.json)***
* install,aws-cli
* `if (CM_REQUIRE_INSTALL == yes)`
- CM script: [install-aws-cli](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-aws-cli)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-aws-cli/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-aws-cli/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-aws-cli/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-aws-cli/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-aws-cli/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-aws-cli/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-aws-cli/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-aws-cli/_cm.json)
___
### Script output
-`cmr "get aws-cli aws cli" -j`
+`cmr "get aws-cli aws cli " -j`
#### New environment keys (filter)
* `CM_AWS_*`
#### New environment keys auto-detected from customize
* `CM_AWS_CACHE_TAGS`
-* `CM_AWS_INSTALLED_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_AWS_INSTALLED_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-bazel/README.md b/cm-mlops/script/get-bazel/README.md
index 18df234c03..d9730240ed 100644
--- a/cm-mlops/script/get-bazel/README.md
+++ b/cm-mlops/script/get-bazel/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-bazel**
-*Note that this README is automatically generated - don't edit!*
+Category: **Detection or installation of tools and artifacts**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-bazel,eaef0be38bac493c) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-bazel)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-bazel)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,bazel,get-bazel*
+* All CM tags to find and reuse this script (see in above meta description): *get,bazel,get-bazel*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get bazel get-bazel" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,bazel,get-bazel`
-1. `cm run script --tags=get,bazel,get-bazel `
+`cm run script --tags=get,bazel,get-bazel `
+
+*or*
+
+`cmr "get bazel get-bazel"`
+
+`cmr "get bazel get-bazel " `
-2. `cmr "get bazel get-bazel" `
#### Run this script from Python
@@ -104,27 +99,25 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-bazel/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-bazel/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-bazel/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-bazel/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-bazel/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-bazel/_cm.json)***
* install,bazel
* `if (CM_REQUIRE_INSTALL == yes)`
- CM script: [install-bazel](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-bazel)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-bazel/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-bazel/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-bazel/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-bazel/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-bazel/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-bazel/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-bazel/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-bazel/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-bazel/_cm.json)
___
### Script output
-`cmr "get bazel get-bazel" -j`
+`cmr "get bazel get-bazel " -j`
#### New environment keys (filter)
* `+PATH`
@@ -132,8 +125,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_BAZEL_CACHE_TAGS`
-* `CM_BAZEL_INSTALLED_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_BAZEL_INSTALLED_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-bert-squad-vocab/README.md b/cm-mlops/script/get-bert-squad-vocab/README.md
index e6ea1b1818..579bc28c42 100644
--- a/cm-mlops/script/get-bert-squad-vocab/README.md
+++ b/cm-mlops/script/get-bert-squad-vocab/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-bert-squad-vocab**
-
+Category: **AI/ML models**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-bert-squad-vocab,2f99a545ce734157) ]*
+---
#### Summary
-* Category: *AI/ML models.*
-* 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-bert-squad-vocab)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-bert-squad-vocab)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,bert,squad,bert-large,bert-squad,vocab*
+* All CM tags to find and reuse this script (see in above meta description): *get,bert,squad,bert-large,bert-squad,vocab*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get bert squad bert-large bert-squad vocab" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,bert,squad,bert-large,bert-squad,vocab`
-#### Run this script from command line
+`cm run script --tags=get,bert,squad,bert-large,bert-squad,vocab `
-1. `cm run script --tags=get,bert,squad,bert-large,bert-squad,vocab `
+*or*
+
+`cmr "get bert squad bert-large bert-squad vocab"`
+
+`cmr "get bert squad bert-large bert-squad vocab " `
-2. `cmr "get bert squad bert-large bert-squad vocab" `
#### Run this script from Python
@@ -101,31 +99,23 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-bert-squad-vocab/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-bert-squad-vocab/_cm.json)
1. Run "preprocess" function from customize.py
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-bert-squad-vocab/_cm.json)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-bert-squad-vocab/_cm.json)***
* download,file
- CM script: [download-file](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-file)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-bert-squad-vocab/_cm.json)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-bert-squad-vocab/_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/get-bert-squad-vocab/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-bert-squad-vocab/_cm.json)
___
### Script output
-`cmr "get bert squad bert-large bert-squad vocab" -j`
+`cmr "get bert squad bert-large bert-squad vocab " -j`
#### New environment keys (filter)
* `CM_ML_MODEL_BERT_VOCAB_FILE_WITH_PATH`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-blis/README.md b/cm-mlops/script/get-blis/README.md
index 332055ccd5..77cdb8047f 100644
--- a/cm-mlops/script/get-blis/README.md
+++ b/cm-mlops/script/get-blis/README.md
@@ -1,62 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ 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)
-
-
+Automatically generated README for this automation recipe: **get-blis**
-*Note that this README is automatically generated - don't edit!*
+Category: **Detection or installation of tools and artifacts**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-blis,ea6e1cf75242456c) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-blis)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-blis)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,lib,blis*
+* All CM tags to find and reuse this script (see in above meta description): *get,lib,blis*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get lib blis" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,lib,blis`
-#### Run this script from command line
+`cm run script --tags=get,lib,blis[,variations] `
-1. `cm run script --tags=get,lib,blis[,variations] `
+*or*
-2. `cmr "get lib blis[ variations]" `
+`cmr "get lib blis"`
-* `variations` can be seen [here](#variations)
+`cmr "get lib blis [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -92,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,lib,blis) to gener
#### Run this script via Docker (beta)
-`cm docker script "get lib blis[ variations]" `
+`cm docker script "get lib blis[variations]" `
___
### Customization
@@ -131,30 +124,27 @@ Default version: `master`
* `0.9.0`
* `master`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-blis/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-blis/_cm.json)***
* get,git
* CM names: `--adr.['blis-source-repo']...`
- CM script: [get-git-repo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo)
* detect,cpu
- CM script: [detect-cpu](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-blis/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-blis/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-blis/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-blis/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-blis/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-blis/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-blis/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-blis/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-blis/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-blis/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-blis/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-blis/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-blis/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-blis/_cm.json)
___
### Script output
-`cmr "get lib blis[,variations]" -j`
+`cmr "get lib blis [,variations]" -j`
#### New environment keys (filter)
* `+LD_LIBRARY_PATH`
@@ -167,8 +157,4 @@ ___
* `CM_BLIS_INC`
* `CM_BLIS_INSTALL_PATH`
* `CM_BLIS_LIB`
-* `CM_BLIS_SRC_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_BLIS_SRC_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-brew/README.md b/cm-mlops/script/get-brew/README.md
index 4b122993ec..1516f2536e 100644
--- a/cm-mlops/script/get-brew/README.md
+++ b/cm-mlops/script/get-brew/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-brew**
-
+Category: **Detection or installation of tools and artifacts**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-brew,4a2c5eab1ccf484f) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-brew)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-brew)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,brew*
+* All CM tags to find and reuse this script (see in above meta description): *get,brew*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get brew" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,brew`
-#### Run this script from command line
+`cm run script --tags=get,brew `
-1. `cm run script --tags=get,brew `
+*or*
+
+`cmr "get brew"`
+
+`cmr "get brew " `
-2. `cmr "get brew" `
#### Run this script from Python
@@ -101,29 +99,21 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-brew/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-brew/_cm.json)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-brew/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-brew/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-brew/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-brew/_cm.json)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-brew/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-brew/_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/get-brew/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-brew/_cm.json)
___
### Script output
-`cmr "get brew" -j`
+`cmr "get brew " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-ck-repo-mlops/README.md b/cm-mlops/script/get-ck-repo-mlops/README.md
index f6f97d969e..37970fd72a 100644
--- a/cm-mlops/script/get-ck-repo-mlops/README.md
+++ b/cm-mlops/script/get-ck-repo-mlops/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-ck-repo-mlops**
-
+Category: **Legacy CK support**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-ck-repo-mlops,d3a619b8186e4f74) ]*
+---
#### Summary
-* Category: *Legacy CK support.*
-* 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-ck-repo-mlops)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ck-repo-mlops)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,ck-repo,mlops,ck-repo-mlops*
+* All CM tags to find and reuse this script (see in above meta description): *get,ck-repo,mlops,ck-repo-mlops*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get ck-repo mlops ck-repo-mlops" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,ck-repo,mlops,ck-repo-mlops`
-#### Run this script from command line
+`cm run script --tags=get,ck-repo,mlops,ck-repo-mlops `
-1. `cm run script --tags=get,ck-repo,mlops,ck-repo-mlops `
+*or*
+
+`cmr "get ck-repo mlops ck-repo-mlops"`
+
+`cmr "get ck-repo mlops ck-repo-mlops " `
-2. `cmr "get ck-repo mlops ck-repo-mlops" `
#### Run this script from Python
@@ -101,32 +99,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ck-repo-mlops/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ck-repo-mlops/_cm.json)***
* get,ck
- CM script: [get-ck](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ck)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ck-repo-mlops/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ck-repo-mlops/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ck-repo-mlops/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ck-repo-mlops/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ck-repo-mlops/_cm.json)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ck-repo-mlops/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ck-repo-mlops/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ck-repo-mlops/_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/get-ck-repo-mlops/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ck-repo-mlops/_cm.json)
___
### Script output
-`cmr "get ck-repo mlops ck-repo-mlops" -j`
+`cmr "get ck-repo mlops ck-repo-mlops " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-ck/README.md b/cm-mlops/script/get-ck/README.md
index 172bec4a94..5a858a8c90 100644
--- a/cm-mlops/script/get-ck/README.md
+++ b/cm-mlops/script/get-ck/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-ck**
-
+Category: **Legacy CK support**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-ck,5575126797174cac) ]*
+---
#### Summary
-* Category: *Legacy CK support.*
-* 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-ck)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ck)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,ck,ck-framework*
+* All CM tags to find and reuse this script (see in above meta description): *get,ck,ck-framework*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get ck ck-framework" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,ck,ck-framework`
-#### Run this script from command line
+`cm run script --tags=get,ck,ck-framework `
-1. `cm run script --tags=get,ck,ck-framework `
+*or*
+
+`cmr "get ck ck-framework"`
+
+`cmr "get ck ck-framework " `
-2. `cmr "get ck ck-framework" `
#### Run this script from Python
@@ -101,30 +99,22 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ck/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ck/_cm.json)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ck/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ck/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ck/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ck/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ck/_cm.json)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ck/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ck/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ck/_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/get-ck/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ck/_cm.json)
___
### Script output
-`cmr "get ck ck-framework" -j`
+`cmr "get ck ck-framework " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-cl/README.md b/cm-mlops/script/get-cl/README.md
index 7ca0c1b855..3c78fbfc69 100644
--- a/cm-mlops/script/get-cl/README.md
+++ b/cm-mlops/script/get-cl/README.md
@@ -1,60 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-cl**
-*Note that this README is automatically generated - don't edit!*
+Category: **Compiler automation**
-### About
+License: **Apache 2.0**
-*Detect or install Microsoft C compiler.*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-cl,7dbb770faff947c0) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
-See extra [notes](README-extra.md) from the authors and contributors.
-
+---
#### Summary
-* Category: *Compiler automation.*
-* 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-cl)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cl)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,cl,compiler,c-compiler,cpp-compiler,get-cl*
+* All CM tags to find and reuse this script (see in above meta description): *get,cl,compiler,c-compiler,cpp-compiler,get-cl*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get cl compiler c-compiler cpp-compiler get-cl" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,cl,compiler,c-compiler,cpp-compiler,get-cl`
-1. `cm run script --tags=get,cl,compiler,c-compiler,cpp-compiler,get-cl `
+`cm run script --tags=get,cl,compiler,c-compiler,cpp-compiler,get-cl `
+
+*or*
+
+`cmr "get cl compiler c-compiler cpp-compiler get-cl"`
+
+`cmr "get cl compiler c-compiler cpp-compiler get-cl " `
-2. `cmr "get cl compiler c-compiler cpp-compiler get-cl" `
#### Run this script from Python
@@ -106,24 +99,21 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cl/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cl/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cl/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cl/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cl/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cl/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cl/run.bat)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cl/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cl/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cl/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cl/run.bat)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cl/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cl/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cl/_cm.json)
___
### Script output
-`cmr "get cl compiler c-compiler cpp-compiler get-cl" -j`
+`cmr "get cl compiler c-compiler cpp-compiler get-cl " -j`
#### New environment keys (filter)
* `+PATH`
@@ -147,8 +137,4 @@ ___
* `CM_C_COMPILER_BIN`
* `CM_C_COMPILER_FLAG_OUTPUT`
* `CM_C_COMPILER_FLAG_VERSION`
-* `CM_C_COMPILER_WITH_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_C_COMPILER_WITH_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-cmake/README.md b/cm-mlops/script/get-cmake/README.md
index 0601ced689..5c056e9055 100644
--- a/cm-mlops/script/get-cmake/README.md
+++ b/cm-mlops/script/get-cmake/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-cmake**
-
+Category: **Detection or installation of tools and artifacts**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-cmake,52bf974d791b4fc8) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-cmake)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cmake)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,cmake,get-cmake*
+* All CM tags to find and reuse this script (see in above meta description): *get,cmake,get-cmake*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get cmake get-cmake" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,cmake,get-cmake`
-#### Run this script from command line
+`cm run script --tags=get,cmake,get-cmake `
-1. `cm run script --tags=get,cmake,get-cmake `
+*or*
+
+`cmr "get cmake get-cmake"`
+
+`cmr "get cmake get-cmake " `
-2. `cmr "get cmake get-cmake" `
#### Run this script from Python
@@ -101,30 +99,27 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmake/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cmake/_cm.json)***
* detect,cpu
- CM script: [detect-cpu](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmake/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmake/_cm.json)***
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cmake/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cmake/_cm.json)***
* install,cmake,prebuilt
* `if (CM_REQUIRE_INSTALL == yes)`
- CM script: [install-cmake-prebuilt](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cmake-prebuilt)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmake/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmake/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmake/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmake/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmake/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cmake/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cmake/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cmake/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cmake/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cmake/_cm.json)
___
### Script output
-`cmr "get cmake get-cmake" -j`
+`cmr "get cmake get-cmake " -j`
#### New environment keys (filter)
* `+PATH`
@@ -133,8 +128,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_CMAKE_CACHE_TAGS`
-* `CM_MAKE_CORES`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_MAKE_CORES`
\ No newline at end of file
diff --git a/cm-mlops/script/get-cmsis_5/README.md b/cm-mlops/script/get-cmsis_5/README.md
index 6c2a4398d6..52c3f1a4b8 100644
--- a/cm-mlops/script/get-cmsis_5/README.md
+++ b/cm-mlops/script/get-cmsis_5/README.md
@@ -1,62 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ 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)
-
-
+Automatically generated README for this automation recipe: **get-cmsis_5**
-*Note that this README is automatically generated - don't edit!*
+Category: **Detection or installation of tools and artifacts**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-cmsis_5,2258c212b11443f5) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-cmsis_5)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cmsis_5)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,cmsis,cmsis_5,arm-software*
+* All CM tags to find and reuse this script (see in above meta description): *get,cmsis,cmsis_5,arm-software*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get cmsis cmsis_5 arm-software" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,cmsis,cmsis_5,arm-software`
-#### Run this script from command line
+`cm run script --tags=get,cmsis,cmsis_5,arm-software[,variations] `
-1. `cm run script --tags=get,cmsis,cmsis_5,arm-software[,variations] `
+*or*
-2. `cmr "get cmsis cmsis_5 arm-software[ variations]" `
+`cmr "get cmsis cmsis_5 arm-software"`
-* `variations` can be seen [here](#variations)
+`cmr "get cmsis cmsis_5 arm-software [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -92,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,cmsis,cmsis_5,arm-
#### Run this script via Docker (beta)
-`cm docker script "get cmsis cmsis_5 arm-software[ variations]" `
+`cm docker script "get cmsis cmsis_5 arm-software[variations]" `
___
### Customization
@@ -135,32 +128,24 @@ Default version: `custom`
* `develop`
* `master`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmsis_5/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cmsis_5/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmsis_5/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmsis_5/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cmsis_5/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cmsis_5/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmsis_5/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmsis_5/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmsis_5/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmsis_5/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cmsis_5/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cmsis_5/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cmsis_5/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cmsis_5/_cm.json)
___
### Script output
-`cmr "get cmsis cmsis_5 arm-software[,variations]" -j`
+`cmr "get cmsis cmsis_5 arm-software [,variations]" -j`
#### New environment keys (filter)
* `CMSIS*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-compiler-flags/README.md b/cm-mlops/script/get-compiler-flags/README.md
index 7d9b73d23c..fe11a854f8 100644
--- a/cm-mlops/script/get-compiler-flags/README.md
+++ b/cm-mlops/script/get-compiler-flags/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-compiler-flags**
-
+Category: **Compiler automation**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-compiler-flags,31be8b74a69742f8) ]*
+---
#### Summary
-* Category: *Compiler automation.*
-* 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-compiler-flags)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-compiler-flags)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,compiler-flags*
+* All CM tags to find and reuse this script (see in above meta description): *get,compiler-flags*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get compiler-flags" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,compiler-flags`
-#### Run this script from command line
+`cm run script --tags=get,compiler-flags `
-1. `cm run script --tags=get,compiler-flags `
+*or*
+
+`cmr "get compiler-flags"`
+
+`cmr "get compiler-flags " `
-2. `cmr "get compiler-flags" `
#### Run this script from Python
@@ -101,12 +99,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-compiler-flags/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-compiler-flags/_cm.json)***
* detect,cpu
- CM script: [detect-cpu](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
* get,compiler
@@ -115,17 +111,16 @@ ___
- CM script: [get-cl](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cl)
- CM script: [get-gcc](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-gcc)
- CM script: [get-llvm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-llvm)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-compiler-flags/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-compiler-flags/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-compiler-flags/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-compiler-flags/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-compiler-flags/_cm.json)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-compiler-flags/_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/get-compiler-flags/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-compiler-flags/_cm.json)
___
### Script output
-`cmr "get compiler-flags" -j`
+`cmr "get compiler-flags " -j`
#### New environment keys (filter)
* `+ CFLAGS`
@@ -134,8 +129,3 @@ ___
* `+ LDFLAGS`
* `+CM_HOST_OS_DEFAULT_INCLUDE_PATH`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-compiler-rust/README.md b/cm-mlops/script/get-compiler-rust/README.md
index 54a5c49f3b..96eea7341f 100644
--- a/cm-mlops/script/get-compiler-rust/README.md
+++ b/cm-mlops/script/get-compiler-rust/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-compiler-rust**
-
+Category: **Compiler automation**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-compiler-rust,97ffbd9e537b4b59) ]*
+---
#### Summary
-* Category: *Compiler automation.*
-* 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-compiler-rust)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-compiler-rust)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *get,rust-compiler*
+* All CM tags to find and reuse this script (see in above meta description): *get,rust-compiler*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get rust-compiler" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,rust-compiler`
-#### Run this script from command line
+`cm run script --tags=get,rust-compiler `
-1. `cm run script --tags=get,rust-compiler `
+*or*
+
+`cmr "get rust-compiler"`
+
+`cmr "get rust-compiler " `
-2. `cmr "get rust-compiler" `
#### Run this script from Python
@@ -101,32 +99,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-compiler-rust/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-compiler-rust/_cm.yaml)***
* get,python3
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-compiler-rust/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-compiler-rust/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-compiler-rust/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-compiler-rust/_cm.yaml)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-compiler-rust/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-compiler-rust/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-compiler-rust/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-compiler-rust/_cm.yaml)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-compiler-rust/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-compiler-rust/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-compiler-rust/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-compiler-rust/_cm.yaml)
___
### Script output
-`cmr "get rust-compiler" -j`
+`cmr "get rust-compiler " -j`
#### New environment keys (filter)
* `+PATH`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-conda/README.md b/cm-mlops/script/get-conda/README.md
index 5e6d3de950..a1927ef8de 100644
--- a/cm-mlops/script/get-conda/README.md
+++ b/cm-mlops/script/get-conda/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-conda**
-
+Category: **DevOps automation**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-conda,6600115f41324c7b) ]*
+---
#### Summary
-* Category: *DevOps automation.*
-* 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-conda)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-conda)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,conda,get-conda*
+* All CM tags to find and reuse this script (see in above meta description): *get,conda,get-conda*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get conda get-conda" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,conda,get-conda`
-#### Run this script from command line
+`cm run script --tags=get,conda,get-conda[,variations] `
-1. `cm run script --tags=get,conda,get-conda[,variations] `
+*or*
-2. `cmr "get conda get-conda[ variations]" `
+`cmr "get conda get-conda"`
-* `variations` can be seen [here](#variations)
+`cmr "get conda get-conda [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,conda,get-conda) t
#### Run this script via Docker (beta)
-`cm docker script "get conda get-conda[ variations]" `
+`cm docker script "get conda get-conda[variations]" `
___
### Customization
@@ -134,27 +131,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-conda/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-conda/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-conda/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-conda/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-conda/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-conda/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-conda/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-conda/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-conda/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-conda/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-conda/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-conda/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-conda/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-conda/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-conda/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-conda/_cm.json)
___
### Script output
-`cmr "get conda get-conda[,variations]" -j`
+`cmr "get conda get-conda [,variations]" -j`
#### New environment keys (filter)
* `+LD_LIBRARY_PATH`
@@ -169,8 +163,4 @@ ___
* `CM_CONDA_BIN_PATH`
* `CM_CONDA_BIN_WITH_PATH`
* `CM_CONDA_LIB_PATH`
-* `CM_CONDA_PREFIX`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_CONDA_PREFIX`
\ No newline at end of file
diff --git a/cm-mlops/script/get-croissant/README.md b/cm-mlops/script/get-croissant/README.md
index 387d9e7a20..8a42f268a4 100644
--- a/cm-mlops/script/get-croissant/README.md
+++ b/cm-mlops/script/get-croissant/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-croissant**
-
+Category: **AI/ML datasets**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-croissant,8fd653eac8da4c14) ]*
+---
#### Summary
-* 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-croissant)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/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*
+* All CM tags to find and reuse this script (see in above meta description): *get,mlcommons,croissant*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get mlcommons croissant" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,mlcommons,croissant`
-#### Run this script from command line
+`cm run script --tags=get,mlcommons,croissant `
-1. `cm run script --tags=get,mlcommons,croissant `
+*or*
+
+`cmr "get mlcommons croissant"`
+
+`cmr "get mlcommons croissant " `
-2. `cmr "get mlcommons croissant" `
#### Run this script from Python
@@ -101,12 +99,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-croissant/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/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,24 +111,18 @@ ___
* 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-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 "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-croissant/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/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-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)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-croissant/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-croissant/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-croissant/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-croissant/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-croissant/_cm.json)
___
### Script output
-`cmr "get mlcommons croissant" -j`
+`cmr "get mlcommons croissant " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-cuda-devices/README.md b/cm-mlops/script/get-cuda-devices/README.md
index d980b02c42..e9fd635c60 100644
--- a/cm-mlops/script/get-cuda-devices/README.md
+++ b/cm-mlops/script/get-cuda-devices/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-cuda-devices**
-
+Category: **CUDA automation**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-cuda-devices,7a3ede4d3558427a) ]*
+---
#### Summary
-* Category: *CUDA automation.*
-* 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-cuda-devices)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cuda-devices)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,cuda-devices*
+* All CM tags to find and reuse this script (see in above meta description): *get,cuda-devices*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get cuda-devices" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,cuda-devices`
-#### Run this script from command line
+`cm run script --tags=get,cuda-devices `
-1. `cm run script --tags=get,cuda-devices `
+*or*
+
+`cmr "get cuda-devices"`
+
+`cmr "get cuda-devices " `
-2. `cmr "get cuda-devices" `
#### Run this script from Python
@@ -101,34 +99,26 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda-devices/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cuda-devices/_cm.json)***
* get,cuda,_toolkit
* CM names: `--adr.['cuda']...`
- CM script: [get-cuda](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda-devices/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cuda-devices/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda-devices/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda-devices/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda-devices/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda-devices/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda-devices/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cuda-devices/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cuda-devices/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cuda-devices/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cuda-devices/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cuda-devices/_cm.json)
___
### Script output
-`cmr "get cuda-devices" -j`
+`cmr "get cuda-devices " -j`
#### New environment keys (filter)
* `CM_CUDA_DEVICE_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-cuda/README.md b/cm-mlops/script/get-cuda/README.md
index ba5306a6d8..849e7cb5cc 100644
--- a/cm-mlops/script/get-cuda/README.md
+++ b/cm-mlops/script/get-cuda/README.md
@@ -1,30 +1,15 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-cuda**
-
+Category: **CUDA automation**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-cuda,46d133d9ef92422d) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+
+---
# System dependencies
@@ -34,38 +19,47 @@
-See extra [notes](README-extra.md) from the authors and contributors.
-
+---
#### Summary
-* Category: *CUDA automation.*
-* 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-cuda)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cuda)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,cuda,cuda-compiler,cuda-lib,toolkit,lib,nvcc,get-nvcc,get-cuda*
+* All CM tags to find and reuse this script (see in above meta description): *get,cuda,cuda-compiler,cuda-lib,toolkit,lib,nvcc,get-nvcc,get-cuda*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get cuda cuda-compiler cuda-lib toolkit lib nvcc get-nvcc get-cuda" --help````
-#### Run this script from command line
+#### Customize and run this script from the command line with different variations and flags
-1. `cm run script --tags=get,cuda,cuda-compiler,cuda-lib,toolkit,lib,nvcc,get-nvcc,get-cuda[,variations] [--input_flags]`
+`cm run script --tags=get,cuda,cuda-compiler,cuda-lib,toolkit,lib,nvcc,get-nvcc,get-cuda`
-2. `cmr "get cuda cuda-compiler cuda-lib toolkit lib nvcc get-nvcc get-cuda[ variations]" [--input_flags]`
+`cm run script --tags=get,cuda,cuda-compiler,cuda-lib,toolkit,lib,nvcc,get-nvcc,get-cuda[,variations] [--input_flags]`
-* `variations` can be seen [here](#variations)
+*or*
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get cuda cuda-compiler cuda-lib toolkit lib nvcc get-nvcc get-cuda"`
+
+`cmr "get cuda cuda-compiler cuda-lib toolkit lib nvcc get-nvcc get-cuda [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -101,7 +95,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,cuda,cuda-compiler
#### Run this script via Docker (beta)
-`cm docker script "get cuda cuda-compiler cuda-lib toolkit lib nvcc get-nvcc get-cuda[ variations]" [--input_flags]`
+`cm docker script "get cuda cuda-compiler cuda-lib toolkit lib nvcc get-nvcc get-cuda[variations]" [--input_flags]`
___
### Customization
@@ -181,20 +175,18 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cuda/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,cl
* `if (CM_CUDA_FULL_TOOLKIT_INSTALL == yes AND CM_HOST_OS_TYPE == windows)`
* CM names: `--adr.['compiler']...`
- CM script: [get-cl](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cl)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda/_cm.json)***
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cuda/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cuda/_cm.json)***
* install,cuda,prebuilt
* `if (CM_REQUIRE_INSTALL == yes)`
* CM names: `--adr.['install-cuda-prebuilt']...`
@@ -203,16 +195,15 @@ ___
* `if (CM_CUDA_PACKAGE_MANAGER_INSTALL == yes)`
- CM script: [get-generic-sys-util](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-sys-util)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cuda/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cuda/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cuda/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cuda/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cuda/_cm.json)
___
### Script output
-`cmr "get cuda cuda-compiler cuda-lib toolkit lib nvcc get-nvcc get-cuda[,variations]" [--input_flags] -j`
+`cmr "get cuda cuda-compiler cuda-lib toolkit lib nvcc get-nvcc get-cuda [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `+ LDFLAGS`
@@ -235,8 +226,4 @@ ___
* `CM_CUDA_PATH_LIB`
* `CM_CUDA_VERSION`
* `CM_CUDA_VERSION_STRING`
-* `CM_NVCC_BIN`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_NVCC_BIN`
\ No newline at end of file
diff --git a/cm-mlops/script/get-cudnn/README.md b/cm-mlops/script/get-cudnn/README.md
index 7e91089015..75ec5c3634 100644
--- a/cm-mlops/script/get-cudnn/README.md
+++ b/cm-mlops/script/get-cudnn/README.md
@@ -1,63 +1,65 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Input description](#input-description)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-cudnn**
-*Note that this README is automatically generated - don't edit!*
+Category: **CUDA automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-cudnn,d73ee19baee14df8) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *CUDA automation.*
-* 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-cudnn)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cudnn)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,cudnn,nvidia*
+* All CM tags to find and reuse this script (see in above meta description): *get,cudnn,nvidia*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get cudnn nvidia" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,cudnn,nvidia`
-1. `cm run script --tags=get,cudnn,nvidia [--input_flags]`
+`cm run script --tags=get,cudnn,nvidia [--input_flags]`
-2. `cmr "get cudnn nvidia" [--input_flags]`
+*or*
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get cudnn nvidia"`
+`cmr "get cudnn nvidia " [--input_flags]`
+
+
+
+#### Input Flags
+
+* --**input**=Full path to the installed cuDNN library
+* --**tar_file**=Full path to the cuDNN Tar file downloaded from Nvidia website (https://developer.nvidia.com/cudnn)
+
+**Above CLI flags can be used in the Python CM API as follows:**
+
+```python
+r=cm.access({... , "input":...}
+```
#### Run this script from Python
@@ -98,17 +100,6 @@ ___
### Customization
-#### Input description
-
-* --**input** Full path to the installed cuDNN library
-* --**tar_file** Full path to the cuDNN Tar file downloaded from Nvidia website (https://developer.nvidia.com/cudnn)
-
-**Above CLI flags can be used in the Python CM API as follows:**
-
-```python
-r=cm.access({... , "input":...}
-```
-
#### Script flags mapped to environment
Click here to expand this section.
@@ -137,30 +128,27 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cudnn/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cudnn/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,cuda
* `if (CM_CUDA_PATH_LIB != on OR CM_CUDA_PATH_INCLUDE != on)`
* CM names: `--adr.['cuda']...`
- CM script: [get-cuda](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cudnn/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cudnn/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cudnn/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cudnn/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cudnn/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cudnn/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cudnn/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cudnn/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cudnn/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cudnn/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cudnn/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cudnn/_cm.json)
___
### Script output
-`cmr "get cudnn nvidia" [--input_flags] -j`
+`cmr "get cudnn nvidia " [--input_flags] -j`
#### New environment keys (filter)
* `+CPLUS_INCLUDE_PATH`
@@ -177,8 +165,4 @@ ___
* `CM_CUDA_PATH_INCLUDE_CUDNN`
* `CM_CUDA_PATH_LIB_CUDNN`
* `CM_CUDA_PATH_LIB_CUDNN_EXISTS`
-* `CM_CUDNN_VERSION`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_CUDNN_VERSION`
\ No newline at end of file
diff --git a/cm-mlops/script/get-dataset-cifar10/README.md b/cm-mlops/script/get-dataset-cifar10/README.md
index f0de37cfc7..607aa105ac 100644
--- a/cm-mlops/script/get-dataset-cifar10/README.md
+++ b/cm-mlops/script/get-dataset-cifar10/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-dataset-cifar10**
-
+Category: **AI/ML datasets**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-dataset-cifar10,2f0c0bb3663b4ed7) ]*
+---
#### Summary
-* 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-dataset-cifar10)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cifar10)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,dataset,cifar10,image-classification,validation,training*
+* All CM tags to find and reuse this script (see in above meta description): *get,dataset,cifar10,image-classification,validation,training*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get dataset cifar10 image-classification validation training" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,dataset,cifar10,image-classification,validation,training`
-#### Run this script from command line
+`cm run script --tags=get,dataset,cifar10,image-classification,validation,training[,variations] `
-1. `cm run script --tags=get,dataset,cifar10,image-classification,validation,training[,variations] `
+*or*
-2. `cmr "get dataset cifar10 image-classification validation training[ variations]" `
+`cmr "get dataset cifar10 image-classification validation training"`
-* `variations` can be seen [here](#variations)
+`cmr "get dataset cifar10 image-classification validation training [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,dataset,cifar10,im
#### Run this script via Docker (beta)
-`cm docker script "get dataset cifar10 image-classification validation training[ variations]" `
+`cm docker script "get dataset cifar10 image-classification validation training[variations]" `
___
### Customization
@@ -145,33 +142,25 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cifar10/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cifar10/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cifar10/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cifar10/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cifar10/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cifar10/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cifar10/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cifar10/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cifar10/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cifar10/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cifar10/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cifar10/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cifar10/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cifar10/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cifar10/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cifar10/_cm.json)
___
### Script output
-`cmr "get dataset cifar10 image-classification validation training[,variations]" -j`
+`cmr "get dataset cifar10 image-classification validation training [,variations]" -j`
#### New environment keys (filter)
* `CM_DATASET_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-dataset-cnndm/README.md b/cm-mlops/script/get-dataset-cnndm/README.md
index d5f0c949f9..5e37effee9 100644
--- a/cm-mlops/script/get-dataset-cnndm/README.md
+++ b/cm-mlops/script/get-dataset-cnndm/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-dataset-cnndm**
-
+Category: **AI/ML datasets**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-dataset-cnndm,aed298c156e24257) ]*
+---
#### Summary
-* 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-dataset-cnndm)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cnndm)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,dataset,gpt-j,cnndm,cnn-dailymail,original*
+* All CM tags to find and reuse this script (see in above meta description): *get,dataset,gpt-j,cnndm,cnn-dailymail,original*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get dataset gpt-j cnndm cnn-dailymail original" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,dataset,gpt-j,cnndm,cnn-dailymail,original`
-#### Run this script from command line
+`cm run script --tags=get,dataset,gpt-j,cnndm,cnn-dailymail,original[,variations] `
-1. `cm run script --tags=get,dataset,gpt-j,cnndm,cnn-dailymail,original[,variations] `
+*or*
-2. `cmr "get dataset gpt-j cnndm cnn-dailymail original[ variations]" `
+`cmr "get dataset gpt-j cnndm cnn-dailymail original"`
-* `variations` can be seen [here](#variations)
+`cmr "get dataset gpt-j cnndm cnn-dailymail original [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,dataset,gpt-j,cnnd
#### Run this script via Docker (beta)
-`cm docker script "get dataset gpt-j cnndm cnn-dailymail original[ variations]" `
+`cm docker script "get dataset gpt-j cnndm cnn-dailymail original[variations]" `
___
### Customization
@@ -141,12 +138,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cnndm/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cnndm/_cm.json)***
* get,sys-utils-cm
- CM script: [get-sys-utils-cm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm)
* get,python3
@@ -164,24 +159,18 @@ ___
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
* get,generic-python-lib,_numpy
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cnndm/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cnndm/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cnndm/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cnndm/_cm.json)
1. ***Run native script if exists***
- * [run-intel.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cnndm/run-intel.sh)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cnndm/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cnndm/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cnndm/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cnndm/_cm.json)
-
+ * [run-intel.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cnndm/run-intel.sh)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cnndm/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cnndm/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cnndm/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cnndm/_cm.json)
___
### Script output
-`cmr "get dataset gpt-j cnndm cnn-dailymail original[,variations]" -j`
+`cmr "get dataset gpt-j cnndm cnn-dailymail original [,variations]" -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-dataset-coco/README.md b/cm-mlops/script/get-dataset-coco/README.md
index ae13023e96..37dd544a7b 100644
--- a/cm-mlops/script/get-dataset-coco/README.md
+++ b/cm-mlops/script/get-dataset-coco/README.md
@@ -1,64 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-dataset-coco**
-*Note that this README is automatically generated - don't edit!*
+Category: **AI/ML datasets**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-dataset-coco,c198e1f60ac6445c) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* 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-dataset-coco)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-coco)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,dataset,object-detection,coco*
+* All CM tags to find and reuse this script (see in above meta description): *get,dataset,object-detection,coco*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get dataset object-detection coco" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,dataset,object-detection,coco`
-1. `cm run script --tags=get,dataset,object-detection,coco[,variations] [--input_flags]`
+`cm run script --tags=get,dataset,object-detection,coco[,variations] [--input_flags]`
-2. `cmr "get dataset object-detection coco[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get dataset object-detection coco"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get dataset object-detection coco [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -94,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,dataset,object-det
#### Run this script via Docker (beta)
-`cm docker script "get dataset object-detection coco[ variations]" [--input_flags]`
+`cm docker script "get dataset object-detection coco[variations]" [--input_flags]`
___
### Customization
@@ -178,16 +169,14 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-coco/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco/_cm.json)***
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-coco/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-coco/_cm.json)***
* download-and-extract,file,_wget,_extract
* `if (CM_DATASET_COCO_DETECTED != yes)`
* CM names: `--adr.['get-dataset-coco-data', '746e5dad5e784ad6']...`
@@ -197,14 +186,13 @@ ___
* CM names: `--adr.['get-dataset-coco-annotations', 'edb6cd092ff64171']...`
- CM script: [download-and-extract](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-and-extract)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-coco/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-coco/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-coco/_cm.json)
___
### Script output
-`cmr "get dataset object-detection coco[,variations]" [--input_flags] -j`
+`cmr "get dataset object-detection coco [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_DATASET_COCO*`
@@ -224,8 +212,4 @@ ___
* `CM_DATASET_COCO_URL_DATA_FULL`
* `CM_DATASET_COCO_VERSION`
* `CM_DATASET_PATH`
-* `CM_DATASET_PATH_ROOT`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_DATASET_PATH_ROOT`
\ No newline at end of file
diff --git a/cm-mlops/script/get-dataset-coco2014/README.md b/cm-mlops/script/get-dataset-coco2014/README.md
index 006d2fc524..a6f6b84bc0 100644
--- a/cm-mlops/script/get-dataset-coco2014/README.md
+++ b/cm-mlops/script/get-dataset-coco2014/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-dataset-coco2014**
-
+Category: **AI/ML datasets**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-dataset-coco2014,3f7ad9d42f4040f8) ]*
+---
#### Summary
-* 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-dataset-coco2014)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-coco2014)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,dataset,coco2014,object-detection,original*
+* All CM tags to find and reuse this script (see in above meta description): *get,dataset,coco2014,object-detection,original*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get dataset coco2014 object-detection original" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,dataset,coco2014,object-detection,original`
-#### Run this script from command line
+`cm run script --tags=get,dataset,coco2014,object-detection,original[,variations] `
-1. `cm run script --tags=get,dataset,coco2014,object-detection,original[,variations] `
+*or*
-2. `cmr "get dataset coco2014 object-detection original[ variations]" `
+`cmr "get dataset coco2014 object-detection original"`
-* `variations` can be seen [here](#variations)
+`cmr "get dataset coco2014 object-detection original [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,dataset,coco2014,o
#### Run this script via Docker (beta)
-`cm docker script "get dataset coco2014 object-detection original[ variations]" `
+`cm docker script "get dataset coco2014 object-detection original[variations]" `
___
### Customization
@@ -168,34 +165,31 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco2014/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-coco2014/_cm.json)***
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
* mlperf,inference,source
* CM names: `--adr.['inference-src']...`
- CM script: [get-mlperf-inference-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-src)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco2014/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco2014/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-coco2014/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-coco2014/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco2014/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco2014/run.sh)
- 1. ***Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco2014/_cm.json)***
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-coco2014/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-coco2014/run.sh)
+ 1. ***Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-coco2014/_cm.json)***
* get,coco2014,annotations
* `if (CM_DATASET_COCO2014_CUSTOM_ANNOTATIONS == yes)`
- *Warning: no scripts found*
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco2014/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco2014/_cm.json)
-
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-coco2014/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-coco2014/_cm.json)
___
### Script output
-`cmr "get dataset coco2014 object-detection original[,variations]" -j`
+`cmr "get dataset coco2014 object-detection original [,variations]" -j`
#### New environment keys (filter)
* `CM_CALIBRATION_DATASET_PATH`
@@ -207,8 +201,4 @@ ___
* `CM_CALIBRATION_DATASET_PATH`
* `CM_DATASET_PATH`
-* `CM_DATASET_PATH_ROOT`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_DATASET_PATH_ROOT`
\ No newline at end of file
diff --git a/cm-mlops/script/get-dataset-cognata/README.md b/cm-mlops/script/get-dataset-cognata/README.md
index 606d81713a..e12d304273 100644
--- a/cm-mlops/script/get-dataset-cognata/README.md
+++ b/cm-mlops/script/get-dataset-cognata/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-dataset-cognata**
-
+Category: **AI/ML datasets**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-dataset-cognata,c46dbd62f76649a2) ]*
+---
#### Summary
-* 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-dataset-cognata)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cognata)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,dataset,cognata,object-detection,original*
+* All CM tags to find and reuse this script (see in above meta description): *get,dataset,cognata,object-detection,original*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get dataset cognata object-detection original" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,dataset,cognata,object-detection,original`
-#### Run this script from command line
+`cm run script --tags=get,dataset,cognata,object-detection,original[,variations] `
-1. `cm run script --tags=get,dataset,cognata,object-detection,original[,variations] `
+*or*
-2. `cmr "get dataset cognata object-detection original[ variations]" `
+`cmr "get dataset cognata object-detection original"`
-* `variations` can be seen [here](#variations)
+`cmr "get dataset cognata object-detection original [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,dataset,cognata,ob
#### Run this script via Docker (beta)
-`cm docker script "get dataset cognata object-detection original[ variations]" `
+`cm docker script "get dataset cognata object-detection original[variations]" `
___
### Customization
@@ -149,26 +146,23 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cognata/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cognata/_cm.json)***
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cognata/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cognata/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cognata/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cognata/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cognata/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cognata/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cognata/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cognata/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cognata/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cognata/_cm.json)
___
### Script output
-`cmr "get dataset cognata object-detection original[,variations]" -j`
+`cmr "get dataset cognata object-detection original [,variations]" -j`
#### New environment keys (filter)
* `CM_CALIBRATION_DATASET_PATH`
@@ -180,8 +174,4 @@ ___
* `CM_CALIBRATION_DATASET_PATH`
* `CM_DATASET_PATH`
-* `CM_DATASET_PATH_ROOT`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_DATASET_PATH_ROOT`
\ No newline at end of file
diff --git a/cm-mlops/script/get-dataset-criteo/README.md b/cm-mlops/script/get-dataset-criteo/README.md
index 079302b281..8b60049013 100644
--- a/cm-mlops/script/get-dataset-criteo/README.md
+++ b/cm-mlops/script/get-dataset-criteo/README.md
@@ -1,64 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-dataset-criteo**
-*Note that this README is automatically generated - don't edit!*
+Category: **AI/ML datasets**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-dataset-criteo,194a47d908714897) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* 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-dataset-criteo)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-criteo)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,dataset,criteo,original*
+* All CM tags to find and reuse this script (see in above meta description): *get,dataset,criteo,original*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get dataset criteo original" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,dataset,criteo,original`
-1. `cm run script --tags=get,dataset,criteo,original[,variations] [--input_flags]`
+`cm run script --tags=get,dataset,criteo,original[,variations] [--input_flags]`
-2. `cmr "get dataset criteo original[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get dataset criteo original"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get dataset criteo original [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -94,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,dataset,criteo,ori
#### Run this script via Docker (beta)
-`cm docker script "get dataset criteo original[ variations]" [--input_flags]`
+`cm docker script "get dataset criteo original[variations]" [--input_flags]`
___
### Customization
@@ -144,30 +135,22 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-criteo/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-criteo/_cm.json)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-criteo/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-criteo/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-criteo/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-criteo/_cm.json)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-criteo/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-criteo/_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/get-dataset-criteo/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-criteo/_cm.json)
___
### Script output
-`cmr "get dataset criteo original[,variations]" [--input_flags] -j`
+`cmr "get dataset criteo original [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_DATASET*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-dataset-imagenet-aux/README.md b/cm-mlops/script/get-dataset-imagenet-aux/README.md
index fccf4c8a3a..584f971127 100644
--- a/cm-mlops/script/get-dataset-imagenet-aux/README.md
+++ b/cm-mlops/script/get-dataset-imagenet-aux/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-dataset-imagenet-aux**
-
+Category: **AI/ML datasets**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-dataset-imagenet-aux,bb2c6dd8c8c64217) ]*
+---
#### Summary
-* 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-dataset-imagenet-aux)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-aux)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,aux,dataset-aux,image-classification,imagenet-aux*
+* All CM tags to find and reuse this script (see in above meta description): *get,aux,dataset-aux,image-classification,imagenet-aux*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get aux dataset-aux image-classification imagenet-aux" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,aux,dataset-aux,image-classification,imagenet-aux`
-#### Run this script from command line
+`cm run script --tags=get,aux,dataset-aux,image-classification,imagenet-aux[,variations] `
-1. `cm run script --tags=get,aux,dataset-aux,image-classification,imagenet-aux[,variations] `
+*or*
-2. `cmr "get aux dataset-aux image-classification imagenet-aux[ variations]" `
+`cmr "get aux dataset-aux image-classification imagenet-aux"`
-* `variations` can be seen [here](#variations)
+`cmr "get aux dataset-aux image-classification imagenet-aux [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,aux,dataset-aux,im
#### Run this script via Docker (beta)
-`cm docker script "get aux dataset-aux image-classification imagenet-aux[ variations]" `
+`cm docker script "get aux dataset-aux image-classification imagenet-aux[variations]" `
___
### Customization
@@ -138,31 +135,23 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-aux/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-aux/_cm.json)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-aux/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-aux/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-aux/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-aux/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-aux/_cm.json)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-aux/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-aux/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-aux/_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/get-dataset-imagenet-aux/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-aux/_cm.json)
___
### Script output
-`cmr "get aux dataset-aux image-classification imagenet-aux[,variations]" -j`
+`cmr "get aux dataset-aux image-classification imagenet-aux [,variations]" -j`
#### New environment keys (filter)
* `CM_DATASET_AUX_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-dataset-imagenet-calibration/README.md b/cm-mlops/script/get-dataset-imagenet-calibration/README.md
index 2c1df58df5..c90dd01b73 100644
--- a/cm-mlops/script/get-dataset-imagenet-calibration/README.md
+++ b/cm-mlops/script/get-dataset-imagenet-calibration/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-dataset-imagenet-calibration**
-
+Category: **AI/ML datasets**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-dataset-imagenet-calibration,30361fad3dff49ff) ]*
+---
#### Summary
-* 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-dataset-imagenet-calibration)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-calibration)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *get,dataset,imagenet,calibration*
+* All CM tags to find and reuse this script (see in above meta description): *get,dataset,imagenet,calibration*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get dataset imagenet calibration" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,dataset,imagenet,calibration`
-#### Run this script from command line
+`cm run script --tags=get,dataset,imagenet,calibration[,variations] `
-1. `cm run script --tags=get,dataset,imagenet,calibration[,variations] `
+*or*
-2. `cmr "get dataset imagenet calibration[ variations]" `
+`cmr "get dataset imagenet calibration"`
-* `variations` can be seen [here](#variations)
+`cmr "get dataset imagenet calibration [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,dataset,imagenet,c
#### Run this script via Docker (beta)
-`cm docker script "get dataset imagenet calibration[ variations]" `
+`cm docker script "get dataset imagenet calibration[variations]" `
___
### Customization
@@ -128,32 +125,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-calibration/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-calibration/_cm.yaml)***
* download,file
* CM names: `--adr.['calibration-file-downloader']...`
- CM script: [download-file](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-file)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-calibration/_cm.yaml)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-calibration/_cm.yaml)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-calibration/_cm.yaml)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-calibration/_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/get-dataset-imagenet-calibration/_cm.yaml)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-calibration/_cm.yaml)
___
### Script output
-`cmr "get dataset imagenet calibration[,variations]" -j`
+`cmr "get dataset imagenet calibration [,variations]" -j`
#### New environment keys (filter)
* `CM_MLPERF_IMAGENET_CALIBRATION_LIST_FILE_WITH_PATH`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-dataset-imagenet-helper/README.md b/cm-mlops/script/get-dataset-imagenet-helper/README.md
index 9240fa0494..08677f4e41 100644
--- a/cm-mlops/script/get-dataset-imagenet-helper/README.md
+++ b/cm-mlops/script/get-dataset-imagenet-helper/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-dataset-imagenet-helper**
-
+Category: **AI/ML datasets**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-dataset-imagenet-helper,a6c3c321d07742f9) ]*
+---
#### Summary
-* 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-dataset-imagenet-helper)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-helper)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,imagenet,helper,imagenet-helper*
+* All CM tags to find and reuse this script (see in above meta description): *get,imagenet,helper,imagenet-helper*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get imagenet helper imagenet-helper" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,imagenet,helper,imagenet-helper`
-#### Run this script from command line
+`cm run script --tags=get,imagenet,helper,imagenet-helper `
-1. `cm run script --tags=get,imagenet,helper,imagenet-helper `
+*or*
+
+`cmr "get imagenet helper imagenet-helper"`
+
+`cmr "get imagenet helper imagenet-helper " `
-2. `cmr "get imagenet helper imagenet-helper" `
#### Run this script from Python
@@ -101,31 +99,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-helper/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-helper/_cm.json)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-helper/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-helper/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-helper/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-helper/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-helper/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-helper/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-helper/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-helper/_cm.json)
___
### Script output
-`cmr "get imagenet helper imagenet-helper" -j`
+`cmr "get imagenet helper imagenet-helper " -j`
#### New environment keys (filter)
* `+PYTHONPATH`
* `CM_DATASET_IMAGENET_HELPER_PATH`
#### New environment keys auto-detected from customize
-* `CM_DATASET_IMAGENET_HELPER_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_DATASET_IMAGENET_HELPER_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-dataset-imagenet-train/README.md b/cm-mlops/script/get-dataset-imagenet-train/README.md
index 3a7bb96b36..16a11007f5 100644
--- a/cm-mlops/script/get-dataset-imagenet-train/README.md
+++ b/cm-mlops/script/get-dataset-imagenet-train/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-dataset-imagenet-train**
-
+Category: **AI/ML datasets**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-dataset-imagenet-train,2bec165da5cc4ebf) ]*
+
+---
#### Summary
-* 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-dataset-imagenet-train)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-train)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,imagenet,train,dataset,original*
+* All CM tags to find and reuse this script (see in above meta description): *get,imagenet,train,dataset,original*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get imagenet train dataset original" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,imagenet,train,dataset,original`
-1. `cm run script --tags=get,imagenet,train,dataset,original [--input_flags]`
+`cm run script --tags=get,imagenet,train,dataset,original [--input_flags]`
-2. `cmr "get imagenet train dataset original" [--input_flags]`
+*or*
+
+`cmr "get imagenet train dataset original"`
+
+`cmr "get imagenet train dataset original " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -120,14 +115,12 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-train/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-train/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-train/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-train/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-train/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-train/_cm.json)***
* download-and-extract,file,_extract
* `if (CM_DATASET_IMAGENET_VAL_REQUIRE_DAE in ['yes', 'True'])`
- CM script: [download-and-extract](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-and-extract)
@@ -135,15 +128,14 @@ ___
* `if (CM_DAE_ONLY_EXTRACT in ['yes', 'True'])`
- CM script: [extract-file](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/extract-file)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-train/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-train/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-train/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-train/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-train/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-train/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-train/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-train/_cm.json)
___
### Script output
-`cmr "get imagenet train dataset original" [--input_flags] -j`
+`cmr "get imagenet train dataset original " [--input_flags] -j`
#### New environment keys (filter)
* `CM_DATASET_IMAGENET_*`
@@ -154,8 +146,4 @@ ___
* `CM_DATASET_IMAGENET_TRAIN_PATH`
* `CM_DATASET_IMAGENET_TRAIN_REQUIRE_DAE`
* `CM_DATASET_IMAGENET_VAL_REQUIRE_DAE`
-* `CM_DATASET_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_DATASET_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-dataset-imagenet-val/README.md b/cm-mlops/script/get-dataset-imagenet-val/README.md
index ba8175b6e3..818900346c 100644
--- a/cm-mlops/script/get-dataset-imagenet-val/README.md
+++ b/cm-mlops/script/get-dataset-imagenet-val/README.md
@@ -1,64 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-dataset-imagenet-val**
-*Note that this README is automatically generated - don't edit!*
+Category: **AI/ML datasets**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-dataset-imagenet-val,7afd58d287fe4f11) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* 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-dataset-imagenet-val)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-val)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,val,validation,dataset,imagenet,ILSVRC,image-classification,original*
+* All CM tags to find and reuse this script (see in above meta description): *get,val,validation,dataset,imagenet,ILSVRC,image-classification,original*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get val validation dataset imagenet ILSVRC image-classification original" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,val,validation,dataset,imagenet,ILSVRC,image-classification,original`
-1. `cm run script --tags=get,val,validation,dataset,imagenet,ILSVRC,image-classification,original[,variations] [--input_flags]`
+`cm run script --tags=get,val,validation,dataset,imagenet,ILSVRC,image-classification,original[,variations] [--input_flags]`
-2. `cmr "get val validation dataset imagenet ILSVRC image-classification original[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get val validation dataset imagenet ILSVRC image-classification original"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get val validation dataset imagenet ILSVRC image-classification original [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -94,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,val,validation,dat
#### Run this script via Docker (beta)
-`cm docker script "get val validation dataset imagenet ILSVRC image-classification original[ variations]" [--input_flags]`
+`cm docker script "get val validation dataset imagenet ILSVRC image-classification original[variations]" [--input_flags]`
___
### Customization
@@ -181,16 +172,14 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-val/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-val/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-val/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-val/_cm.json)***
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-val/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-val/_cm.json)***
* download-and-extract,file,_extract
* `if (CM_DATASET_IMAGENET_VAL_REQUIRE_DAE in ['yes', 'True'])`
- CM script: [download-and-extract](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-and-extract)
@@ -198,15 +187,14 @@ ___
* `if (CM_DAE_ONLY_EXTRACT in ['yes', 'True'])`
- CM script: [extract-file](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/extract-file)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-val/run.bat)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-val/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-val/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-val/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-val/run.bat)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-val/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-val/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-val/_cm.json)
___
### Script output
-`cmr "get val validation dataset imagenet ILSVRC image-classification original[,variations]" [--input_flags] -j`
+`cmr "get val validation dataset imagenet ILSVRC image-classification original [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_DATASET_IMAGENET_PATH`
@@ -218,8 +206,4 @@ ___
* `CM_DATASET_IMAGENET_PATH`
* `CM_DATASET_IMAGENET_VAL_PATH`
-* `CM_DATASET_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_DATASET_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-dataset-kits19/README.md b/cm-mlops/script/get-dataset-kits19/README.md
index be6ba3f0cf..b6f2057843 100644
--- a/cm-mlops/script/get-dataset-kits19/README.md
+++ b/cm-mlops/script/get-dataset-kits19/README.md
@@ -1,59 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ 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)
+Automatically generated README for this automation recipe: **get-dataset-kits19**
-
+Category: **AI/ML datasets**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-dataset-kits19,79992bb221024ac5) ]*
+
+---
#### Summary
-* 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-dataset-kits19)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-kits19)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,dataset,medical-imaging,kits,original,kits19*
+* All CM tags to find and reuse this script (see in above meta description): *get,dataset,medical-imaging,kits,original,kits19*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get dataset medical-imaging kits original kits19" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,dataset,medical-imaging,kits,original,kits19`
-1. `cm run script --tags=get,dataset,medical-imaging,kits,original,kits19[,variations] `
+`cm run script --tags=get,dataset,medical-imaging,kits,original,kits19[,variations] `
-2. `cmr "get dataset medical-imaging kits original kits19[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get dataset medical-imaging kits original kits19"`
+
+`cmr "get dataset medical-imaging kits original kits19 [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -89,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,dataset,medical-im
#### Run this script via Docker (beta)
-`cm docker script "get dataset medical-imaging kits original kits19[ variations]" `
+`cm docker script "get dataset medical-imaging kits original kits19[variations]" `
___
### Customization
@@ -153,33 +149,26 @@ Default version: `master`
* `custom`
* `master`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-kits19/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-kits19/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-kits19/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-kits19/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-kits19/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-kits19/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-kits19/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-kits19/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-kits19/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-kits19/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-kits19/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-kits19/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-kits19/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-kits19/_cm.json)
___
### Script output
-`cmr "get dataset medical-imaging kits original kits19[,variations]" -j`
+`cmr "get dataset medical-imaging kits original kits19 [,variations]" -j`
#### New environment keys (filter)
* `CM_DATASET_*`
#### New environment keys auto-detected from customize
-* `CM_DATASET_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_DATASET_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-dataset-librispeech/README.md b/cm-mlops/script/get-dataset-librispeech/README.md
index 96de3f7225..49ccb98cf6 100644
--- a/cm-mlops/script/get-dataset-librispeech/README.md
+++ b/cm-mlops/script/get-dataset-librispeech/README.md
@@ -1,59 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-dataset-librispeech**
-*Note that this README is automatically generated - don't edit!*
+Category: **AI/ML datasets**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-dataset-librispeech,09f29df607e0415d) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* 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-dataset-librispeech)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-librispeech)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,dataset,speech,speech-recognition,librispeech,validation,audio,training,original*
+* All CM tags to find and reuse this script (see in above meta description): *get,dataset,speech,speech-recognition,librispeech,validation,audio,training,original*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get dataset speech speech-recognition librispeech validation audio training original" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,dataset,speech,speech-recognition,librispeech,validation,audio,training,original`
-1. `cm run script --tags=get,dataset,speech,speech-recognition,librispeech,validation,audio,training,original `
+`cm run script --tags=get,dataset,speech,speech-recognition,librispeech,validation,audio,training,original `
+
+*or*
+
+`cmr "get dataset speech speech-recognition librispeech validation audio training original"`
+
+`cmr "get dataset speech speech-recognition librispeech validation audio training original " `
-2. `cmr "get dataset speech speech-recognition librispeech validation audio training original" `
#### Run this script from Python
@@ -115,35 +109,28 @@ Default version: `dev-clean`
* `train-clean-360`
* `train-other-500`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-librispeech/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-librispeech/_cm.json)***
* get,sys-utils-cm
* CM names: `--adr.['sys-utils']...`
- CM script: [get-sys-utils-cm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-librispeech/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-librispeech/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-librispeech/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-librispeech/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-librispeech/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-librispeech/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-librispeech/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-librispeech/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-librispeech/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-librispeech/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-librispeech/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-librispeech/_cm.json)
___
### Script output
-`cmr "get dataset speech speech-recognition librispeech validation audio training original" -j`
+`cmr "get dataset speech speech-recognition librispeech validation audio training original " -j`
#### New environment keys (filter)
* `CM_DATASET_*`
#### New environment keys auto-detected from customize
* `CM_DATASET_LIBRISPEECH_PATH`
-* `CM_DATASET_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_DATASET_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-dataset-openimages-annotations/README.md b/cm-mlops/script/get-dataset-openimages-annotations/README.md
index 1fcef83fb5..d7d1e4a991 100644
--- a/cm-mlops/script/get-dataset-openimages-annotations/README.md
+++ b/cm-mlops/script/get-dataset-openimages-annotations/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-dataset-openimages-annotations**
-
+Category: **AI/ML datasets**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-dataset-openimages-annotations,47e2158ed24c44e9) ]*
+
+---
#### Summary
-* 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-dataset-openimages-annotations)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages-annotations)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,aux,dataset-aux,object-detection,openimages,annotations*
+* All CM tags to find and reuse this script (see in above meta description): *get,aux,dataset-aux,object-detection,openimages,annotations*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get aux dataset-aux object-detection openimages annotations" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,aux,dataset-aux,object-detection,openimages,annotations`
-1. `cm run script --tags=get,aux,dataset-aux,object-detection,openimages,annotations[,variations] `
+`cm run script --tags=get,aux,dataset-aux,object-detection,openimages,annotations[,variations] `
-2. `cmr "get aux dataset-aux object-detection openimages annotations[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get aux dataset-aux object-detection openimages annotations"`
+
+`cmr "get aux dataset-aux object-detection openimages annotations [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,aux,dataset-aux,ob
#### Run this script via Docker (beta)
-`cm docker script "get aux dataset-aux object-detection openimages annotations[ variations]" `
+`cm docker script "get aux dataset-aux object-detection openimages annotations[variations]" `
___
### Customization
@@ -122,24 +119,21 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages-annotations/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages-annotations/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages-annotations/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages-annotations/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages-annotations/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages-annotations/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages-annotations/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages-annotations/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages-annotations/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages-annotations/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages-annotations/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages-annotations/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages-annotations/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages-annotations/_cm.json)
___
### Script output
-`cmr "get aux dataset-aux object-detection openimages annotations[,variations]" -j`
+`cmr "get aux dataset-aux object-detection openimages annotations [,variations]" -j`
#### New environment keys (filter)
* `CM_DATASET_ANNOTATIONS_*`
@@ -149,8 +143,4 @@ ___
* `CM_DATASET_ANNOTATIONS_DIR_PATH`
* `CM_DATASET_ANNOTATIONS_FILE_PATH`
* `CM_DATASET_OPENIMAGES_ANNOTATIONS_DIR_PATH`
-* `CM_DATASET_OPENIMAGES_ANNOTATIONS_FILE_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_DATASET_OPENIMAGES_ANNOTATIONS_FILE_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-dataset-openimages-calibration/README.md b/cm-mlops/script/get-dataset-openimages-calibration/README.md
index 053cbb230d..bfaf9cb03a 100644
--- a/cm-mlops/script/get-dataset-openimages-calibration/README.md
+++ b/cm-mlops/script/get-dataset-openimages-calibration/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-dataset-openimages-calibration**
-
+Category: **AI/ML datasets**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-dataset-openimages-calibration,27228976bb084dd0) ]*
+---
#### Summary
-* 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-dataset-openimages-calibration)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages-calibration)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *get,dataset,openimages,calibration*
+* All CM tags to find and reuse this script (see in above meta description): *get,dataset,openimages,calibration*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get dataset openimages calibration" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,dataset,openimages,calibration`
-#### Run this script from command line
+`cm run script --tags=get,dataset,openimages,calibration[,variations] `
-1. `cm run script --tags=get,dataset,openimages,calibration[,variations] `
+*or*
-2. `cmr "get dataset openimages calibration[ variations]" `
+`cmr "get dataset openimages calibration"`
-* `variations` can be seen [here](#variations)
+`cmr "get dataset openimages calibration [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,dataset,openimages
#### Run this script via Docker (beta)
-`cm docker script "get dataset openimages calibration[ variations]" `
+`cm docker script "get dataset openimages calibration[variations]" `
___
### Customization
@@ -157,34 +154,27 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages-calibration/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages-calibration/_cm.yaml)***
* download,file
* CM names: `--adr.['calibration-file-downloader']...`
- CM script: [download-file](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-file)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages-calibration/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages-calibration/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages-calibration/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages-calibration/_cm.yaml)
1. ***Run native script if exists***
- * [run-filter.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages-calibration/run-filter.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages-calibration/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages-calibration/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages-calibration/_cm.yaml)
-
+ * [run-filter.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages-calibration/run-filter.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages-calibration/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages-calibration/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages-calibration/_cm.yaml)
___
### Script output
-`cmr "get dataset openimages calibration[,variations]" -j`
+`cmr "get dataset openimages calibration [,variations]" -j`
#### New environment keys (filter)
* `CM_MLPERF_OPENIMAGES_CALIBRATION_LIST_FILE_WITH_PATH`
#### New environment keys auto-detected from customize
-* `CM_MLPERF_OPENIMAGES_CALIBRATION_LIST_FILE_WITH_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_MLPERF_OPENIMAGES_CALIBRATION_LIST_FILE_WITH_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-dataset-openimages/README.md b/cm-mlops/script/get-dataset-openimages/README.md
index 2de9f94507..6a2d88b0b6 100644
--- a/cm-mlops/script/get-dataset-openimages/README.md
+++ b/cm-mlops/script/get-dataset-openimages/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-dataset-openimages**
-*Note that this README is automatically generated - don't edit!*
+Category: **AI/ML datasets**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-dataset-openimages,0a9d49b644cf4142) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* 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-dataset-openimages)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,dataset,openimages,open-images,object-detection,original*
+* All CM tags to find and reuse this script (see in above meta description): *get,dataset,openimages,open-images,object-detection,original*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get dataset openimages open-images object-detection original" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,dataset,openimages,open-images,object-detection,original`
-#### Run this script from command line
+`cm run script --tags=get,dataset,openimages,open-images,object-detection,original[,variations] `
-1. `cm run script --tags=get,dataset,openimages,open-images,object-detection,original[,variations] `
+*or*
-2. `cmr "get dataset openimages open-images object-detection original[ variations]" `
+`cmr "get dataset openimages open-images object-detection original"`
-* `variations` can be seen [here](#variations)
+`cmr "get dataset openimages open-images object-detection original [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,dataset,openimages
#### Run this script via Docker (beta)
-`cm docker script "get dataset openimages open-images object-detection original[ variations]" `
+`cm docker script "get dataset openimages open-images object-detection original[variations]" `
___
### Customization
@@ -195,12 +189,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages/_cm.json)***
* get,sys-utils-cm
- CM script: [get-sys-utils-cm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm)
* get,python3
@@ -224,22 +216,21 @@ ___
* get,generic-python-lib,_pycocotools
* CM names: `--adr.['pycocotools']...`
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages/run.sh)
- 1. ***Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages/_cm.json)***
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages/run.sh)
+ 1. ***Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages/_cm.json)***
* get,openimages,annotations
* `if (CM_DATASET_OPENIMAGES_CUSTOM_ANNOTATIONS == yes)`
- CM script: [get-dataset-openimages-annotations](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages-annotations)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages/_cm.json)
-
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages/_cm.json)
___
### Script output
-`cmr "get dataset openimages open-images object-detection original[,variations]" -j`
+`cmr "get dataset openimages open-images object-detection original [,variations]" -j`
#### New environment keys (filter)
* `CM_CALIBRATION_DATASET_PATH`
@@ -257,8 +248,4 @@ ___
* `CM_DATASET_CALIBRATION_ANNOTATIONS_FILE_PATH`
* `CM_DATASET_PATH`
* `CM_DATASET_PATH_ROOT`
-* `CM_DATASET_VALIDATION_ANNOTATIONS_FILE_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_DATASET_VALIDATION_ANNOTATIONS_FILE_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-dataset-openorca/README.md b/cm-mlops/script/get-dataset-openorca/README.md
index fb813530f1..8f64bb3ee1 100644
--- a/cm-mlops/script/get-dataset-openorca/README.md
+++ b/cm-mlops/script/get-dataset-openorca/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-dataset-openorca**
-
+Category: **AI/ML datasets**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-dataset-openorca,9252c4d90d5940b7) ]*
+
+---
#### Summary
-* 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-dataset-openorca)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openorca)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,dataset,openorca,language-processing,original*
+* All CM tags to find and reuse this script (see in above meta description): *get,dataset,openorca,language-processing,original*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get dataset openorca language-processing original" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,dataset,openorca,language-processing,original`
-1. `cm run script --tags=get,dataset,openorca,language-processing,original[,variations] `
+`cm run script --tags=get,dataset,openorca,language-processing,original[,variations] `
-2. `cmr "get dataset openorca language-processing original[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get dataset openorca language-processing original"`
+
+`cmr "get dataset openorca language-processing original [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,dataset,openorca,l
#### Run this script via Docker (beta)
-`cm docker script "get dataset openorca language-processing original[ variations]" `
+`cm docker script "get dataset openorca language-processing original[variations]" `
___
### Customization
@@ -151,26 +148,23 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openorca/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openorca/_cm.json)***
* get,git,repo,_lfs,_repo.https://huggingface.co/datasets/Open-Orca/OpenOrca
* CM names: `--adr.['openorca-src']...`
- 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-dataset-openorca/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openorca/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openorca/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openorca/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openorca/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openorca/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openorca/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openorca/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openorca/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openorca/_cm.json)
___
### Script output
-`cmr "get dataset openorca language-processing original[,variations]" -j`
+`cmr "get dataset openorca language-processing original [,variations]" -j`
#### New environment keys (filter)
* `CM_DATASET_*`
@@ -178,8 +172,4 @@ ___
* `CM_DATASET_OPENORCA_PARQUET`
* `CM_DATASET_PATH`
-* `CM_DATASET_PATH_ROOT`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_DATASET_PATH_ROOT`
\ No newline at end of file
diff --git a/cm-mlops/script/get-dataset-squad-vocab/README.md b/cm-mlops/script/get-dataset-squad-vocab/README.md
index 4e399264d0..fa6bb057af 100644
--- a/cm-mlops/script/get-dataset-squad-vocab/README.md
+++ b/cm-mlops/script/get-dataset-squad-vocab/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-dataset-squad-vocab**
-
+Category: **AI/ML datasets**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-dataset-squad-vocab,e38874fff5094577) ]*
+---
#### Summary
-* 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-dataset-squad-vocab)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-squad-vocab)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,aux,dataset-aux,language-processing,squad-aux,vocab,squad-vocab*
+* All CM tags to find and reuse this script (see in above meta description): *get,aux,dataset-aux,language-processing,squad-aux,vocab,squad-vocab*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get aux dataset-aux language-processing squad-aux vocab squad-vocab" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,aux,dataset-aux,language-processing,squad-aux,vocab,squad-vocab`
-#### Run this script from command line
+`cm run script --tags=get,aux,dataset-aux,language-processing,squad-aux,vocab,squad-vocab[,variations] `
-1. `cm run script --tags=get,aux,dataset-aux,language-processing,squad-aux,vocab,squad-vocab[,variations] `
+*or*
-2. `cmr "get aux dataset-aux language-processing squad-aux vocab squad-vocab[ variations]" `
+`cmr "get aux dataset-aux language-processing squad-aux vocab squad-vocab"`
-* `variations` can be seen [here](#variations)
+`cmr "get aux dataset-aux language-processing squad-aux vocab squad-vocab [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,aux,dataset-aux,la
#### Run this script via Docker (beta)
-`cm docker script "get aux dataset-aux language-processing squad-aux vocab squad-vocab[ variations]" `
+`cm docker script "get aux dataset-aux language-processing squad-aux vocab squad-vocab[variations]" `
___
### Customization
@@ -122,24 +119,21 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-squad-vocab/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-squad-vocab/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-squad-vocab/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-squad-vocab/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-squad-vocab/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-squad-vocab/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-squad-vocab/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-squad-vocab/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-squad-vocab/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-squad-vocab/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-squad-vocab/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-squad-vocab/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-squad-vocab/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-squad-vocab/_cm.json)
___
### Script output
-`cmr "get aux dataset-aux language-processing squad-aux vocab squad-vocab[,variations]" -j`
+`cmr "get aux dataset-aux language-processing squad-aux vocab squad-vocab [,variations]" -j`
#### New environment keys (filter)
* `CM_DATASET_SQUAD_VOCAB_PATH`
@@ -147,8 +141,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_DATASET_SQUAD_VOCAB_PATH`
-* `CM_ML_MODEL_BERT_VOCAB_FILE_WITH_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_ML_MODEL_BERT_VOCAB_FILE_WITH_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-dataset-squad/README.md b/cm-mlops/script/get-dataset-squad/README.md
index f72ae84934..b2a3cc7b75 100644
--- a/cm-mlops/script/get-dataset-squad/README.md
+++ b/cm-mlops/script/get-dataset-squad/README.md
@@ -1,59 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-dataset-squad**
-*Note that this README is automatically generated - don't edit!*
+Category: **AI/ML datasets**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-dataset-squad,6651c119c3ae49b3) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* 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-dataset-squad)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-squad)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,dataset,squad,language-processing,validation,original*
+* All CM tags to find and reuse this script (see in above meta description): *get,dataset,squad,language-processing,validation,original*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get dataset squad language-processing validation original" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,dataset,squad,language-processing,validation,original`
-1. `cm run script --tags=get,dataset,squad,language-processing,validation,original `
+`cm run script --tags=get,dataset,squad,language-processing,validation,original `
+
+*or*
+
+`cmr "get dataset squad language-processing validation original"`
+
+`cmr "get dataset squad language-processing validation original " `
-2. `cmr "get dataset squad language-processing validation original" `
#### Run this script from Python
@@ -110,26 +104,23 @@ Default version: `1.1`
* `1.1`
* `2.0`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-squad/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-squad/_cm.json)***
* get,sys-utils-cm
- CM script: [get-sys-utils-cm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-squad/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-squad/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-squad/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-squad/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-squad/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-squad/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-squad/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-squad/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-squad/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-squad/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-squad/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-squad/_cm.json)
___
### Script output
-`cmr "get dataset squad language-processing validation original" -j`
+`cmr "get dataset squad language-processing validation original " -j`
#### New environment keys (filter)
* `CM_DATASET_*`
@@ -137,8 +128,4 @@ ___
* `CM_DATASET_PATH`
* `CM_DATASET_SQUAD_PATH`
-* `CM_DATASET_SQUAD_VAL_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_DATASET_SQUAD_VAL_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-dlrm-data-mlperf-inference/README.md b/cm-mlops/script/get-dlrm-data-mlperf-inference/README.md
index 8168310d50..04d466c8b5 100644
--- a/cm-mlops/script/get-dlrm-data-mlperf-inference/README.md
+++ b/cm-mlops/script/get-dlrm-data-mlperf-inference/README.md
@@ -1,60 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-dlrm-data-mlperf-inference**
-
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-dlrm-data-mlperf-inference,34bdfcd9c8364935) ]*
+---
#### Summary
-* 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-dlrm-data-mlperf-inference)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dlrm-data-mlperf-inference)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *get,dlrm,data,mlperf,inference*
+* All CM tags to find and reuse this script (see in above meta description): *get,dlrm,data,mlperf,inference*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get dlrm data mlperf inference" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,dlrm,data,mlperf,inference`
-#### Run this script from command line
+`cm run script --tags=get,dlrm,data,mlperf,inference[,variations] [--input_flags]`
-1. `cm run script --tags=get,dlrm,data,mlperf,inference[,variations] [--input_flags]`
+*or*
-2. `cmr "get dlrm data mlperf inference[ variations]" [--input_flags]`
+`cmr "get dlrm data mlperf inference"`
-* `variations` can be seen [here](#variations)
+`cmr "get dlrm data mlperf inference [variations]" [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -90,7 +83,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,dlrm,data,mlperf,i
#### Run this script via Docker (beta)
-`cm docker script "get dlrm data mlperf inference[ variations]" [--input_flags]`
+`cm docker script "get dlrm data mlperf inference[variations]" [--input_flags]`
___
### Customization
@@ -139,30 +132,22 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dlrm-data-mlperf-inference/_cm.yaml)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dlrm-data-mlperf-inference/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dlrm-data-mlperf-inference/_cm.yaml)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dlrm-data-mlperf-inference/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dlrm-data-mlperf-inference/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dlrm-data-mlperf-inference/_cm.yaml)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dlrm-data-mlperf-inference/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dlrm-data-mlperf-inference/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dlrm-data-mlperf-inference/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dlrm-data-mlperf-inference/_cm.yaml)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dlrm-data-mlperf-inference/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dlrm-data-mlperf-inference/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dlrm-data-mlperf-inference/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dlrm-data-mlperf-inference/_cm.yaml)
___
### Script output
-`cmr "get dlrm data mlperf inference[,variations]" [--input_flags] -j`
+`cmr "get dlrm data mlperf inference [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_DLRM_DATA_PATH`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-dlrm/README.md b/cm-mlops/script/get-dlrm/README.md
index 289d8c7feb..9bda041d33 100644
--- a/cm-mlops/script/get-dlrm/README.md
+++ b/cm-mlops/script/get-dlrm/README.md
@@ -1,62 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ 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)
-
-
+Automatically generated README for this automation recipe: **get-dlrm**
-*Note that this README is automatically generated - don't edit!*
+Category: **AI/ML models**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-dlrm,63680ac2449a4241) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *AI/ML models.*
-* 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-dlrm)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dlrm)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,src,dlrm*
+* All CM tags to find and reuse this script (see in above meta description): *get,src,dlrm*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get src dlrm" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,src,dlrm`
-#### Run this script from command line
+`cm run script --tags=get,src,dlrm[,variations] `
-1. `cm run script --tags=get,src,dlrm[,variations] `
+*or*
-2. `cmr "get src dlrm[ variations]" `
+`cmr "get src dlrm"`
-* `variations` can be seen [here](#variations)
+`cmr "get src dlrm [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -92,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,src,dlrm) to gener
#### Run this script via Docker (beta)
-`cm docker script "get src dlrm[ variations]" `
+`cm docker script "get src dlrm[variations]" `
___
### Customization
@@ -129,32 +122,24 @@ Default version: `main`
* `main`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dlrm/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dlrm/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dlrm/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dlrm/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dlrm/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dlrm/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dlrm/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dlrm/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dlrm/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dlrm/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dlrm/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dlrm/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dlrm/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dlrm/_cm.json)
___
### Script output
-`cmr "get src dlrm[,variations]" -j`
+`cmr "get src dlrm [,variations]" -j`
#### New environment keys (filter)
* `DLRM_DIR`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-docker/README.md b/cm-mlops/script/get-docker/README.md
index 91f75adc4d..21a5b48883 100644
--- a/cm-mlops/script/get-docker/README.md
+++ b/cm-mlops/script/get-docker/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-docker**
-
+Category: **Detection or installation of tools and artifacts**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-docker,6192accce4234084) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-docker)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-docker)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,install,docker,engine*
+* All CM tags to find and reuse this script (see in above meta description): *get,install,docker,engine*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get install docker engine" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,install,docker,engine`
-#### Run this script from command line
+`cm run script --tags=get,install,docker,engine `
-1. `cm run script --tags=get,install,docker,engine `
+*or*
+
+`cmr "get install docker engine"`
+
+`cmr "get install docker engine " `
-2. `cmr "get install docker engine" `
#### Run this script from Python
@@ -101,31 +99,23 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-docker/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-docker/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-docker/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-docker/_cm.json)
1. ***Run native script if exists***
- * [run-ubuntu.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-docker/run-ubuntu.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-docker/_cm.json)
+ * [run-ubuntu.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-docker/run-ubuntu.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-docker/_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/get-docker/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-docker/_cm.json)
___
### Script output
-`cmr "get install docker engine" -j`
+`cmr "get install docker engine " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-gcc/README.md b/cm-mlops/script/get-gcc/README.md
index 71c43dedf6..be1a5a1069 100644
--- a/cm-mlops/script/get-gcc/README.md
+++ b/cm-mlops/script/get-gcc/README.md
@@ -1,60 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-gcc**
-*Note that this README is automatically generated - don't edit!*
+Category: **Compiler automation**
-### About
+License: **Apache 2.0**
-*Detect or install GCC compiler.*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-gcc,dbf4ab5cbed74372) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
-See extra [notes](README-extra.md) from the authors and contributors.
-
+---
#### Summary
-* Category: *Compiler automation.*
-* 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-gcc)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-gcc)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,gcc,compiler,c-compiler,cpp-compiler,get-gcc*
+* All CM tags to find and reuse this script (see in above meta description): *get,gcc,compiler,c-compiler,cpp-compiler,get-gcc*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get gcc compiler c-compiler cpp-compiler get-gcc" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,gcc,compiler,c-compiler,cpp-compiler,get-gcc`
-1. `cm run script --tags=get,gcc,compiler,c-compiler,cpp-compiler,get-gcc `
+`cm run script --tags=get,gcc,compiler,c-compiler,cpp-compiler,get-gcc `
+
+*or*
+
+`cmr "get gcc compiler c-compiler cpp-compiler get-gcc"`
+
+`cmr "get gcc compiler c-compiler cpp-compiler get-gcc " `
-2. `cmr "get gcc compiler c-compiler cpp-compiler get-gcc" `
#### Run this script from Python
@@ -106,29 +99,26 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-gcc/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-gcc/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-gcc/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-gcc/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-gcc/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-gcc/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-gcc/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-gcc/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-gcc/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-gcc/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-gcc/_cm.json)***
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-gcc/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-gcc/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-gcc/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-gcc/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-gcc/_cm.json)***
* get,compiler-flags
- CM script: [get-compiler-flags](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-compiler-flags)
-
___
### Script output
-`cmr "get gcc compiler c-compiler cpp-compiler get-gcc" -j`
+`cmr "get gcc compiler c-compiler cpp-compiler get-gcc " -j`
#### New environment keys (filter)
* `+ CFLAGS`
@@ -163,8 +153,4 @@ ___
* `CM_GCC_INSTALLED_PATH`
* `CM_LINKER_FLAGS_DEBUG`
* `CM_LINKER_FLAGS_DEFAULT`
-* `CM_LINKER_FLAGS_FAST`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_LINKER_FLAGS_FAST`
\ No newline at end of file
diff --git a/cm-mlops/script/get-generic-python-lib/README.md b/cm-mlops/script/get-generic-python-lib/README.md
index 109df4b194..440b0787a3 100644
--- a/cm-mlops/script/get-generic-python-lib/README.md
+++ b/cm-mlops/script/get-generic-python-lib/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-generic-python-lib**
-*Note that this README is automatically generated - don't edit!*
+Category: **Python automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-generic-python-lib,94b62a682bc44791) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Python automation.*
-* 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-generic-python-lib)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-generic-python-lib)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,generic-python-lib*
+* All CM tags to find and reuse this script (see in above meta description): *get,generic-python-lib*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get generic-python-lib" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,generic-python-lib`
-#### Run this script from command line
+`cm run script --tags=get,generic-python-lib[,variations] `
-1. `cm run script --tags=get,generic-python-lib[,variations] `
+*or*
-2. `cmr "get generic-python-lib[ variations]" `
+`cmr "get generic-python-lib"`
-* `variations` can be seen [here](#variations)
+`cmr "get generic-python-lib [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,generic-python-lib
#### Run this script via Docker (beta)
-`cm docker script "get generic-python-lib[ variations]" `
+`cm docker script "get generic-python-lib[variations]" `
___
### Customization
@@ -631,12 +625,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-generic-python-lib/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -649,28 +641,22 @@ ___
* `if (CM_GENERIC_PYTHON_PACKAGE_NAME != pip)`
* CM names: `--adr.['python-pip', 'pip']...`
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib/_cm.json)***
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-generic-python-lib/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-generic-python-lib/_cm.json)***
* install,onnxruntime,from.src,_cuda
* `if (CM_INSTALL_ONNXRUNTIME_GPU_FROM_SRC == yes)`
- CM script: [install-onnxruntime-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-onnxruntime-from-src)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-generic-python-lib/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-generic-python-lib/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-generic-python-lib/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-generic-python-lib/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-generic-python-lib/_cm.json)
___
### Script output
-`cmr "get generic-python-lib[,variations]" -j`
+`cmr "get generic-python-lib [,variations]" -j`
#### New environment keys (filter)
* `CM_PYTHONLIB_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-generic-sys-util/README.md b/cm-mlops/script/get-generic-sys-util/README.md
index ef5bd0c549..856695c4c6 100644
--- a/cm-mlops/script/get-generic-sys-util/README.md
+++ b/cm-mlops/script/get-generic-sys-util/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-generic-sys-util**
-
+Category: **Detection or installation of tools and artifacts**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-generic-sys-util,bb0393afa8404a11) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-generic-sys-util)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-generic-sys-util)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,sys-util,generic,generic-sys-util*
+* All CM tags to find and reuse this script (see in above meta description): *get,sys-util,generic,generic-sys-util*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get sys-util generic generic-sys-util" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,sys-util,generic,generic-sys-util`
-#### Run this script from command line
+`cm run script --tags=get,sys-util,generic,generic-sys-util[,variations] `
-1. `cm run script --tags=get,sys-util,generic,generic-sys-util[,variations] `
+*or*
-2. `cmr "get sys-util generic generic-sys-util[ variations]" `
+`cmr "get sys-util generic generic-sys-util"`
-* `variations` can be seen [here](#variations)
+`cmr "get sys-util generic generic-sys-util [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,sys-util,generic,g
#### Run this script via Docker (beta)
-`cm docker script "get sys-util generic generic-sys-util[ variations]" `
+`cm docker script "get sys-util generic generic-sys-util[variations]" `
___
### Customization
@@ -208,32 +205,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-sys-util/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-generic-sys-util/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-sys-util/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-sys-util/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-generic-sys-util/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-generic-sys-util/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-sys-util/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-sys-util/_cm.json)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-generic-sys-util/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-generic-sys-util/_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/get-generic-sys-util/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-generic-sys-util/_cm.json)
___
### Script output
-`cmr "get sys-util generic generic-sys-util[,variations]" -j`
+`cmr "get sys-util generic generic-sys-util [,variations]" -j`
#### New environment keys (filter)
* `+PATH`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-git-repo/README.md b/cm-mlops/script/get-git-repo/README.md
index 966174fcc0..3c55e2b4a0 100644
--- a/cm-mlops/script/get-git-repo/README.md
+++ b/cm-mlops/script/get-git-repo/README.md
@@ -1,64 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-git-repo**
-*Note that this README is automatically generated - don't edit!*
+Category: **DevOps automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-git-repo,ed603e7292974f10) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *DevOps automation.*
-* 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-git-repo)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-git-repo)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,git,repo,repository,clone*
+* All CM tags to find and reuse this script (see in above meta description): *get,git,repo,repository,clone*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get git repo repository clone" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,git,repo,repository,clone`
-1. `cm run script --tags=get,git,repo,repository,clone[,variations] [--input_flags]`
+`cm run script --tags=get,git,repo,repository,clone[,variations] [--input_flags]`
-2. `cmr "get git repo repository clone[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get git repo repository clone"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get git repo repository clone [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -94,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,git,repo,repositor
#### Run this script via Docker (beta)
-`cm docker script "get git repo repository clone[ variations]" [--input_flags]`
+`cm docker script "get git repo repository clone[variations]" [--input_flags]`
___
### Customization
@@ -217,31 +208,28 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-git-repo/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-git-repo/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-git-repo/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo/_cm.json)***
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-git-repo/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-git-repo/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-git-repo/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-git-repo/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-git-repo/_cm.json)***
* pull,git,repo
* `if (CM_GIT_REPO_PULL in ['yes', 'True'])`
* CM names: `--adr.['pull-git-repo']...`
- CM script: [pull-git-repo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/pull-git-repo)
-
___
### Script output
-`cmr "get git repo repository clone[,variations]" [--input_flags] -j`
+`cmr "get git repo repository clone [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `<<>>`
@@ -250,8 +238,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_GIT_CHECKOUT_PATH`
-* `CM_GIT_REPO_CURRENT_HASH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_GIT_REPO_CURRENT_HASH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-github-cli/README.md b/cm-mlops/script/get-github-cli/README.md
index e75fd16220..2ed8ebd7f7 100644
--- a/cm-mlops/script/get-github-cli/README.md
+++ b/cm-mlops/script/get-github-cli/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-github-cli**
-
+Category: **DevOps automation**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-github-cli,1417029c6ff44f21) ]*
+---
#### Summary
-* Category: *DevOps automation.*
-* 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-github-cli)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-github-cli)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,gh,gh-cli,github,cli,github-cli*
+* All CM tags to find and reuse this script (see in above meta description): *get,gh,gh-cli,github,cli,github-cli*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get gh gh-cli github cli github-cli" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,gh,gh-cli,github,cli,github-cli`
-#### Run this script from command line
+`cm run script --tags=get,gh,gh-cli,github,cli,github-cli `
-1. `cm run script --tags=get,gh,gh-cli,github,cli,github-cli `
+*or*
+
+`cmr "get gh gh-cli github cli github-cli"`
+
+`cmr "get gh gh-cli github cli github-cli " `
-2. `cmr "get gh gh-cli github cli github-cli" `
#### Run this script from Python
@@ -101,32 +99,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-github-cli/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-github-cli/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-github-cli/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-github-cli/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-github-cli/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-github-cli/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-github-cli/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-github-cli/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-github-cli/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-github-cli/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-github-cli/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-github-cli/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-github-cli/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-github-cli/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-github-cli/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-github-cli/_cm.json)
___
### Script output
-`cmr "get gh gh-cli github cli github-cli" -j`
+`cmr "get gh gh-cli github cli github-cli " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-go/README.md b/cm-mlops/script/get-go/README.md
index 19e46f6a8e..a0faecd0a6 100644
--- a/cm-mlops/script/get-go/README.md
+++ b/cm-mlops/script/get-go/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-go**
-*Note that this README is automatically generated - don't edit!*
+Category: **Compiler automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-go,ab42647a96724a25) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Compiler automation.*
-* 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-go)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-go)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,tool,go,get-go*
+* All CM tags to find and reuse this script (see in above meta description): *get,tool,go,get-go*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get tool go get-go" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,tool,go,get-go`
-1. `cm run script --tags=get,tool,go,get-go `
+`cm run script --tags=get,tool,go,get-go `
+
+*or*
+
+`cmr "get tool go get-go"`
+
+`cmr "get tool go get-go " `
-2. `cmr "get tool go get-go" `
#### Run this script from Python
@@ -104,27 +99,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-go/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-go/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-go/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-go/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-go/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-go/_cm.json)***
* install,go
* `if (CM_REQUIRE_INSTALL == yes)`
- *Warning: no scripts found*
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-go/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-go/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-go/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-go/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-go/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-go/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-go/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-go/_cm.json)
___
### Script output
-`cmr "get tool go get-go" -j`
+`cmr "get tool go get-go " -j`
#### New environment keys (filter)
* `+PATH`
@@ -132,8 +124,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_GO_CACHE_TAGS`
-* `CM_GO_INSTALLED_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_GO_INSTALLED_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-google-saxml/README.md b/cm-mlops/script/get-google-saxml/README.md
index 792f335825..5c85d56970 100644
--- a/cm-mlops/script/get-google-saxml/README.md
+++ b/cm-mlops/script/get-google-saxml/README.md
@@ -1,56 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
+Automatically generated README for this automation recipe: **get-google-saxml**
-
+Category: **AI/ML frameworks**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-google-saxml,5d7b17d84b5a48fb) ]*
+---
#### 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 GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/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*
+* All CM tags to find and reuse this script (see in above meta description): *get,google,saxml*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get google saxml" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,google,saxml`
-#### Run this script from command line
+`cm run script --tags=get,google,saxml `
-1. `cm run script --tags=get,google,saxml `
+*or*
+
+`cmr "get google saxml"`
+
+`cmr "get google saxml " `
-2. `cmr "get google saxml" `
#### Run this script from Python
@@ -105,12 +102,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
Default version: `master`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-google-saxml/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/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
@@ -122,25 +117,19 @@ ___
* 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 "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-google-saxml/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/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)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-google-saxml/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-google-saxml/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-google-saxml/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-google-saxml/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-google-saxml/_cm.yaml)
___
### Script output
-`cmr "get google saxml" -j`
+`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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-google-test/README.md b/cm-mlops/script/get-google-test/README.md
index c1c7949f2d..dd85ed19f9 100644
--- a/cm-mlops/script/get-google-test/README.md
+++ b/cm-mlops/script/get-google-test/README.md
@@ -1,56 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
+Automatically generated README for this automation recipe: **get-google-test**
-
+Category: **Detection or installation of tools and artifacts**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-google-test,02945138a5614253) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-test)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-google-test)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,google-test,googletest,gtest,test,google*
+* All CM tags to find and reuse this script (see in above meta description): *get,google-test,googletest,gtest,test,google*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get google-test googletest gtest test google" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,google-test,googletest,gtest,test,google`
-#### Run this script from command line
+`cm run script --tags=get,google-test,googletest,gtest,test,google `
-1. `cm run script --tags=get,google-test,googletest,gtest,test,google `
+*or*
+
+`cmr "get google-test googletest gtest test google"`
+
+`cmr "get google-test googletest gtest test google " `
-2. `cmr "get google-test googletest gtest test google" `
#### Run this script from Python
@@ -105,12 +102,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
Default version: `1.14.0`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-google-test/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-google-test/_cm.json)***
* get,cmake
* CM names: `--adr.['cmake']...`
- CM script: [get-cmake](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmake)
@@ -119,20 +114,19 @@ ___
- CM script: [get-cl](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cl)
- CM script: [get-gcc](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-gcc)
- CM script: [get-llvm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-llvm)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-google-test/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-google-test/_cm.json)***
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-google-test/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-google-test/_cm.json)***
* get,git,repo,_repo.https://github.com/google/googletest.git
- CM script: [get-git-repo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-google-test/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-google-test/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-google-test/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-google-test/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-google-test/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-google-test/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-google-test/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-google-test/_cm.json)
___
### Script output
-`cmr "get google-test googletest gtest test google" -j`
+`cmr "get google-test googletest gtest test google " -j`
#### New environment keys (filter)
* `+C_INCLUDE_PATH`
@@ -142,8 +136,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_GOOGLE_TEST_INSTALL_PATH`
-* `CM_GOOGLE_TEST_SRC_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_GOOGLE_TEST_SRC_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-ipol-src/README.md b/cm-mlops/script/get-ipol-src/README.md
index a2f62c21c9..7bf5029dff 100644
--- a/cm-mlops/script/get-ipol-src/README.md
+++ b/cm-mlops/script/get-ipol-src/README.md
@@ -1,63 +1,65 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Input description](#input-description)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-ipol-src**
-*Note that this README is automatically generated - don't edit!*
+Category: **Reproducibility and artifact evaluation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-ipol-src,b6fd8213d03d4aa4) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Reproducibility and artifact evaluation.*
-* 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-ipol-src)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ipol-src)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,ipol,journal,src,ipol-src*
+* All CM tags to find and reuse this script (see in above meta description): *get,ipol,journal,src,ipol-src*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get ipol journal src ipol-src" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,ipol,journal,src,ipol-src`
-1. `cm run script --tags=get,ipol,journal,src,ipol-src [--input_flags]`
+`cm run script --tags=get,ipol,journal,src,ipol-src [--input_flags]`
-2. `cmr "get ipol journal src ipol-src" [--input_flags]`
+*or*
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get ipol journal src ipol-src"`
+`cmr "get ipol journal src ipol-src " [--input_flags]`
+
+
+
+#### Input Flags
+
+* --**number**=IPOL publication number
+* --**year**=IPOL publication year
+
+**Above CLI flags can be used in the Python CM API as follows:**
+
+```python
+r=cm.access({... , "number":...}
+```
#### Run this script from Python
@@ -98,17 +100,6 @@ ___
### Customization
-#### Input description
-
-* --**number** IPOL publication number
-* --**year** IPOL publication year
-
-**Above CLI flags can be used in the Python CM API as follows:**
-
-```python
-r=cm.access({... , "number":...}
-```
-
#### Script flags mapped to environment
Click here to expand this section.
@@ -135,30 +126,23 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ipol-src/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ipol-src/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ipol-src/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ipol-src/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ipol-src/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ipol-src/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ipol-src/_cm.json)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ipol-src/_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/get-ipol-src/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ipol-src/_cm.json)
___
### Script output
-`cmr "get ipol journal src ipol-src" [--input_flags] -j`
+`cmr "get ipol journal src ipol-src " [--input_flags] -j`
#### New environment keys (filter)
* `CM_IPOL_*`
#### New environment keys auto-detected from customize
-* `CM_IPOL_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_IPOL_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-java/README.md b/cm-mlops/script/get-java/README.md
index 82b0b6372b..602cf185fa 100644
--- a/cm-mlops/script/get-java/README.md
+++ b/cm-mlops/script/get-java/README.md
@@ -1,64 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-java**
-*Note that this README is automatically generated - don't edit!*
+Category: **Detection or installation of tools and artifacts**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-java,9399d0e785704f8c) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-java)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-java)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,java*
+* All CM tags to find and reuse this script (see in above meta description): *get,java*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get java" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,java`
-1. `cm run script --tags=get,java[,variations] [--input_flags]`
+`cm run script --tags=get,java[,variations] [--input_flags]`
-2. `cmr "get java[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get java"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get java [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -94,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,java) to generate
#### Run this script via Docker (beta)
-`cm docker script "get java[ variations]" [--input_flags]`
+`cm docker script "get java[variations]" [--input_flags]`
___
### Customization
@@ -143,27 +134,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-java/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-java/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-java/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-java/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-java/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-java/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-java/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-java/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-java/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-java/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-java/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-java/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-java/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-java/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-java/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-java/_cm.json)
___
### Script output
-`cmr "get java[,variations]" [--input_flags] -j`
+`cmr "get java [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `+PATH`
@@ -176,8 +164,4 @@ ___
* `CM_JAVA_PREBUILT_EXT`
* `CM_JAVA_PREBUILT_FILENAME`
* `CM_JAVA_PREBUILT_HOST_OS`
-* `CM_JAVA_PREBUILT_URL`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_JAVA_PREBUILT_URL`
\ No newline at end of file
diff --git a/cm-mlops/script/get-javac/README.md b/cm-mlops/script/get-javac/README.md
index 5a4a0fbb7b..127bb27bae 100644
--- a/cm-mlops/script/get-javac/README.md
+++ b/cm-mlops/script/get-javac/README.md
@@ -1,64 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-javac**
-*Note that this README is automatically generated - don't edit!*
+Category: **Detection or installation of tools and artifacts**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-javac,509280c497b24226) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-javac)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-javac)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,javac*
+* All CM tags to find and reuse this script (see in above meta description): *get,javac*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get javac" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,javac`
-1. `cm run script --tags=get,javac[,variations] [--input_flags]`
+`cm run script --tags=get,javac[,variations] [--input_flags]`
-2. `cmr "get javac[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get javac"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get javac [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -94,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,javac) to generate
#### Run this script via Docker (beta)
-`cm docker script "get javac[ variations]" [--input_flags]`
+`cm docker script "get javac[variations]" [--input_flags]`
___
### Customization
@@ -143,27 +134,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-javac/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-javac/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-javac/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-javac/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-javac/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-javac/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-javac/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-javac/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-javac/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-javac/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-javac/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-javac/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-javac/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-javac/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-javac/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-javac/_cm.json)
___
### Script output
-`cmr "get javac[,variations]" [--input_flags] -j`
+`cmr "get javac [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `+PATH`
@@ -179,8 +167,4 @@ ___
* `CM_JAVAC_PREBUILT_HOST_OS`
* `CM_JAVAC_PREBUILT_URL`
* `CM_JAVA_BIN`
-* `CM_JAVA_BIN_WITH_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_JAVA_BIN_WITH_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-lib-armnn/README.md b/cm-mlops/script/get-lib-armnn/README.md
index d1f1faf411..1a684dc406 100644
--- a/cm-mlops/script/get-lib-armnn/README.md
+++ b/cm-mlops/script/get-lib-armnn/README.md
@@ -1,56 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
+Automatically generated README for this automation recipe: **get-lib-armnn**
-
+Category: **Detection or installation of tools and artifacts**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-lib-armnn,9603a2e90fd44587) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-lib-armnn)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-armnn)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,lib-armnn,lib,armnn*
+* All CM tags to find and reuse this script (see in above meta description): *get,lib-armnn,lib,armnn*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get lib-armnn lib armnn" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,lib-armnn,lib,armnn`
-#### Run this script from command line
+`cm run script --tags=get,lib-armnn,lib,armnn `
-1. `cm run script --tags=get,lib-armnn,lib,armnn `
+*or*
+
+`cmr "get lib-armnn lib armnn"`
+
+`cmr "get lib-armnn lib armnn " `
-2. `cmr "get lib-armnn lib armnn" `
#### Run this script from Python
@@ -108,28 +105,25 @@ Default version: `23.11`
* `23.05`
* `23.11`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-armnn/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-armnn/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-armnn/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-armnn/_cm.json)***
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-armnn/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-armnn/_cm.json)***
* get,git,repo,_repo.https://github.com/ARM-software/armnn
- CM script: [get-git-repo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-armnn/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-armnn/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-armnn/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-armnn/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-armnn/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-armnn/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-armnn/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-armnn/_cm.json)
___
### Script output
-`cmr "get lib-armnn lib armnn" -j`
+`cmr "get lib-armnn lib armnn " -j`
#### New environment keys (filter)
* `+CPLUS_INCLUDE_PATH`
@@ -138,8 +132,3 @@ ___
* `CM_LIB_ARMNN_VERSION`
* `CM_LIB_DNNL_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-lib-dnnl/README.md b/cm-mlops/script/get-lib-dnnl/README.md
index 09b5293ea3..34296bad6d 100644
--- a/cm-mlops/script/get-lib-dnnl/README.md
+++ b/cm-mlops/script/get-lib-dnnl/README.md
@@ -1,56 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
+Automatically generated README for this automation recipe: **get-lib-dnnl**
-
+Category: **Detection or installation of tools and artifacts**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-lib-dnnl,1cd35a6a3b0b4530) ]*
+
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-lib-dnnl)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-dnnl)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,lib-dnnl,lib,dnnl*
+* All CM tags to find and reuse this script (see in above meta description): *get,lib-dnnl,lib,dnnl*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get lib-dnnl lib dnnl" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,lib-dnnl,lib,dnnl`
-1. `cm run script --tags=get,lib-dnnl,lib,dnnl `
+`cm run script --tags=get,lib-dnnl,lib,dnnl `
+
+*or*
+
+`cmr "get lib-dnnl lib dnnl"`
+
+`cmr "get lib-dnnl lib dnnl " `
-2. `cmr "get lib-dnnl lib dnnl" `
#### Run this script from Python
@@ -107,28 +104,25 @@ Default version: `dev`
* `2.2.4`
* `dev`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-dnnl/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-dnnl/_cm.json)***
* detect,cpu
- CM script: [detect-cpu](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
* cmake,get-cmake
- CM script: [get-cmake](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmake)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-dnnl/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-dnnl/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-dnnl/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-dnnl/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-dnnl/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-dnnl/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-dnnl/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-dnnl/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-dnnl/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-dnnl/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-dnnl/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-dnnl/_cm.json)
___
### Script output
-`cmr "get lib-dnnl lib dnnl" -j`
+`cmr "get lib-dnnl lib dnnl " -j`
#### New environment keys (filter)
* `+CPLUS_INCLUDE_PATH`
@@ -137,8 +131,4 @@ ___
* `CM_LIB_DNNL_*`
#### New environment keys auto-detected from customize
-* `CM_LIB_DNNL_INSTALL_DIR`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_LIB_DNNL_INSTALL_DIR`
\ No newline at end of file
diff --git a/cm-mlops/script/get-lib-protobuf/README.md b/cm-mlops/script/get-lib-protobuf/README.md
index b2365959f1..a679ead8b8 100644
--- a/cm-mlops/script/get-lib-protobuf/README.md
+++ b/cm-mlops/script/get-lib-protobuf/README.md
@@ -1,59 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ 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)
+Automatically generated README for this automation recipe: **get-lib-protobuf**
-
+Category: **Detection or installation of tools and artifacts**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-lib-protobuf,db45f1eb73934f91) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-lib-protobuf)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-protobuf)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,google-protobuf,protobuf,lib,lib-protobuf,google*
+* All CM tags to find and reuse this script (see in above meta description): *get,google-protobuf,protobuf,lib,lib-protobuf,google*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get google-protobuf protobuf lib lib-protobuf google" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,google-protobuf,protobuf,lib,lib-protobuf,google`
-#### Run this script from command line
+`cm run script --tags=get,google-protobuf,protobuf,lib,lib-protobuf,google[,variations] `
-1. `cm run script --tags=get,google-protobuf,protobuf,lib,lib-protobuf,google[,variations] `
+*or*
-2. `cmr "get google-protobuf protobuf lib lib-protobuf google[ variations]" `
+`cmr "get google-protobuf protobuf lib lib-protobuf google"`
-* `variations` can be seen [here](#variations)
+`cmr "get google-protobuf protobuf lib lib-protobuf google [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -89,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,google-protobuf,pr
#### Run this script via Docker (beta)
-`cm docker script "get google-protobuf protobuf lib lib-protobuf google[ variations]" `
+`cm docker script "get google-protobuf protobuf lib lib-protobuf google[variations]" `
___
### Customization
@@ -126,30 +122,27 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
Default version: `1.13.0`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-protobuf/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-protobuf/_cm.json)***
* get,cmake
- CM script: [get-cmake](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmake)
* get,gcc
- CM script: [get-gcc](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-gcc)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-protobuf/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-protobuf/_cm.json)***
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-protobuf/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-protobuf/_cm.json)***
* get,git,repo,_repo.https://github.com/google/protobuf.git
- CM script: [get-git-repo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-protobuf/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-protobuf/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-protobuf/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-protobuf/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-protobuf/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-protobuf/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-protobuf/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-protobuf/_cm.json)
___
### Script output
-`cmr "get google-protobuf protobuf lib lib-protobuf google[,variations]" -j`
+`cmr "get google-protobuf protobuf lib lib-protobuf google [,variations]" -j`
#### New environment keys (filter)
* `+CPLUS_INCLUDE_PATH`
@@ -160,8 +153,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_GOOGLE_PROTOBUF_INSTALL_PATH`
-* `CM_GOOGLE_PROTOBUF_SRC_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_GOOGLE_PROTOBUF_SRC_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-lib-qaic-api/README.md b/cm-mlops/script/get-lib-qaic-api/README.md
index 8f78e3090a..4929d95ba9 100644
--- a/cm-mlops/script/get-lib-qaic-api/README.md
+++ b/cm-mlops/script/get-lib-qaic-api/README.md
@@ -1,56 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
+Automatically generated README for this automation recipe: **get-lib-qaic-api**
-
+Category: **Detection or installation of tools and artifacts**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-lib-qaic-api,1e253ae184e44f23) ]*
+
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-lib-qaic-api)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-qaic-api)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,api,lib-qaic-api,lib,qaic*
+* All CM tags to find and reuse this script (see in above meta description): *get,api,lib-qaic-api,lib,qaic*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get api lib-qaic-api lib qaic" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,api,lib-qaic-api,lib,qaic`
-1. `cm run script --tags=get,api,lib-qaic-api,lib,qaic `
+`cm run script --tags=get,api,lib-qaic-api,lib,qaic `
+
+*or*
+
+`cmr "get api lib-qaic-api lib qaic"`
+
+`cmr "get api lib-qaic-api lib qaic " `
-2. `cmr "get api lib-qaic-api lib qaic" `
#### Run this script from Python
@@ -106,26 +103,23 @@ Default version: `master`
* `master`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-qaic-api/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-qaic-api/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-qaic-api/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-qaic-api/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-qaic-api/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-qaic-api/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-qaic-api/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-qaic-api/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-qaic-api/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-qaic-api/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-qaic-api/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-qaic-api/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-qaic-api/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-qaic-api/_cm.json)
___
### Script output
-`cmr "get api lib-qaic-api lib qaic" -j`
+`cmr "get api lib-qaic-api lib qaic " -j`
#### New environment keys (filter)
* `+CPLUS_INCLUDE_PATH`
@@ -136,8 +130,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_QAIC_API_INC_FILE`
-* `CM_QAIC_API_SRC_FILE`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_QAIC_API_SRC_FILE`
\ No newline at end of file
diff --git a/cm-mlops/script/get-llvm/README.md b/cm-mlops/script/get-llvm/README.md
index 4472cdf594..f7b9ae99bd 100644
--- a/cm-mlops/script/get-llvm/README.md
+++ b/cm-mlops/script/get-llvm/README.md
@@ -1,63 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-llvm**
-*Note that this README is automatically generated - don't edit!*
+Category: **Compiler automation**
-### About
+License: **Apache 2.0**
-*Detect or install LLVM compiler.*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-llvm,99832a103ed04eb8) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
-See extra [notes](README-extra.md) from the authors and contributors.
-
+---
#### Summary
-* Category: *Compiler automation.*
-* 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-llvm)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-llvm)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,llvm,compiler,c-compiler,cpp-compiler,get-llvm*
+* All CM tags to find and reuse this script (see in above meta description): *get,llvm,compiler,c-compiler,cpp-compiler,get-llvm*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get llvm compiler c-compiler cpp-compiler get-llvm" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,llvm,compiler,c-compiler,cpp-compiler,get-llvm`
-1. `cm run script --tags=get,llvm,compiler,c-compiler,cpp-compiler,get-llvm[,variations] `
+`cm run script --tags=get,llvm,compiler,c-compiler,cpp-compiler,get-llvm[,variations] `
-2. `cmr "get llvm compiler c-compiler cpp-compiler get-llvm[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get llvm compiler c-compiler cpp-compiler get-llvm"`
+
+`cmr "get llvm compiler c-compiler cpp-compiler get-llvm [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -93,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,llvm,compiler,c-co
#### Run this script via Docker (beta)
-`cm docker script "get llvm compiler c-compiler cpp-compiler get-llvm[ variations]" `
+`cm docker script "get llvm compiler c-compiler cpp-compiler get-llvm[variations]" `
___
### Customization
@@ -123,32 +115,29 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-llvm/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-llvm/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-llvm/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-llvm/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-llvm/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-llvm/_cm.json)***
* install,llvm
* `if (CM_REQUIRE_INSTALL == yes)`
* CM names: `--adr.llvm-install...`
- CM script: [install-llvm-prebuilt](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-llvm-prebuilt)
- CM script: [install-llvm-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-llvm-src)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-llvm/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-llvm/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-llvm/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-llvm/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-llvm/_cm.json)***
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-llvm/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-llvm/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-llvm/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-llvm/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-llvm/_cm.json)***
* get,compiler-flags
- CM script: [get-compiler-flags](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-compiler-flags)
-
___
### Script output
-`cmr "get llvm compiler c-compiler cpp-compiler get-llvm[,variations]" -j`
+`cmr "get llvm compiler c-compiler cpp-compiler get-llvm [,variations]" -j`
#### New environment keys (filter)
* `+ CFLAGS`
@@ -184,8 +173,4 @@ ___
* `CM_LINKER_FLAGS_DEFAULT`
* `CM_LINKER_FLAGS_FAST`
* `CM_LLVM_CLANG_BIN`
-* `CM_LLVM_CLANG_CACHE_TAGS`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_LLVM_CLANG_CACHE_TAGS`
\ No newline at end of file
diff --git a/cm-mlops/script/get-microtvm/README.md b/cm-mlops/script/get-microtvm/README.md
index 63823c994d..be63d376b7 100644
--- a/cm-mlops/script/get-microtvm/README.md
+++ b/cm-mlops/script/get-microtvm/README.md
@@ -1,65 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ 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)
-
-
+Automatically generated README for this automation recipe: **get-microtvm**
-*Note that this README is automatically generated - don't edit!*
+Category: **TinyML automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-microtvm,a9cad70972a140b9) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *TinyML automation.*
-* 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-microtvm)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-microtvm)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,src,source,microtvm,tiny*
+* All CM tags to find and reuse this script (see in above meta description): *get,src,source,microtvm,tiny*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get src source microtvm tiny" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,src,source,microtvm,tiny`
-1. `cm run script --tags=get,src,source,microtvm,tiny[,variations] [--input_flags]`
+`cm run script --tags=get,src,source,microtvm,tiny[,variations] [--input_flags]`
-2. `cmr "get src source microtvm tiny[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get src source microtvm tiny"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get src source microtvm tiny [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -95,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,src,source,microtv
#### Run this script via Docker (beta)
-`cm docker script "get src source microtvm tiny[ variations]" [--input_flags]`
+`cm docker script "get src source microtvm tiny[variations]" [--input_flags]`
___
### Customization
@@ -149,33 +139,26 @@ Default version: `main`
* `custom`
* `main`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-microtvm/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-microtvm/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-microtvm/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-microtvm/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-microtvm/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-microtvm/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-microtvm/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-microtvm/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-microtvm/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-microtvm/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-microtvm/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-microtvm/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-microtvm/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-microtvm/_cm.json)
___
### Script output
-`cmr "get src source microtvm tiny[,variations]" [--input_flags] -j`
+`cmr "get src source microtvm tiny [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_MICROTVM_*`
#### New environment keys auto-detected from customize
-* `CM_MICROTVM_SOURCE`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_MICROTVM_SOURCE`
\ No newline at end of file
diff --git a/cm-mlops/script/get-ml-model-3d-unet-kits19/README.md b/cm-mlops/script/get-ml-model-3d-unet-kits19/README.md
index 14ed0dedda..b13933fd25 100644
--- a/cm-mlops/script/get-ml-model-3d-unet-kits19/README.md
+++ b/cm-mlops/script/get-ml-model-3d-unet-kits19/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-ml-model-3d-unet-kits19**
-
+Category: **AI/ML models**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-ml-model-3d-unet-kits19,fb7e31419c0f4226) ]*
+
+---
#### Summary
-* Category: *AI/ML models.*
-* 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-ml-model-3d-unet-kits19)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-3d-unet-kits19)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,ml-model,raw,3d-unet,kits19,medical-imaging*
+* All CM tags to find and reuse this script (see in above meta description): *get,ml-model,raw,3d-unet,kits19,medical-imaging*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get ml-model raw 3d-unet kits19 medical-imaging" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,ml-model,raw,3d-unet,kits19,medical-imaging`
-1. `cm run script --tags=get,ml-model,raw,3d-unet,kits19,medical-imaging[,variations] `
+`cm run script --tags=get,ml-model,raw,3d-unet,kits19,medical-imaging[,variations] `
-2. `cmr "get ml-model raw 3d-unet kits19 medical-imaging[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get ml-model raw 3d-unet kits19 medical-imaging"`
+
+`cmr "get ml-model raw 3d-unet kits19 medical-imaging [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,ml-model,raw,3d-un
#### Run this script via Docker (beta)
-`cm docker script "get ml-model raw 3d-unet kits19 medical-imaging[ variations]" `
+`cm docker script "get ml-model raw 3d-unet kits19 medical-imaging[variations]" `
___
### Customization
@@ -181,23 +178,20 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-3d-unet-kits19/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-3d-unet-kits19/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-3d-unet-kits19/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-3d-unet-kits19/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-3d-unet-kits19/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-3d-unet-kits19/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-3d-unet-kits19/_cm.json)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-3d-unet-kits19/_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/get-ml-model-3d-unet-kits19/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-3d-unet-kits19/_cm.json)
___
### Script output
-`cmr "get ml-model raw 3d-unet kits19 medical-imaging[,variations]" -j`
+`cmr "get ml-model raw 3d-unet kits19 medical-imaging [,variations]" -j`
#### New environment keys (filter)
* `CM_ML_MODEL_*`
@@ -205,8 +199,4 @@ ___
* `CM_ML_MODEL_FILE`
* `CM_ML_MODEL_FILE_WITH_PATH`
-* `CM_ML_MODEL_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_ML_MODEL_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-ml-model-abtf-ssd-pytorch/README.md b/cm-mlops/script/get-ml-model-abtf-ssd-pytorch/README.md
index 0d4524f794..7fc218fb39 100644
--- a/cm-mlops/script/get-ml-model-abtf-ssd-pytorch/README.md
+++ b/cm-mlops/script/get-ml-model-abtf-ssd-pytorch/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-ml-model-abtf-ssd-pytorch**
-*Note that this README is automatically generated - don't edit!*
+Category: **AI/ML models**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-ml-model-abtf-ssd-pytorch,59cfc2a22f5d4f46) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *AI/ML models.*
-* 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-ml-model-abtf-ssd-pytorch)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-abtf-ssd-pytorch)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,ml-model,abtf-ssd-pytorch*
+* All CM tags to find and reuse this script (see in above meta description): *get,ml-model,abtf-ssd-pytorch*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get ml-model abtf-ssd-pytorch" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,ml-model,abtf-ssd-pytorch`
-1. `cm run script --tags=get,ml-model,abtf-ssd-pytorch[,variations] `
+`cm run script --tags=get,ml-model,abtf-ssd-pytorch[,variations] `
-2. `cmr "get ml-model abtf-ssd-pytorch[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get ml-model abtf-ssd-pytorch"`
+
+`cmr "get ml-model abtf-ssd-pytorch [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,ml-model,abtf-ssd-
#### Run this script via Docker (beta)
-`cm docker script "get ml-model abtf-ssd-pytorch[ variations]" `
+`cm docker script "get ml-model abtf-ssd-pytorch[variations]" `
___
### Customization
@@ -147,37 +141,30 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-abtf-ssd-pytorch/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-abtf-ssd-pytorch/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* download,file,_wget
* `if (CM_SKIP_DOWNLOAD != yes)`
* CM names: `--adr.['get-ml-model']...`
- CM script: [download-file](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-file)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-abtf-ssd-pytorch/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-abtf-ssd-pytorch/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-abtf-ssd-pytorch/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-abtf-ssd-pytorch/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-abtf-ssd-pytorch/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-abtf-ssd-pytorch/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-abtf-ssd-pytorch/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-abtf-ssd-pytorch/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-abtf-ssd-pytorch/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-abtf-ssd-pytorch/_cm.json)
___
### Script output
-`cmr "get ml-model abtf-ssd-pytorch[,variations]" -j`
+`cmr "get ml-model abtf-ssd-pytorch [,variations]" -j`
#### New environment keys (filter)
* `CM_ML_MODEL_*`
#### New environment keys auto-detected from customize
* `CM_ML_MODEL_FILE`
-* `CM_ML_MODEL_FILE_WITH_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_ML_MODEL_FILE_WITH_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-ml-model-bert-base-squad/README.md b/cm-mlops/script/get-ml-model-bert-base-squad/README.md
index 3329ba28ec..4cae18625a 100644
--- a/cm-mlops/script/get-ml-model-bert-base-squad/README.md
+++ b/cm-mlops/script/get-ml-model-bert-base-squad/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-ml-model-bert-base-squad**
-
+Category: **AI/ML models**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-ml-model-bert-base-squad,b3b10b452ce24c5f) ]*
+---
#### Summary
-* Category: *AI/ML models.*
-* 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-ml-model-bert-base-squad)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-bert-base-squad)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,ml-model,raw,bert,bert-base,bert-squad,language,language-processing*
+* All CM tags to find and reuse this script (see in above meta description): *get,ml-model,raw,bert,bert-base,bert-squad,language,language-processing*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get ml-model raw bert bert-base bert-squad language language-processing" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,ml-model,raw,bert,bert-base,bert-squad,language,language-processing`
-#### Run this script from command line
+`cm run script --tags=get,ml-model,raw,bert,bert-base,bert-squad,language,language-processing[,variations] `
-1. `cm run script --tags=get,ml-model,raw,bert,bert-base,bert-squad,language,language-processing[,variations] `
+*or*
-2. `cmr "get ml-model raw bert bert-base bert-squad language language-processing[ variations]" `
+`cmr "get ml-model raw bert bert-base bert-squad language language-processing"`
-* `variations` can be seen [here](#variations)
+`cmr "get ml-model raw bert bert-base bert-squad language language-processing [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,ml-model,raw,bert,
#### Run this script via Docker (beta)
-`cm docker script "get ml-model raw bert bert-base bert-squad language language-processing[ variations]" `
+`cm docker script "get ml-model raw bert bert-base bert-squad language language-processing[variations]" `
___
### Customization
@@ -162,34 +159,26 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-bert-base-squad/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-bert-base-squad/_cm.json)
1. Run "preprocess" function from customize.py
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-bert-base-squad/_cm.json)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-bert-base-squad/_cm.json)***
* download-and-extract
* `if (CM_TMP_ML_MODEL_REQUIRE_DOWNLOAD in yes)`
- CM script: [download-and-extract](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-and-extract)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-bert-base-squad/_cm.json)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-bert-base-squad/_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/get-ml-model-bert-base-squad/_cm.json)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-bert-base-squad/_cm.json)***
* get,bert,squad,vocab
- CM script: [get-bert-squad-vocab](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-bert-squad-vocab)
-
___
### Script output
-`cmr "get ml-model raw bert bert-base bert-squad language language-processing[,variations]" -j`
+`cmr "get ml-model raw bert bert-base bert-squad language language-processing [,variations]" -j`
#### New environment keys (filter)
* `CM_ML_MODEL*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-ml-model-bert-large-squad/README.md b/cm-mlops/script/get-ml-model-bert-large-squad/README.md
index cd7ba53db2..04d25650f5 100644
--- a/cm-mlops/script/get-ml-model-bert-large-squad/README.md
+++ b/cm-mlops/script/get-ml-model-bert-large-squad/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-ml-model-bert-large-squad**
-
+Category: **AI/ML models**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-ml-model-bert-large-squad,5e865dbdc65949d2) ]*
+
+---
#### Summary
-* Category: *AI/ML models.*
-* 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-ml-model-bert-large-squad)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-bert-large-squad)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,ml-model,raw,bert,bert-large,bert-squad,language,language-processing*
+* All CM tags to find and reuse this script (see in above meta description): *get,ml-model,raw,bert,bert-large,bert-squad,language,language-processing*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get ml-model raw bert bert-large bert-squad language language-processing" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,ml-model,raw,bert,bert-large,bert-squad,language,language-processing`
-1. `cm run script --tags=get,ml-model,raw,bert,bert-large,bert-squad,language,language-processing[,variations] `
+`cm run script --tags=get,ml-model,raw,bert,bert-large,bert-squad,language,language-processing[,variations] `
-2. `cmr "get ml-model raw bert bert-large bert-squad language language-processing[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get ml-model raw bert bert-large bert-squad language language-processing"`
+
+`cmr "get ml-model raw bert bert-large bert-squad language language-processing [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,ml-model,raw,bert,
#### Run this script via Docker (beta)
-`cm docker script "get ml-model raw bert bert-large bert-squad language language-processing[ variations]" `
+`cm docker script "get ml-model raw bert bert-large bert-squad language language-processing[variations]" `
___
### Customization
@@ -329,29 +326,26 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-bert-large-squad/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-bert-large-squad/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-bert-large-squad/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-bert-large-squad/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-bert-large-squad/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-bert-large-squad/_cm.json)***
* download-and-extract
* `if (CM_ML_MODEL_BERT_PACKED != yes)`
- CM script: [download-and-extract](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-and-extract)
1. ***Run native script if exists***
- * [run-packed.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-bert-large-squad/run-packed.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-bert-large-squad/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-bert-large-squad/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-bert-large-squad/_cm.json)***
+ * [run-packed.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-bert-large-squad/run-packed.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-bert-large-squad/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-bert-large-squad/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-bert-large-squad/_cm.json)***
* get,dataset-aux,squad-vocab
- CM script: [get-dataset-squad-vocab](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-squad-vocab)
-
___
### Script output
-`cmr "get ml-model raw bert bert-large bert-squad language language-processing[,variations]" -j`
+`cmr "get ml-model raw bert bert-large bert-squad language language-processing [,variations]" -j`
#### New environment keys (filter)
* `CM_ML_MODEL*`
@@ -361,8 +355,4 @@ ___
* `CM_ML_MODEL_BERT_LARGE_INT8_PATH`
* `CM_ML_MODEL_BERT_PACKED_PATH`
* `CM_ML_MODEL_FILE`
-* `CM_ML_MODEL_FILE_WITH_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_ML_MODEL_FILE_WITH_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-ml-model-dlrm-terabyte/README.md b/cm-mlops/script/get-ml-model-dlrm-terabyte/README.md
index f98915174d..8dfe57da50 100644
--- a/cm-mlops/script/get-ml-model-dlrm-terabyte/README.md
+++ b/cm-mlops/script/get-ml-model-dlrm-terabyte/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-ml-model-dlrm-terabyte**
-
+Category: **AI/ML models**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-ml-model-dlrm-terabyte,8fa7582c603a4db3) ]*
+
+---
#### Summary
-* Category: *AI/ML models.*
-* 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-ml-model-dlrm-terabyte)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-dlrm-terabyte)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,ml-model,dlrm,raw,terabyte,criteo-terabyte,criteo,recommendation*
+* All CM tags to find and reuse this script (see in above meta description): *get,ml-model,dlrm,raw,terabyte,criteo-terabyte,criteo,recommendation*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get ml-model dlrm raw terabyte criteo-terabyte criteo recommendation" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,ml-model,dlrm,raw,terabyte,criteo-terabyte,criteo,recommendation`
-1. `cm run script --tags=get,ml-model,dlrm,raw,terabyte,criteo-terabyte,criteo,recommendation[,variations] [--input_flags]`
+`cm run script --tags=get,ml-model,dlrm,raw,terabyte,criteo-terabyte,criteo,recommendation[,variations] [--input_flags]`
-2. `cmr "get ml-model dlrm raw terabyte criteo-terabyte criteo recommendation[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get ml-model dlrm raw terabyte criteo-terabyte criteo recommendation"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get ml-model dlrm raw terabyte criteo-terabyte criteo recommendation [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,ml-model,dlrm,raw,
#### Run this script via Docker (beta)
-`cm docker script "get ml-model dlrm raw terabyte criteo-terabyte criteo recommendation[ variations]" [--input_flags]`
+`cm docker script "get ml-model dlrm raw terabyte criteo-terabyte criteo recommendation[variations]" [--input_flags]`
___
### Customization
@@ -246,33 +240,25 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-dlrm-terabyte/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-dlrm-terabyte/_cm.json)
1. Run "preprocess" function from customize.py
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-dlrm-terabyte/_cm.json)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-dlrm-terabyte/_cm.json)***
* download-and-extract
* CM names: `--adr.['dae']...`
- CM script: [download-and-extract](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-and-extract)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-dlrm-terabyte/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-dlrm-terabyte/_cm.json)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-dlrm-terabyte/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-dlrm-terabyte/_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/get-ml-model-dlrm-terabyte/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-dlrm-terabyte/_cm.json)
___
### Script output
-`cmr "get ml-model dlrm raw terabyte criteo-terabyte criteo recommendation[,variations]" [--input_flags] -j`
+`cmr "get ml-model dlrm raw terabyte criteo-terabyte criteo recommendation [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_ML_MODEL_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-ml-model-efficientnet-lite/README.md b/cm-mlops/script/get-ml-model-efficientnet-lite/README.md
index e04b244f03..61346f04c1 100644
--- a/cm-mlops/script/get-ml-model-efficientnet-lite/README.md
+++ b/cm-mlops/script/get-ml-model-efficientnet-lite/README.md
@@ -1,59 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Valid variation combinations checked by the community](#valid-variation-combinations-checked-by-the-community)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-ml-model-efficientnet-lite**
-
+Category: **AI/ML models**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-ml-model-efficientnet-lite,1041f681977d4b7c) ]*
+
+---
#### Summary
-* Category: *AI/ML models.*
-* 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-ml-model-efficientnet-lite)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-efficientnet-lite)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,ml-model,efficientnet,raw,ml-model-efficientnet,ml-model-efficientnet-lite,lite,tflite,image-classification*
+* All CM tags to find and reuse this script (see in above meta description): *get,ml-model,efficientnet,raw,ml-model-efficientnet,ml-model-efficientnet-lite,lite,tflite,image-classification*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get ml-model efficientnet raw ml-model-efficientnet ml-model-efficientnet-lite lite tflite image-classification" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,ml-model,efficientnet,raw,ml-model-efficientnet,ml-model-efficientnet-lite,lite,tflite,image-classification`
-1. `cm run script --tags=get,ml-model,efficientnet,raw,ml-model-efficientnet,ml-model-efficientnet-lite,lite,tflite,image-classification[,variations] `
+`cm run script --tags=get,ml-model,efficientnet,raw,ml-model-efficientnet,ml-model-efficientnet-lite,lite,tflite,image-classification[,variations] `
-2. `cmr "get ml-model efficientnet raw ml-model-efficientnet ml-model-efficientnet-lite lite tflite image-classification[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get ml-model efficientnet raw ml-model-efficientnet ml-model-efficientnet-lite lite tflite image-classification"`
+
+`cmr "get ml-model efficientnet raw ml-model-efficientnet ml-model-efficientnet-lite lite tflite image-classification [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -89,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,ml-model,efficient
#### Run this script via Docker (beta)
-`cm docker script "get ml-model efficientnet raw ml-model-efficientnet ml-model-efficientnet-lite lite tflite image-classification[ variations]" `
+`cm docker script "get ml-model efficientnet raw ml-model-efficientnet ml-model-efficientnet-lite lite tflite image-classification[variations]" `
___
### Customization
@@ -228,23 +224,20 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-efficientnet-lite/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-efficientnet-lite/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-efficientnet-lite/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-efficientnet-lite/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-efficientnet-lite/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-efficientnet-lite/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-efficientnet-lite/_cm.json)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-efficientnet-lite/_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/get-ml-model-efficientnet-lite/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-efficientnet-lite/_cm.json)
___
### Script output
-`cmr "get ml-model efficientnet raw ml-model-efficientnet ml-model-efficientnet-lite lite tflite image-classification[,variations]" -j`
+`cmr "get ml-model efficientnet raw ml-model-efficientnet ml-model-efficientnet-lite lite tflite image-classification [,variations]" -j`
#### New environment keys (filter)
* `CM_DATASET_PREPROCESSED_IMAGENET_DEP_TAGS`
@@ -254,8 +247,4 @@ ___
* `CM_ML_MODEL_FILE`
* `CM_ML_MODEL_FILE_WITH_PATH`
* `CM_ML_MODEL_PATH`
-* `CM_ML_MODEL_STARTING_WEIGHTS_FILENAME`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_ML_MODEL_STARTING_WEIGHTS_FILENAME`
\ No newline at end of file
diff --git a/cm-mlops/script/get-ml-model-gptj/README.md b/cm-mlops/script/get-ml-model-gptj/README.md
index 204dde9572..30508eae67 100644
--- a/cm-mlops/script/get-ml-model-gptj/README.md
+++ b/cm-mlops/script/get-ml-model-gptj/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-ml-model-gptj**
-
+Category: **AI/ML models**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-ml-model-gptj,a41166210f294fbf) ]*
+
+---
#### Summary
-* Category: *AI/ML models.*
-* 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-ml-model-gptj)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-gptj)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,raw,ml-model,gptj,gpt-j,large-language-model*
+* All CM tags to find and reuse this script (see in above meta description): *get,raw,ml-model,gptj,gpt-j,large-language-model*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get raw ml-model gptj gpt-j large-language-model" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,raw,ml-model,gptj,gpt-j,large-language-model`
-1. `cm run script --tags=get,raw,ml-model,gptj,gpt-j,large-language-model[,variations] [--input_flags]`
+`cm run script --tags=get,raw,ml-model,gptj,gpt-j,large-language-model[,variations] [--input_flags]`
-2. `cmr "get raw ml-model gptj gpt-j large-language-model[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get raw ml-model gptj gpt-j large-language-model"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get raw ml-model gptj gpt-j large-language-model [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,raw,ml-model,gptj,
#### Run this script via Docker (beta)
-`cm docker script "get raw ml-model gptj gpt-j large-language-model[ variations]" [--input_flags]`
+`cm docker script "get raw ml-model gptj gpt-j large-language-model[variations]" [--input_flags]`
___
### Customization
@@ -295,31 +289,28 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-gptj/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-gptj/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-gptj/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-gptj/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-gptj/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-gptj/_cm.json)***
* download-and-extract
* `if (CM_TMP_REQUIRE_DOWNLOAD == yes)`
* CM names: `--adr.['dae']...`
- CM script: [download-and-extract](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-and-extract)
1. ***Run native script if exists***
- * [run-int4-calibration.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-gptj/run-int4-calibration.sh)
- * [run-intel.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-gptj/run-intel.sh)
- * [run-saxml-quantized.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-gptj/run-saxml-quantized.sh)
- * [run-saxml.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-gptj/run-saxml.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-gptj/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-gptj/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-gptj/_cm.json)
-
+ * [run-int4-calibration.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-gptj/run-int4-calibration.sh)
+ * [run-intel.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-gptj/run-intel.sh)
+ * [run-saxml-quantized.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-gptj/run-saxml-quantized.sh)
+ * [run-saxml.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-gptj/run-saxml.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-gptj/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-gptj/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-gptj/_cm.json)
___
### Script output
-`cmr "get raw ml-model gptj gpt-j large-language-model[,variations]" [--input_flags] -j`
+`cmr "get raw ml-model gptj gpt-j large-language-model [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_ML_MODEL_*`
@@ -328,8 +319,4 @@ ___
* `CM_ML_MODEL_FILE`
* `CM_ML_MODEL_FILE_WITH_PATH`
-* `CM_ML_MODEL_WEIGHT_DATA_TYPES`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_ML_MODEL_WEIGHT_DATA_TYPES`
\ No newline at end of file
diff --git a/cm-mlops/script/get-ml-model-huggingface-zoo/README.md b/cm-mlops/script/get-ml-model-huggingface-zoo/README.md
index 73286ad527..571cc9c545 100644
--- a/cm-mlops/script/get-ml-model-huggingface-zoo/README.md
+++ b/cm-mlops/script/get-ml-model-huggingface-zoo/README.md
@@ -1,64 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-ml-model-huggingface-zoo**
-*Note that this README is automatically generated - don't edit!*
+Category: **AI/ML models**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-ml-model-huggingface-zoo,53cf8252a443446a) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *AI/ML models.*
-* 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-ml-model-huggingface-zoo)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-huggingface-zoo)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,ml-model,huggingface,zoo*
+* All CM tags to find and reuse this script (see in above meta description): *get,ml-model,huggingface,zoo*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get ml-model huggingface zoo" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,ml-model,huggingface,zoo`
-1. `cm run script --tags=get,ml-model,huggingface,zoo[,variations] [--input_flags]`
+`cm run script --tags=get,ml-model,huggingface,zoo[,variations] [--input_flags]`
-2. `cmr "get ml-model huggingface zoo[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get ml-model huggingface zoo"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get ml-model huggingface zoo [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -94,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,ml-model,huggingfa
#### Run this script via Docker (beta)
-`cm docker script "get ml-model huggingface zoo[ variations]" [--input_flags]`
+`cm docker script "get ml-model huggingface zoo[variations]" [--input_flags]`
___
### Customization
@@ -171,30 +162,27 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-huggingface-zoo/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-huggingface-zoo/_cm.json)***
* get,python3
* CM names: `--adr.['python3', 'python']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
* get,generic-python-lib,_huggingface_hub
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-huggingface-zoo/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-huggingface-zoo/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-huggingface-zoo/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-huggingface-zoo/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-huggingface-zoo/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-huggingface-zoo/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-huggingface-zoo/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-huggingface-zoo/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-huggingface-zoo/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-huggingface-zoo/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-huggingface-zoo/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-huggingface-zoo/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-huggingface-zoo/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-huggingface-zoo/_cm.json)
___
### Script output
-`cmr "get ml-model huggingface zoo[,variations]" [--input_flags] -j`
+`cmr "get ml-model huggingface zoo [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_ML_MODEL*`
@@ -203,8 +191,4 @@ ___
* `CM_ML_MODEL_'+env_key+'_FILE_WITH_PATH`
* `CM_ML_MODEL_'+env_key+'_PATH`
-* `CM_ML_MODEL_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_ML_MODEL_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-ml-model-llama2/README.md b/cm-mlops/script/get-ml-model-llama2/README.md
index 0c157d0372..b22c8b6ad0 100644
--- a/cm-mlops/script/get-ml-model-llama2/README.md
+++ b/cm-mlops/script/get-ml-model-llama2/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-ml-model-llama2**
-
+Category: **AI/ML models**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-ml-model-llama2,5db97be9f61244c6) ]*
+
+---
#### Summary
-* Category: *AI/ML models.*
-* 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-ml-model-llama2)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-llama2)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,raw,ml-model,language-processing,llama2,llama2-70b,text-summarization*
+* All CM tags to find and reuse this script (see in above meta description): *get,raw,ml-model,language-processing,llama2,llama2-70b,text-summarization*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get raw ml-model language-processing llama2 llama2-70b text-summarization" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,raw,ml-model,language-processing,llama2,llama2-70b,text-summarization`
-1. `cm run script --tags=get,raw,ml-model,language-processing,llama2,llama2-70b,text-summarization[,variations] [--input_flags]`
+`cm run script --tags=get,raw,ml-model,language-processing,llama2,llama2-70b,text-summarization[,variations] [--input_flags]`
-2. `cmr "get raw ml-model language-processing llama2 llama2-70b text-summarization[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get raw ml-model language-processing llama2 llama2-70b text-summarization"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get raw ml-model language-processing llama2 llama2-70b text-summarization [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,raw,ml-model,langu
#### Run this script via Docker (beta)
-`cm docker script "get raw ml-model language-processing llama2 llama2-70b text-summarization[ variations]" [--input_flags]`
+`cm docker script "get raw ml-model language-processing llama2 llama2-70b text-summarization[variations]" [--input_flags]`
___
### Customization
@@ -202,35 +196,28 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-llama2/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-llama2/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-llama2/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-llama2/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-llama2/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-llama2/_cm.json)***
* get,ml-model,huggingface,zoo,_clone-repo
* `if (CM_TMP_REQUIRE_DOWNLOAD == yes)`
* CM names: `--adr.['hf-zoo']...`
- CM script: [get-ml-model-huggingface-zoo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-huggingface-zoo)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-llama2/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-llama2/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-llama2/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-llama2/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-llama2/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-llama2/_cm.json)
___
### Script output
-`cmr "get raw ml-model language-processing llama2 llama2-70b text-summarization[,variations]" [--input_flags] -j`
+`cmr "get raw ml-model language-processing llama2 llama2-70b text-summarization [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_ML_MODEL_*`
* `LLAMA2_CHECKPOINT_PATH`
#### New environment keys auto-detected from customize
-* `CM_ML_MODEL_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_ML_MODEL_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-ml-model-mobilenet/README.md b/cm-mlops/script/get-ml-model-mobilenet/README.md
index f4dcfbc0b3..887cf9d012 100644
--- a/cm-mlops/script/get-ml-model-mobilenet/README.md
+++ b/cm-mlops/script/get-ml-model-mobilenet/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-ml-model-mobilenet**
-*Note that this README is automatically generated - don't edit!*
+Category: **AI/ML models**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-ml-model-mobilenet,ce46675a3ab249e4) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *AI/ML models.*
-* 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-ml-model-mobilenet)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-mobilenet)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,ml-model,mobilenet,raw,ml-model-mobilenet,image-classification*
+* All CM tags to find and reuse this script (see in above meta description): *get,ml-model,mobilenet,raw,ml-model-mobilenet,image-classification*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get ml-model mobilenet raw ml-model-mobilenet image-classification" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,ml-model,mobilenet,raw,ml-model-mobilenet,image-classification`
-1. `cm run script --tags=get,ml-model,mobilenet,raw,ml-model-mobilenet,image-classification[,variations] `
+`cm run script --tags=get,ml-model,mobilenet,raw,ml-model-mobilenet,image-classification[,variations] `
-2. `cmr "get ml-model mobilenet raw ml-model-mobilenet image-classification[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get ml-model mobilenet raw ml-model-mobilenet image-classification"`
+
+`cmr "get ml-model mobilenet raw ml-model-mobilenet image-classification [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,ml-model,mobilenet
#### Run this script via Docker (beta)
-`cm docker script "get ml-model mobilenet raw ml-model-mobilenet image-classification[ variations]" `
+`cm docker script "get ml-model mobilenet raw ml-model-mobilenet image-classification[variations]" `
___
### Customization
@@ -452,23 +446,20 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-mobilenet/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-mobilenet/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-mobilenet/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-mobilenet/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-mobilenet/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-mobilenet/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-mobilenet/_cm.json)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-mobilenet/_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/get-ml-model-mobilenet/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-mobilenet/_cm.json)
___
### Script output
-`cmr "get ml-model mobilenet raw ml-model-mobilenet image-classification[,variations]" -j`
+`cmr "get ml-model mobilenet raw ml-model-mobilenet image-classification [,variations]" -j`
#### New environment keys (filter)
* `CM_DATASET_PREPROCESSED_IMAGENET_DEP_TAGS`
@@ -478,8 +469,4 @@ ___
* `CM_ML_MODEL_FILE`
* `CM_ML_MODEL_FILE_WITH_PATH`
* `CM_ML_MODEL_PATH`
-* `CM_ML_MODEL_STARTING_WEIGHTS_FILENAME`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_ML_MODEL_STARTING_WEIGHTS_FILENAME`
\ No newline at end of file
diff --git a/cm-mlops/script/get-ml-model-neuralmagic-zoo/README.md b/cm-mlops/script/get-ml-model-neuralmagic-zoo/README.md
index 95e73a2af3..748c025bd9 100644
--- a/cm-mlops/script/get-ml-model-neuralmagic-zoo/README.md
+++ b/cm-mlops/script/get-ml-model-neuralmagic-zoo/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-ml-model-neuralmagic-zoo**
-
+Category: **AI/ML models**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-ml-model-neuralmagic-zoo,adbb3f2525a14f97) ]*
+---
#### Summary
-* Category: *AI/ML models.*
-* 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-ml-model-neuralmagic-zoo)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-neuralmagic-zoo)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,ml-model,model,zoo,deepsparse,model-zoo,sparse-zoo,neuralmagic,neural-magic*
+* All CM tags to find and reuse this script (see in above meta description): *get,ml-model,model,zoo,deepsparse,model-zoo,sparse-zoo,neuralmagic,neural-magic*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get ml-model model zoo deepsparse model-zoo sparse-zoo neuralmagic neural-magic" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,ml-model,model,zoo,deepsparse,model-zoo,sparse-zoo,neuralmagic,neural-magic`
-#### Run this script from command line
+`cm run script --tags=get,ml-model,model,zoo,deepsparse,model-zoo,sparse-zoo,neuralmagic,neural-magic[,variations] `
-1. `cm run script --tags=get,ml-model,model,zoo,deepsparse,model-zoo,sparse-zoo,neuralmagic,neural-magic[,variations] `
+*or*
-2. `cmr "get ml-model model zoo deepsparse model-zoo sparse-zoo neuralmagic neural-magic[ variations]" `
+`cmr "get ml-model model zoo deepsparse model-zoo sparse-zoo neuralmagic neural-magic"`
-* `variations` can be seen [here](#variations)
+`cmr "get ml-model model zoo deepsparse model-zoo sparse-zoo neuralmagic neural-magic [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,ml-model,model,zoo
#### Run this script via Docker (beta)
-`cm docker script "get ml-model model zoo deepsparse model-zoo sparse-zoo neuralmagic neural-magic[ variations]" `
+`cm docker script "get ml-model model zoo deepsparse model-zoo sparse-zoo neuralmagic neural-magic[variations]" `
___
### Customization
@@ -305,12 +302,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-neuralmagic-zoo/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-neuralmagic-zoo/_cm.json)***
* get,python3
* CM names: `--adr.['python3', 'python']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
@@ -318,19 +313,18 @@ ___
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
* get,generic-python-lib,_sparsezoo
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-neuralmagic-zoo/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-neuralmagic-zoo/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-neuralmagic-zoo/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-neuralmagic-zoo/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-neuralmagic-zoo/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-neuralmagic-zoo/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-neuralmagic-zoo/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-neuralmagic-zoo/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-neuralmagic-zoo/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-neuralmagic-zoo/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-neuralmagic-zoo/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-neuralmagic-zoo/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-neuralmagic-zoo/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-neuralmagic-zoo/_cm.json)
___
### Script output
-`cmr "get ml-model model zoo deepsparse model-zoo sparse-zoo neuralmagic neural-magic[,variations]" -j`
+`cmr "get ml-model model zoo deepsparse model-zoo sparse-zoo neuralmagic neural-magic [,variations]" -j`
#### New environment keys (filter)
* `CM_GET_DEPENDENT_CACHED_PATH`
@@ -340,8 +334,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_GET_DEPENDENT_CACHED_PATH`
-* `CM_MLPERF_CUSTOM_MODEL_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_MLPERF_CUSTOM_MODEL_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-ml-model-resnet50/README.md b/cm-mlops/script/get-ml-model-resnet50/README.md
index a6c2d87222..298138021a 100644
--- a/cm-mlops/script/get-ml-model-resnet50/README.md
+++ b/cm-mlops/script/get-ml-model-resnet50/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-ml-model-resnet50**
-*Note that this README is automatically generated - don't edit!*
+Category: **AI/ML models**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-ml-model-resnet50,56203e4e998b4bc0) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *AI/ML models.*
-* 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-ml-model-resnet50)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-resnet50)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,raw,ml-model,resnet50,ml-model-resnet50,image-classification*
+* All CM tags to find and reuse this script (see in above meta description): *get,raw,ml-model,resnet50,ml-model-resnet50,image-classification*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get raw ml-model resnet50 ml-model-resnet50 image-classification" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,raw,ml-model,resnet50,ml-model-resnet50,image-classification`
-1. `cm run script --tags=get,raw,ml-model,resnet50,ml-model-resnet50,image-classification[,variations] `
+`cm run script --tags=get,raw,ml-model,resnet50,ml-model-resnet50,image-classification[,variations] `
-2. `cmr "get raw ml-model resnet50 ml-model-resnet50 image-classification[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get raw ml-model resnet50 ml-model-resnet50 image-classification"`
+
+`cmr "get raw ml-model resnet50 ml-model-resnet50 image-classification [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,raw,ml-model,resne
#### Run this script via Docker (beta)
-`cm docker script "get raw ml-model resnet50 ml-model-resnet50 image-classification[ variations]" `
+`cm docker script "get raw ml-model resnet50 ml-model-resnet50 image-classification[variations]" `
___
### Customization
@@ -336,27 +330,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-resnet50/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-resnet50/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-resnet50/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-resnet50/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-resnet50/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-resnet50/_cm.json)***
* download-and-extract
* CM names: `--adr.['model-downloader']...`
- CM script: [download-and-extract](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-and-extract)
1. ***Run native script if exists***
- * [run-fix-input.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-resnet50/run-fix-input.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-resnet50/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-resnet50/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-resnet50/_cm.json)
-
+ * [run-fix-input.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-resnet50/run-fix-input.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-resnet50/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-resnet50/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-resnet50/_cm.json)
___
### Script output
-`cmr "get raw ml-model resnet50 ml-model-resnet50 image-classification[,variations]" -j`
+`cmr "get raw ml-model resnet50 ml-model-resnet50 image-classification [,variations]" -j`
#### New environment keys (filter)
* `CM_ML_MODEL_*`
@@ -364,8 +355,4 @@ ___
* `CM_ML_MODEL_FILE`
* `CM_ML_MODEL_FILE_WITH_PATH`
-* `CM_ML_MODEL_STARTING_FILE_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_ML_MODEL_STARTING_FILE_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-ml-model-retinanet-nvidia/README.md b/cm-mlops/script/get-ml-model-retinanet-nvidia/README.md
index e56164ad2c..3f36251935 100644
--- a/cm-mlops/script/get-ml-model-retinanet-nvidia/README.md
+++ b/cm-mlops/script/get-ml-model-retinanet-nvidia/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-ml-model-retinanet-nvidia**
-
+Category: **AI/ML models**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-ml-model-retinanet-nvidia,f059d249fac843ba) ]*
+
+---
#### Summary
-* Category: *AI/ML models.*
-* 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-ml-model-retinanet-nvidia)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-retinanet-nvidia)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,ml-model,nvidia-retinanet,nvidia*
+* All CM tags to find and reuse this script (see in above meta description): *get,ml-model,nvidia-retinanet,nvidia*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get ml-model nvidia-retinanet nvidia" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,ml-model,nvidia-retinanet,nvidia`
-1. `cm run script --tags=get,ml-model,nvidia-retinanet,nvidia[,variations] `
+`cm run script --tags=get,ml-model,nvidia-retinanet,nvidia[,variations] `
-2. `cmr "get ml-model nvidia-retinanet nvidia[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get ml-model nvidia-retinanet nvidia"`
+
+`cmr "get ml-model nvidia-retinanet nvidia [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,ml-model,nvidia-re
#### Run this script via Docker (beta)
-`cm docker script "get ml-model nvidia-retinanet nvidia[ variations]" `
+`cm docker script "get ml-model nvidia-retinanet nvidia[variations]" `
___
### Customization
@@ -122,12 +119,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-retinanet-nvidia/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-retinanet-nvidia/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,python3
@@ -154,18 +149,17 @@ ___
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
* get,nvidia,mlperf,inference,common-code,-_custom
- CM script: [get-mlperf-inference-nvidia-common-code](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-common-code)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-retinanet-nvidia/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-retinanet-nvidia/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-retinanet-nvidia/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-retinanet-nvidia/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-retinanet-nvidia/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-retinanet-nvidia/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-retinanet-nvidia/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-retinanet-nvidia/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-retinanet-nvidia/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-retinanet-nvidia/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-retinanet-nvidia/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-retinanet-nvidia/_cm.json)
___
### Script output
-`cmr "get ml-model nvidia-retinanet nvidia[,variations]" -j`
+`cmr "get ml-model nvidia-retinanet nvidia [,variations]" -j`
#### New environment keys (filter)
* `CM_ML_MODEL_*`
@@ -174,8 +168,4 @@ ___
* `CM_ML_MODEL_ANCHOR_PATH`
* `CM_ML_MODEL_DYN_BATCHSIZE_PATH`
-* `CM_NVIDIA_RETINANET_EFFICIENT_NMS_CONCAT_MODEL_WITH_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_NVIDIA_RETINANET_EFFICIENT_NMS_CONCAT_MODEL_WITH_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-ml-model-retinanet/README.md b/cm-mlops/script/get-ml-model-retinanet/README.md
index 44dd59cf87..ab36ac1848 100644
--- a/cm-mlops/script/get-ml-model-retinanet/README.md
+++ b/cm-mlops/script/get-ml-model-retinanet/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-ml-model-retinanet**
-*Note that this README is automatically generated - don't edit!*
+Category: **AI/ML models**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-ml-model-retinanet,427bc5665e4541c2) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *AI/ML models.*
-* 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-ml-model-retinanet)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-retinanet)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,ml-model,raw,resnext50,retinanet,object-detection*
+* All CM tags to find and reuse this script (see in above meta description): *get,ml-model,raw,resnext50,retinanet,object-detection*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get ml-model raw resnext50 retinanet object-detection" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,ml-model,raw,resnext50,retinanet,object-detection`
-1. `cm run script --tags=get,ml-model,raw,resnext50,retinanet,object-detection[,variations] `
+`cm run script --tags=get,ml-model,raw,resnext50,retinanet,object-detection[,variations] `
-2. `cmr "get ml-model raw resnext50 retinanet object-detection[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get ml-model raw resnext50 retinanet object-detection"`
+
+`cmr "get ml-model raw resnext50 retinanet object-detection [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,ml-model,raw,resne
#### Run this script via Docker (beta)
-`cm docker script "get ml-model raw resnext50 retinanet object-detection[ variations]" `
+`cm docker script "get ml-model raw resnext50 retinanet object-detection[variations]" `
___
### Customization
@@ -202,28 +196,25 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-retinanet/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-retinanet/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-retinanet/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-retinanet/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-retinanet/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-retinanet/_cm.json)***
* download-and-extract
* `if (CM_TMP_ML_MODEL_RETINANET_NO_NMS != yes)`
* CM names: `--adr.['dae']...`
- CM script: [download-and-extract](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-and-extract)
1. ***Run native script if exists***
- * [run-no-nms.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-retinanet/run-no-nms.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-retinanet/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-retinanet/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-retinanet/_cm.json)
-
+ * [run-no-nms.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-retinanet/run-no-nms.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-retinanet/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-retinanet/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-retinanet/_cm.json)
___
### Script output
-`cmr "get ml-model raw resnext50 retinanet object-detection[,variations]" -j`
+`cmr "get ml-model raw resnext50 retinanet object-detection [,variations]" -j`
#### New environment keys (filter)
* `<<>>`
@@ -232,8 +223,4 @@ ___
* `CM_ML_MODEL_FILE`
* `CM_ML_MODEL_FILE_WITH_PATH`
-* `CM_ML_MODEL_RETINANET_QAIC_NODE_PRECISION_INFO_FILE_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_ML_MODEL_RETINANET_QAIC_NODE_PRECISION_INFO_FILE_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-ml-model-rnnt/README.md b/cm-mlops/script/get-ml-model-rnnt/README.md
index 0c4dec1591..66a5a6d03b 100644
--- a/cm-mlops/script/get-ml-model-rnnt/README.md
+++ b/cm-mlops/script/get-ml-model-rnnt/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-ml-model-rnnt**
-
+Category: **AI/ML models**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-ml-model-rnnt,8858f18b89774d28) ]*
+
+---
#### Summary
-* Category: *AI/ML models.*
-* 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-ml-model-rnnt)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-rnnt)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,ml-model,rnnt,raw,librispeech,speech-recognition*
+* All CM tags to find and reuse this script (see in above meta description): *get,ml-model,rnnt,raw,librispeech,speech-recognition*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get ml-model rnnt raw librispeech speech-recognition" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,ml-model,rnnt,raw,librispeech,speech-recognition`
-1. `cm run script --tags=get,ml-model,rnnt,raw,librispeech,speech-recognition[,variations] `
+`cm run script --tags=get,ml-model,rnnt,raw,librispeech,speech-recognition[,variations] `
-2. `cmr "get ml-model rnnt raw librispeech speech-recognition[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get ml-model rnnt raw librispeech speech-recognition"`
+
+`cmr "get ml-model rnnt raw librispeech speech-recognition [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,ml-model,rnnt,raw,
#### Run this script via Docker (beta)
-`cm docker script "get ml-model rnnt raw librispeech speech-recognition[ variations]" `
+`cm docker script "get ml-model rnnt raw librispeech speech-recognition[variations]" `
___
### Customization
@@ -173,23 +170,20 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-rnnt/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-rnnt/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-rnnt/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-rnnt/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-rnnt/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-rnnt/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-rnnt/_cm.json)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-rnnt/_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/get-ml-model-rnnt/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-rnnt/_cm.json)
___
### Script output
-`cmr "get ml-model rnnt raw librispeech speech-recognition[,variations]" -j`
+`cmr "get ml-model rnnt raw librispeech speech-recognition [,variations]" -j`
#### New environment keys (filter)
* `CM_ML_MODEL_*`
@@ -197,8 +191,4 @@ ___
* `CM_ML_MODEL_FILE`
* `CM_ML_MODEL_FILE_WITH_PATH`
-* `CM_ML_MODEL_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_ML_MODEL_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-ml-model-stable-diffusion/README.md b/cm-mlops/script/get-ml-model-stable-diffusion/README.md
index 1c34b4334e..7c89c90c4f 100644
--- a/cm-mlops/script/get-ml-model-stable-diffusion/README.md
+++ b/cm-mlops/script/get-ml-model-stable-diffusion/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-ml-model-stable-diffusion**
-
+Category: **AI/ML models**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-ml-model-stable-diffusion,22c6516b2d4d4c23) ]*
+
+---
#### Summary
-* Category: *AI/ML models.*
-* 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-ml-model-stable-diffusion)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-stable-diffusion)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,raw,ml-model,stable-diffusion,sdxl,text-to-image*
+* All CM tags to find and reuse this script (see in above meta description): *get,raw,ml-model,stable-diffusion,sdxl,text-to-image*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get raw ml-model stable-diffusion sdxl text-to-image" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,raw,ml-model,stable-diffusion,sdxl,text-to-image`
-1. `cm run script --tags=get,raw,ml-model,stable-diffusion,sdxl,text-to-image[,variations] [--input_flags]`
+`cm run script --tags=get,raw,ml-model,stable-diffusion,sdxl,text-to-image[,variations] [--input_flags]`
-2. `cmr "get raw ml-model stable-diffusion sdxl text-to-image[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get raw ml-model stable-diffusion sdxl text-to-image"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get raw ml-model stable-diffusion sdxl text-to-image [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,raw,ml-model,stabl
#### Run this script via Docker (beta)
-`cm docker script "get raw ml-model stable-diffusion sdxl text-to-image[ variations]" [--input_flags]`
+`cm docker script "get raw ml-model stable-diffusion sdxl text-to-image[variations]" [--input_flags]`
___
### Customization
@@ -233,14 +227,12 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-stable-diffusion/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-stable-diffusion/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-stable-diffusion/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-stable-diffusion/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-stable-diffusion/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-stable-diffusion/_cm.json)***
* get,ml-model,huggingface,zoo,_clone-repo,_model-stub.stabilityai/stable-diffusion-xl-base-1.0
* `if (CM_TMP_REQUIRE_DOWNLOAD == yes AND CM_DOWNLOAD_TOOL == git)`
* CM names: `--adr.['hf-zoo']...`
@@ -250,21 +242,15 @@ ___
* CM names: `--adr.['dae']...`
- CM script: [download-and-extract](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-and-extract)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-stable-diffusion/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-stable-diffusion/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-stable-diffusion/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-stable-diffusion/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-stable-diffusion/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-stable-diffusion/_cm.json)
___
### Script output
-`cmr "get raw ml-model stable-diffusion sdxl text-to-image[,variations]" [--input_flags] -j`
+`cmr "get raw ml-model stable-diffusion sdxl text-to-image [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_ML_MODEL_*`
* `SDXL_CHECKPOINT_PATH`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-ml-model-tiny-resnet/README.md b/cm-mlops/script/get-ml-model-tiny-resnet/README.md
index 07bffff9cb..2b9bfe1b31 100644
--- a/cm-mlops/script/get-ml-model-tiny-resnet/README.md
+++ b/cm-mlops/script/get-ml-model-tiny-resnet/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-ml-model-tiny-resnet**
-
+Category: **AI/ML models**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-ml-model-tiny-resnet,dd5ec11c3f6e49eb) ]*
+
+---
#### Summary
-* Category: *AI/ML models.*
-* 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-ml-model-tiny-resnet)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-tiny-resnet)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,raw,ml-model,resnet,pretrained,tiny,model,ic,ml-model-tiny-resnet,image-classification*
+* All CM tags to find and reuse this script (see in above meta description): *get,raw,ml-model,resnet,pretrained,tiny,model,ic,ml-model-tiny-resnet,image-classification*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get raw ml-model resnet pretrained tiny model ic ml-model-tiny-resnet image-classification" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,raw,ml-model,resnet,pretrained,tiny,model,ic,ml-model-tiny-resnet,image-classification`
-1. `cm run script --tags=get,raw,ml-model,resnet,pretrained,tiny,model,ic,ml-model-tiny-resnet,image-classification[,variations] `
+`cm run script --tags=get,raw,ml-model,resnet,pretrained,tiny,model,ic,ml-model-tiny-resnet,image-classification[,variations] `
-2. `cmr "get raw ml-model resnet pretrained tiny model ic ml-model-tiny-resnet image-classification[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get raw ml-model resnet pretrained tiny model ic ml-model-tiny-resnet image-classification"`
+
+`cmr "get raw ml-model resnet pretrained tiny model ic ml-model-tiny-resnet image-classification [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,raw,ml-model,resne
#### Run this script via Docker (beta)
-`cm docker script "get raw ml-model resnet pretrained tiny model ic ml-model-tiny-resnet image-classification[ variations]" `
+`cm docker script "get raw ml-model resnet pretrained tiny model ic ml-model-tiny-resnet image-classification[variations]" `
___
### Customization
@@ -190,35 +187,28 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-tiny-resnet/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-tiny-resnet/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-tiny-resnet/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-tiny-resnet/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-tiny-resnet/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-tiny-resnet/_cm.json)***
* download-and-extract
* `if (CM_PACKAGE_URL == on)`
- CM script: [download-and-extract](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-and-extract)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-tiny-resnet/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-tiny-resnet/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-tiny-resnet/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-tiny-resnet/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-tiny-resnet/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-tiny-resnet/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-tiny-resnet/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-tiny-resnet/_cm.json)
___
### Script output
-`cmr "get raw ml-model resnet pretrained tiny model ic ml-model-tiny-resnet image-classification[,variations]" -j`
+`cmr "get raw ml-model resnet pretrained tiny model ic ml-model-tiny-resnet image-classification [,variations]" -j`
#### New environment keys (filter)
* `CM_ML_MODEL_*`
#### New environment keys auto-detected from customize
* `CM_ML_MODEL_FILE`
-* `CM_ML_MODEL_FILE_WITH_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_ML_MODEL_FILE_WITH_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo/README.md b/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo/README.md
index a5c29728d8..e92f5fdf52 100644
--- a/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo/README.md
+++ b/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-ml-model-using-imagenet-from-model-zoo**
-
+Category: **AI/ML models**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-ml-model-using-imagenet-from-model-zoo,153e08828c4e45cc) ]*
+---
#### Summary
-* Category: *AI/ML models.*
-* 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-ml-model-using-imagenet-from-model-zoo)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,ml-model,model-zoo,zoo,imagenet,image-classification*
+* All CM tags to find and reuse this script (see in above meta description): *get,ml-model,model-zoo,zoo,imagenet,image-classification*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get ml-model model-zoo zoo imagenet image-classification" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,ml-model,model-zoo,zoo,imagenet,image-classification`
-#### Run this script from command line
+`cm run script --tags=get,ml-model,model-zoo,zoo,imagenet,image-classification[,variations] `
-1. `cm run script --tags=get,ml-model,model-zoo,zoo,imagenet,image-classification[,variations] `
+*or*
-2. `cmr "get ml-model model-zoo zoo imagenet image-classification[ variations]" `
+`cmr "get ml-model model-zoo zoo imagenet image-classification"`
-* `variations` can be seen [here](#variations)
+`cmr "get ml-model model-zoo zoo imagenet image-classification [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,ml-model,model-zoo
#### Run this script via Docker (beta)
-`cm docker script "get ml-model model-zoo zoo imagenet image-classification[ variations]" `
+`cm docker script "get ml-model model-zoo zoo imagenet image-classification[variations]" `
___
### Customization
@@ -132,29 +129,21 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo/_cm.json)
___
### Script output
-`cmr "get ml-model model-zoo zoo imagenet image-classification[,variations]" -j`
+`cmr "get ml-model model-zoo zoo imagenet image-classification [,variations]" -j`
#### New environment keys (filter)
* `CM_ML_MODEL*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-mlperf-inference-intel-scratch-space/README.md b/cm-mlops/script/get-mlperf-inference-intel-scratch-space/README.md
index 168c7f536a..19199506b2 100644
--- a/cm-mlops/script/get-mlperf-inference-intel-scratch-space/README.md
+++ b/cm-mlops/script/get-mlperf-inference-intel-scratch-space/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-mlperf-inference-intel-scratch-space**
-
+Category: **MLPerf benchmark support**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-mlperf-inference-intel-scratch-space,e83fca30851f45ef) ]*
+
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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-mlperf-inference-intel-scratch-space)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-intel-scratch-space)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,mlperf,inference,intel,scratch,space*
+* All CM tags to find and reuse this script (see in above meta description): *get,mlperf,inference,intel,scratch,space*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get mlperf inference intel scratch space" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,mlperf,inference,intel,scratch,space`
-1. `cm run script --tags=get,mlperf,inference,intel,scratch,space[,variations] [--input_flags]`
+`cm run script --tags=get,mlperf,inference,intel,scratch,space[,variations] [--input_flags]`
-2. `cmr "get mlperf inference intel scratch space[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get mlperf inference intel scratch space"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get mlperf inference intel scratch space [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,mlperf,inference,i
#### Run this script via Docker (beta)
-`cm docker script "get mlperf inference intel scratch space[ variations]" [--input_flags]`
+`cm docker script "get mlperf inference intel scratch space[variations]" [--input_flags]`
___
### Customization
@@ -144,33 +138,26 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-intel-scratch-space/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-intel-scratch-space/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-intel-scratch-space/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-intel-scratch-space/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-intel-scratch-space/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-intel-scratch-space/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-intel-scratch-space/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-intel-scratch-space/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-intel-scratch-space/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-intel-scratch-space/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-intel-scratch-space/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-intel-scratch-space/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-intel-scratch-space/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-intel-scratch-space/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-intel-scratch-space/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-intel-scratch-space/_cm.json)
___
### Script output
-`cmr "get mlperf inference intel scratch space[,variations]" [--input_flags] -j`
+`cmr "get mlperf inference intel scratch space [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_INTEL_MLPERF_SCRATCH_PATH`
* `CM_INTEL_SCRATCH_SPACE_VERSION`
#### New environment keys auto-detected from customize
-* `CM_INTEL_MLPERF_SCRATCH_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_INTEL_MLPERF_SCRATCH_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-mlperf-inference-loadgen/README.md b/cm-mlops/script/get-mlperf-inference-loadgen/README.md
index 04e049ae99..8718fb9f4e 100644
--- a/cm-mlops/script/get-mlperf-inference-loadgen/README.md
+++ b/cm-mlops/script/get-mlperf-inference-loadgen/README.md
@@ -1,62 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ 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)
-
-
+Automatically generated README for this automation recipe: **get-mlperf-inference-loadgen**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-mlperf-inference-loadgen,64c3d98d0ba04950) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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-mlperf-inference-loadgen)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-loadgen)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,loadgen,inference,inference-loadgen,mlperf,mlcommons*
+* All CM tags to find and reuse this script (see in above meta description): *get,loadgen,inference,inference-loadgen,mlperf,mlcommons*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get loadgen inference inference-loadgen mlperf mlcommons" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,loadgen,inference,inference-loadgen,mlperf,mlcommons`
-#### Run this script from command line
+`cm run script --tags=get,loadgen,inference,inference-loadgen,mlperf,mlcommons[,variations] `
-1. `cm run script --tags=get,loadgen,inference,inference-loadgen,mlperf,mlcommons[,variations] `
+*or*
-2. `cmr "get loadgen inference inference-loadgen mlperf mlcommons[ variations]" `
+`cmr "get loadgen inference inference-loadgen mlperf mlcommons"`
-* `variations` can be seen [here](#variations)
+`cmr "get loadgen inference inference-loadgen mlperf mlcommons [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -92,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,loadgen,inference,
#### Run this script via Docker (beta)
-`cm docker script "get loadgen inference inference-loadgen mlperf mlcommons[ variations]" `
+`cm docker script "get loadgen inference inference-loadgen mlperf mlcommons[variations]" `
___
### Customization
@@ -148,12 +141,10 @@ Default version: `master`
* `r3.0`
* `r3.1`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-loadgen/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-loadgen/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,python3
@@ -189,19 +180,21 @@ ___
* get,generic-python-lib,_package.pybind11
* CM names: `--adr.['pip-package', 'pybind11']...`
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-loadgen/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-loadgen/_cm.json)
+ * get,generic-python-lib,_package.setuptools
+ * CM names: `--adr.['pip-package', 'setuputils']...`
+ - CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-loadgen/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-loadgen/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-loadgen/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-loadgen/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-loadgen/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-loadgen/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-loadgen/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-loadgen/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-loadgen/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-loadgen/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-loadgen/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-loadgen/_cm.json)
___
### Script output
-`cmr "get loadgen inference inference-loadgen mlperf mlcommons[,variations]" -j`
+`cmr "get loadgen inference inference-loadgen mlperf mlcommons [,variations]" -j`
#### New environment keys (filter)
* `+CPLUS_INCLUDE_PATH`
@@ -211,8 +204,3 @@ ___
* `+PYTHONPATH`
* `CM_MLPERF_INFERENCE_LOADGEN_VERSION`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-mlperf-inference-nvidia-common-code/README.md b/cm-mlops/script/get-mlperf-inference-nvidia-common-code/README.md
index 7dfd1d4c71..1980c9f12c 100644
--- a/cm-mlops/script/get-mlperf-inference-nvidia-common-code/README.md
+++ b/cm-mlops/script/get-mlperf-inference-nvidia-common-code/README.md
@@ -1,62 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ 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)
-
-
+Automatically generated README for this automation recipe: **get-mlperf-inference-nvidia-common-code**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-mlperf-inference-nvidia-common-code,26b78bf3ffdc4926) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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-mlperf-inference-nvidia-common-code)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-nvidia-common-code)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,nvidia,mlperf,inference,common-code*
+* All CM tags to find and reuse this script (see in above meta description): *get,nvidia,mlperf,inference,common-code*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get nvidia mlperf inference common-code" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,nvidia,mlperf,inference,common-code`
-#### Run this script from command line
+`cm run script --tags=get,nvidia,mlperf,inference,common-code[,variations] `
-1. `cm run script --tags=get,nvidia,mlperf,inference,common-code[,variations] `
+*or*
-2. `cmr "get nvidia mlperf inference common-code[ variations]" `
+`cmr "get nvidia mlperf inference common-code"`
-* `variations` can be seen [here](#variations)
+`cmr "get nvidia mlperf inference common-code [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -92,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,nvidia,mlperf,infe
#### Run this script via Docker (beta)
-`cm docker script "get nvidia mlperf inference common-code[ variations]" `
+`cm docker script "get nvidia mlperf inference common-code[variations]" `
___
### Customization
@@ -132,35 +125,28 @@ Default version: `r3.1`
* `r3.0`
* `r3.1`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-common-code/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-nvidia-common-code/_cm.json)***
* get,mlperf,inference,results
* CM names: `--adr.['mlperf-inference-results']...`
- CM script: [get-mlperf-inference-results](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-results)
- CM script: [get-mlperf-inference-results-dir](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-results-dir)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-common-code/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-common-code/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-nvidia-common-code/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-nvidia-common-code/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-common-code/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-common-code/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-common-code/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-nvidia-common-code/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-nvidia-common-code/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-nvidia-common-code/_cm.json)
___
### Script output
-`cmr "get nvidia mlperf inference common-code[,variations]" -j`
+`cmr "get nvidia mlperf inference common-code [,variations]" -j`
#### New environment keys (filter)
* `+PYTHONPATH`
* `CM_MLPERF_INFERENCE_NVIDIA_CODE_PATH`
#### New environment keys auto-detected from customize
-* `CM_MLPERF_INFERENCE_NVIDIA_CODE_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_MLPERF_INFERENCE_NVIDIA_CODE_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space/README.md b/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space/README.md
index 632f3362c9..867acacc1b 100644
--- a/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space/README.md
+++ b/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space/README.md
@@ -1,64 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-mlperf-inference-nvidia-scratch-space**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-mlperf-inference-nvidia-scratch-space,0b2bec8b29fb4ab7) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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-mlperf-inference-nvidia-scratch-space)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,mlperf,inference,nvidia,scratch,space*
+* All CM tags to find and reuse this script (see in above meta description): *get,mlperf,inference,nvidia,scratch,space*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get mlperf inference nvidia scratch space" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,mlperf,inference,nvidia,scratch,space`
-1. `cm run script --tags=get,mlperf,inference,nvidia,scratch,space[,variations] [--input_flags]`
+`cm run script --tags=get,mlperf,inference,nvidia,scratch,space[,variations] [--input_flags]`
-2. `cmr "get mlperf inference nvidia scratch space[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get mlperf inference nvidia scratch space"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get mlperf inference nvidia scratch space [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -94,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,mlperf,inference,n
#### Run this script via Docker (beta)
-`cm docker script "get mlperf inference nvidia scratch space[ variations]" [--input_flags]`
+`cm docker script "get mlperf inference nvidia scratch space[variations]" [--input_flags]`
___
### Customization
@@ -147,25 +138,22 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space/_cm.json)
___
### Script output
-`cmr "get mlperf inference nvidia scratch space[,variations]" [--input_flags] -j`
+`cmr "get mlperf inference nvidia scratch space [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_NVIDIA_MLPERF_SCRATCH_PATH`
@@ -173,8 +161,4 @@ ___
* `MLPERF_SCRATCH_PATH`
#### New environment keys auto-detected from customize
-* `CM_NVIDIA_MLPERF_SCRATCH_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_NVIDIA_MLPERF_SCRATCH_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-mlperf-inference-results-dir/README.md b/cm-mlops/script/get-mlperf-inference-results-dir/README.md
index fb3a39aaca..e12b811431 100644
--- a/cm-mlops/script/get-mlperf-inference-results-dir/README.md
+++ b/cm-mlops/script/get-mlperf-inference-results-dir/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-mlperf-inference-results-dir**
-
+Category: **MLPerf benchmark support**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-mlperf-inference-results-dir,84f3c5aad5e1444b) ]*
+
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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-mlperf-inference-results-dir)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-results-dir)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,mlperf,inference,results,dir,directory*
+* All CM tags to find and reuse this script (see in above meta description): *get,mlperf,inference,results,dir,directory*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get mlperf inference results dir directory" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,mlperf,inference,results,dir,directory`
-1. `cm run script --tags=get,mlperf,inference,results,dir,directory[,variations] [--input_flags]`
+`cm run script --tags=get,mlperf,inference,results,dir,directory[,variations] [--input_flags]`
-2. `cmr "get mlperf inference results dir directory[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get mlperf inference results dir directory"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get mlperf inference results dir directory [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,mlperf,inference,r
#### Run this script via Docker (beta)
-`cm docker script "get mlperf inference results dir directory[ variations]" [--input_flags]`
+`cm docker script "get mlperf inference results dir directory[variations]" [--input_flags]`
___
### Customization
@@ -144,31 +138,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-results-dir/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-results-dir/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-results-dir/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-results-dir/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-results-dir/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-results-dir/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-results-dir/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-results-dir/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-results-dir/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-results-dir/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-results-dir/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-results-dir/_cm.json)
___
### Script output
-`cmr "get mlperf inference results dir directory[,variations]" [--input_flags] -j`
+`cmr "get mlperf inference results dir directory [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_MLPERF_INFERENCE_RESULTS_DIR`
* `CM_MLPERF_INFERENCE_RESULTS_VERSION`
#### New environment keys auto-detected from customize
-* `CM_MLPERF_INFERENCE_RESULTS_DIR`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_MLPERF_INFERENCE_RESULTS_DIR`
\ No newline at end of file
diff --git a/cm-mlops/script/get-mlperf-inference-results/README.md b/cm-mlops/script/get-mlperf-inference-results/README.md
index 8b04dd704f..15e7dec33f 100644
--- a/cm-mlops/script/get-mlperf-inference-results/README.md
+++ b/cm-mlops/script/get-mlperf-inference-results/README.md
@@ -1,62 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ 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)
-
-
+Automatically generated README for this automation recipe: **get-mlperf-inference-results**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-mlperf-inference-results,36bae5b25dbe41da) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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-mlperf-inference-results)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-results)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,results,inference,inference-results,mlcommons,mlperf*
+* All CM tags to find and reuse this script (see in above meta description): *get,results,inference,inference-results,mlcommons,mlperf*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get results inference inference-results mlcommons mlperf" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,results,inference,inference-results,mlcommons,mlperf`
-1. `cm run script --tags=get,results,inference,inference-results,mlcommons,mlperf[,variations] `
+`cm run script --tags=get,results,inference,inference-results,mlcommons,mlperf[,variations] `
-2. `cmr "get results inference inference-results mlcommons mlperf[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get results inference inference-results mlcommons mlperf"`
+
+`cmr "get results inference inference-results mlcommons mlperf [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -92,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,results,inference,
#### Run this script via Docker (beta)
-`cm docker script "get results inference inference-results mlcommons mlperf[ variations]" `
+`cm docker script "get results inference inference-results mlcommons mlperf[variations]" `
___
### Customization
@@ -148,32 +141,25 @@ Default version: `v3.1`
* `v3.0`
* `v3.1`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-results/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-results/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-results/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-results/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-results/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-results/_cm.json)***
* get,git,repo
- CM script: [get-git-repo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-results/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-results/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-results/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-results/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-results/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-results/_cm.json)
___
### Script output
-`cmr "get results inference inference-results mlcommons mlperf[,variations]" -j`
+`cmr "get results inference inference-results mlcommons mlperf [,variations]" -j`
#### New environment keys (filter)
* `CM_MLPERF_INFERENCE_RESULTS_*`
#### New environment keys auto-detected from customize
-* `CM_MLPERF_INFERENCE_RESULTS_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_MLPERF_INFERENCE_RESULTS_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-mlperf-inference-src/README.md b/cm-mlops/script/get-mlperf-inference-src/README.md
index e6cced3e07..8b6c2ae982 100644
--- a/cm-mlops/script/get-mlperf-inference-src/README.md
+++ b/cm-mlops/script/get-mlperf-inference-src/README.md
@@ -1,62 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ 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)
-
-
+Automatically generated README for this automation recipe: **get-mlperf-inference-src**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-mlperf-inference-src,4b57186581024797) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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-mlperf-inference-src)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-src)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,src,source,inference,inference-src,inference-source,mlperf,mlcommons*
+* All CM tags to find and reuse this script (see in above meta description): *get,src,source,inference,inference-src,inference-source,mlperf,mlcommons*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get src source inference inference-src inference-source mlperf mlcommons" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,src,source,inference,inference-src,inference-source,mlperf,mlcommons`
-#### Run this script from command line
+`cm run script --tags=get,src,source,inference,inference-src,inference-source,mlperf,mlcommons[,variations] `
-1. `cm run script --tags=get,src,source,inference,inference-src,inference-source,mlperf,mlcommons[,variations] `
+*or*
-2. `cmr "get src source inference inference-src inference-source mlperf mlcommons[ variations]" `
+`cmr "get src source inference inference-src inference-source mlperf mlcommons"`
-* `variations` can be seen [here](#variations)
+`cmr "get src source inference inference-src inference-source mlperf mlcommons [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -92,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,src,source,inferen
#### Run this script via Docker (beta)
-`cm docker script "get src source inference inference-src inference-source mlperf mlcommons[ variations]" `
+`cm docker script "get src source inference inference-src inference-source mlperf mlcommons[variations]" `
___
### Customization
@@ -224,31 +217,28 @@ Default version: `master`
* `r3.1`
* `tvm`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-src/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-src/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-src/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-src/_cm.json)***
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-src/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-src/_cm.json)***
* get,git,repo
* CM names: `--adr.['inference-git-repo']...`
- CM script: [get-git-repo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-src/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-src/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-src/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-src/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-src/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-src/_cm.json)
___
### Script output
-`cmr "get src source inference inference-src inference-source mlperf mlcommons[,variations]" -j`
+`cmr "get src source inference inference-src inference-source mlperf mlcommons [,variations]" -j`
#### New environment keys (filter)
* `+PYTHONPATH`
@@ -274,8 +264,4 @@ ___
* `CM_MLPERF_INFERENCE_DLRM_V2_PATH`
* `CM_MLPERF_INFERENCE_GPTJ_PATH`
* `CM_MLPERF_INFERENCE_RNNT_PATH`
-* `CM_MLPERF_INFERENCE_VISION_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_MLPERF_INFERENCE_VISION_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-mlperf-inference-submission-dir/README.md b/cm-mlops/script/get-mlperf-inference-submission-dir/README.md
index 06a67fe8cb..576db43f8c 100644
--- a/cm-mlops/script/get-mlperf-inference-submission-dir/README.md
+++ b/cm-mlops/script/get-mlperf-inference-submission-dir/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-mlperf-inference-submission-dir**
-
+Category: **MLPerf benchmark support**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-mlperf-inference-submission-dir,ddf36a41d6934a7e) ]*
+
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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-mlperf-inference-submission-dir)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-submission-dir)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,mlperf,inference,submission,dir,directory*
+* All CM tags to find and reuse this script (see in above meta description): *get,mlperf,inference,submission,dir,directory*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get mlperf inference submission dir directory" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,mlperf,inference,submission,dir,directory`
-1. `cm run script --tags=get,mlperf,inference,submission,dir,directory[,variations] [--input_flags]`
+`cm run script --tags=get,mlperf,inference,submission,dir,directory[,variations] [--input_flags]`
-2. `cmr "get mlperf inference submission dir directory[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get mlperf inference submission dir directory"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get mlperf inference submission dir directory [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,mlperf,inference,s
#### Run this script via Docker (beta)
-`cm docker script "get mlperf inference submission dir directory[ variations]" [--input_flags]`
+`cm docker script "get mlperf inference submission dir directory[variations]" [--input_flags]`
___
### Customization
@@ -144,31 +138,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-submission-dir/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-submission-dir/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-submission-dir/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-submission-dir/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-submission-dir/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-submission-dir/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-submission-dir/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-submission-dir/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-submission-dir/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-submission-dir/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-submission-dir/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-submission-dir/_cm.json)
___
### Script output
-`cmr "get mlperf inference submission dir directory[,variations]" [--input_flags] -j`
+`cmr "get mlperf inference submission dir directory [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_MLPERF_INFERENCE_SUBMISSION_DIR`
* `CM_MLPERF_INFERENCE_SUBMISSION_VERSION`
#### New environment keys auto-detected from customize
-* `CM_MLPERF_INFERENCE_SUBMISSION_DIR`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_MLPERF_INFERENCE_SUBMISSION_DIR`
\ No newline at end of file
diff --git a/cm-mlops/script/get-mlperf-inference-sut-configs/README.md b/cm-mlops/script/get-mlperf-inference-sut-configs/README.md
index b98e422948..68eecdf33d 100644
--- a/cm-mlops/script/get-mlperf-inference-sut-configs/README.md
+++ b/cm-mlops/script/get-mlperf-inference-sut-configs/README.md
@@ -1,64 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-mlperf-inference-sut-configs**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-mlperf-inference-sut-configs,c2fbf72009e2445b) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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-mlperf-inference-sut-configs)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-sut-configs)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,mlperf,inference,sut,configs,sut-configs*
+* All CM tags to find and reuse this script (see in above meta description): *get,mlperf,inference,sut,configs,sut-configs*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get mlperf inference sut configs sut-configs" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,mlperf,inference,sut,configs,sut-configs`
-1. `cm run script --tags=get,mlperf,inference,sut,configs,sut-configs[,variations] [--input_flags]`
+`cm run script --tags=get,mlperf,inference,sut,configs,sut-configs[,variations] [--input_flags]`
-2. `cmr "get mlperf inference sut configs sut-configs[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get mlperf inference sut configs sut-configs"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get mlperf inference sut configs sut-configs [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -94,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,mlperf,inference,s
#### Run this script via Docker (beta)
-`cm docker script "get mlperf inference sut configs sut-configs[ variations]" [--input_flags]`
+`cm docker script "get mlperf inference sut configs sut-configs[variations]" [--input_flags]`
___
### Customization
@@ -148,23 +139,20 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-sut-configs/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-sut-configs/_cm.json)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-sut-configs/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-sut-configs/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-sut-configs/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-sut-configs/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-sut-configs/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-sut-configs/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-sut-configs/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-sut-configs/_cm.json)
___
### Script output
-`cmr "get mlperf inference sut configs sut-configs[,variations]" [--input_flags] -j`
+`cmr "get mlperf inference sut configs sut-configs [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_HW_*`
@@ -172,8 +160,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_HW_NAME`
-* `CM_SUT_NAME`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_SUT_NAME`
\ No newline at end of file
diff --git a/cm-mlops/script/get-mlperf-inference-sut-description/README.md b/cm-mlops/script/get-mlperf-inference-sut-description/README.md
index c8b0a26cbd..e5ebccc115 100644
--- a/cm-mlops/script/get-mlperf-inference-sut-description/README.md
+++ b/cm-mlops/script/get-mlperf-inference-sut-description/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-mlperf-inference-sut-description**
-
+Category: **MLPerf benchmark support**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-mlperf-inference-sut-description,e49a3f758b2d4e7b) ]*
+
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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-mlperf-inference-sut-description)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-sut-description)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,mlperf,sut,description,system-under-test,system-description*
+* All CM tags to find and reuse this script (see in above meta description): *get,mlperf,sut,description,system-under-test,system-description*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get mlperf sut description system-under-test system-description" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,mlperf,sut,description,system-under-test,system-description`
-1. `cm run script --tags=get,mlperf,sut,description,system-under-test,system-description [--input_flags]`
+`cm run script --tags=get,mlperf,sut,description,system-under-test,system-description [--input_flags]`
-2. `cmr "get mlperf sut description system-under-test system-description" [--input_flags]`
+*or*
+
+`cmr "get mlperf sut description system-under-test system-description"`
+
+`cmr "get mlperf sut description system-under-test system-description " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -121,12 +116,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-sut-description/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-sut-description/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -147,25 +140,20 @@ ___
- CM script: [detect-sudo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-sudo)
* get,generic-python-lib,_package.dmiparser
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-sut-description/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-sut-description/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-sut-description/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-sut-description/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-sut-description/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-sut-description/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-sut-description/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-sut-description/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-sut-description/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-sut-description/_cm.json)
___
### Script output
-`cmr "get mlperf sut description system-under-test system-description" [--input_flags] -j`
+`cmr "get mlperf sut description system-under-test system-description " [--input_flags] -j`
#### New environment keys (filter)
* `CM_HW_*`
* `CM_SUT_*`
#### New environment keys auto-detected from customize
-* `CM_HW_NAME`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_HW_NAME`
\ No newline at end of file
diff --git a/cm-mlops/script/get-mlperf-inference-utils/README.md b/cm-mlops/script/get-mlperf-inference-utils/README.md
index bd55aa1e43..693d9926ed 100644
--- a/cm-mlops/script/get-mlperf-inference-utils/README.md
+++ b/cm-mlops/script/get-mlperf-inference-utils/README.md
@@ -1,54 +1,51 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-mlperf-inference-utils**
-
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-mlperf-inference-utils,e341e5f86d8342e5) ]*
+---
#### Summary
-* 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-mlperf-inference-utils)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-utils)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *get,mlperf,inference,util,utils,functions*
+* All CM tags to find and reuse this script (see in above meta description): *get,mlperf,inference,util,utils,functions*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get mlperf inference util utils functions" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,mlperf,inference,util,utils,functions`
-#### Run this script from command line
+`cm run script --tags=get,mlperf,inference,util,utils,functions `
-1. `cm run script --tags=get,mlperf,inference,util,utils,functions `
+*or*
+
+`cmr "get mlperf inference util utils functions"`
+
+`cmr "get mlperf inference util utils functions " `
-2. `cmr "get mlperf inference util utils functions" `
#### Run this script from Python
@@ -100,32 +97,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-utils/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-utils/_cm.yaml)***
* get,mlperf,inference,src
* CM names: `--adr.['inference-src']...`
- CM script: [get-mlperf-inference-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-src)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-utils/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-utils/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-utils/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-utils/_cm.yaml)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-utils/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-utils/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-utils/_cm.yaml)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-utils/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-utils/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-utils/_cm.yaml)
___
### Script output
-`cmr "get mlperf inference util utils functions" -j`
+`cmr "get mlperf inference util utils functions " -j`
#### New environment keys (filter)
* `+PYTHONPATH`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-mlperf-logging/README.md b/cm-mlops/script/get-mlperf-logging/README.md
index 3c939d4a6e..e0c1199071 100644
--- a/cm-mlops/script/get-mlperf-logging/README.md
+++ b/cm-mlops/script/get-mlperf-logging/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-mlperf-logging**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-mlperf-logging,c9830dc6f87b4dc6) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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-mlperf-logging)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-logging)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,mlperf,logging,mlperf-logging*
+* All CM tags to find and reuse this script (see in above meta description): *get,mlperf,logging,mlperf-logging*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get mlperf logging mlperf-logging" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,mlperf,logging,mlperf-logging`
-1. `cm run script --tags=get,mlperf,logging,mlperf-logging `
+`cm run script --tags=get,mlperf,logging,mlperf-logging `
+
+*or*
+
+`cmr "get mlperf logging mlperf-logging"`
+
+`cmr "get mlperf logging mlperf-logging " `
-2. `cmr "get mlperf logging mlperf-logging" `
#### Run this script from Python
@@ -104,12 +99,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-logging/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-logging/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,python3
@@ -117,25 +110,20 @@ ___
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
* get,git,repo,_repo.https://github.com/mlcommons/logging
- 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-mlperf-logging/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-logging/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-logging/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-logging/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-logging/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-logging/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-logging/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-logging/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-logging/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-logging/_cm.json)
___
### Script output
-`cmr "get mlperf logging mlperf-logging" -j`
+`cmr "get mlperf logging mlperf-logging " -j`
#### New environment keys (filter)
* `+PYTHONPATH`
* `CM_MLPERF_LOGGING_*`
#### New environment keys auto-detected from customize
-* `CM_MLPERF_LOGGING_SRC_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_MLPERF_LOGGING_SRC_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-mlperf-power-dev/README.md b/cm-mlops/script/get-mlperf-power-dev/README.md
index 1ad67c2de6..7f755f413c 100644
--- a/cm-mlops/script/get-mlperf-power-dev/README.md
+++ b/cm-mlops/script/get-mlperf-power-dev/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-mlperf-power-dev**
-
+Category: **MLPerf benchmark support**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-mlperf-power-dev,72aa56768c994bcf) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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-mlperf-power-dev)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-power-dev)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,src,source,power,power-dev,mlperf,mlcommons*
+* All CM tags to find and reuse this script (see in above meta description): *get,src,source,power,power-dev,mlperf,mlcommons*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get src source power power-dev mlperf mlcommons" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,src,source,power,power-dev,mlperf,mlcommons`
-#### Run this script from command line
+`cm run script --tags=get,src,source,power,power-dev,mlperf,mlcommons[,variations] `
-1. `cm run script --tags=get,src,source,power,power-dev,mlperf,mlcommons[,variations] `
+*or*
-2. `cmr "get src source power power-dev mlperf mlcommons[ variations]" `
+`cmr "get src source power power-dev mlperf mlcommons"`
-* `variations` can be seen [here](#variations)
+`cmr "get src source power power-dev mlperf mlcommons [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,src,source,power,p
#### Run this script via Docker (beta)
-`cm docker script "get src source power power-dev mlperf mlcommons[ variations]" `
+`cm docker script "get src source power power-dev mlperf mlcommons[variations]" `
___
### Customization
@@ -153,32 +150,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-power-dev/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-power-dev/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-power-dev/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-power-dev/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-power-dev/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-power-dev/_cm.json)***
* get,git,repo
* CM names: `--adr.['mlperf-power-dev-git-repo']...`
- CM script: [get-git-repo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-power-dev/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-power-dev/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-power-dev/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-power-dev/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-power-dev/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-power-dev/_cm.json)
___
### Script output
-`cmr "get src source power power-dev mlperf mlcommons[,variations]" -j`
+`cmr "get src source power power-dev mlperf mlcommons [,variations]" -j`
#### New environment keys (filter)
* `CM_MLPERF_POWER_SOURCE`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src/README.md b/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src/README.md
index 06afb1aaee..ec13f5a826 100644
--- a/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src/README.md
+++ b/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-mlperf-tiny-eembc-energy-runner-src**
-
+Category: **MLPerf benchmark support**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-mlperf-tiny-eembc-energy-runner-src,c7da8d1ce4164a4b) ]*
+
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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-mlperf-tiny-eembc-energy-runner-src)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,src,source,eembc,energyrunner,energy-runner,eembc-energy-runner,tinymlperf-energy-runner*
+* All CM tags to find and reuse this script (see in above meta description): *get,src,source,eembc,energyrunner,energy-runner,eembc-energy-runner,tinymlperf-energy-runner*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get src source eembc energyrunner energy-runner eembc-energy-runner tinymlperf-energy-runner" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,src,source,eembc,energyrunner,energy-runner,eembc-energy-runner,tinymlperf-energy-runner`
-1. `cm run script --tags=get,src,source,eembc,energyrunner,energy-runner,eembc-energy-runner,tinymlperf-energy-runner `
+`cm run script --tags=get,src,source,eembc,energyrunner,energy-runner,eembc-energy-runner,tinymlperf-energy-runner `
+
+*or*
+
+`cmr "get src source eembc energyrunner energy-runner eembc-energy-runner tinymlperf-energy-runner"`
+
+`cmr "get src source eembc energyrunner energy-runner eembc-energy-runner tinymlperf-energy-runner " `
-2. `cmr "get src source eembc energyrunner energy-runner eembc-energy-runner tinymlperf-energy-runner" `
#### Run this script from Python
@@ -105,25 +103,22 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src/_cm.json)
___
### Script output
-`cmr "get src source eembc energyrunner energy-runner eembc-energy-runner tinymlperf-energy-runner" -j`
+`cmr "get src source eembc energyrunner energy-runner eembc-energy-runner tinymlperf-energy-runner " -j`
#### New environment keys (filter)
* `+PYTHONPATH`
@@ -133,8 +128,4 @@ ___
* `CM_EEMBC_ENERGY_RUNNER_DATASETS`
* `CM_EEMBC_ENERGY_RUNNER_SESSIONS`
* `CM_EEMBC_ENERGY_RUNNER_SRC`
-* `CM_EEMBC_ENERGY_RUNNER_SRC_DATASETS`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_EEMBC_ENERGY_RUNNER_SRC_DATASETS`
\ No newline at end of file
diff --git a/cm-mlops/script/get-mlperf-tiny-src/README.md b/cm-mlops/script/get-mlperf-tiny-src/README.md
index 0bbc7afd45..dab294c761 100644
--- a/cm-mlops/script/get-mlperf-tiny-src/README.md
+++ b/cm-mlops/script/get-mlperf-tiny-src/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-mlperf-tiny-src**
-
+Category: **MLPerf benchmark support**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-mlperf-tiny-src,777843a0bb034524) ]*
+
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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-mlperf-tiny-src)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-src)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,src,source,tiny,tiny-src,tiny-source,tinymlperf,tinymlperf-src,mlperf,mlcommons*
+* All CM tags to find and reuse this script (see in above meta description): *get,src,source,tiny,tiny-src,tiny-source,tinymlperf,tinymlperf-src,mlperf,mlcommons*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get src source tiny tiny-src tiny-source tinymlperf tinymlperf-src mlperf mlcommons" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,src,source,tiny,tiny-src,tiny-source,tinymlperf,tinymlperf-src,mlperf,mlcommons`
-1. `cm run script --tags=get,src,source,tiny,tiny-src,tiny-source,tinymlperf,tinymlperf-src,mlperf,mlcommons `
+`cm run script --tags=get,src,source,tiny,tiny-src,tiny-source,tinymlperf,tinymlperf-src,mlperf,mlcommons `
+
+*or*
+
+`cmr "get src source tiny tiny-src tiny-source tinymlperf tinymlperf-src mlperf mlcommons"`
+
+`cmr "get src source tiny tiny-src tiny-source tinymlperf tinymlperf-src mlperf mlcommons " `
-2. `cmr "get src source tiny tiny-src tiny-source tinymlperf tinymlperf-src mlperf mlcommons" `
#### Run this script from Python
@@ -105,30 +103,27 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-tiny-src/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-src/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-tiny-src/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-tiny-src/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-src/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-src/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-tiny-src/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-tiny-src/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-tiny-src/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-tiny-src/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-tiny-src/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-src/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-src/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-src/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-src/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-src/_cm.json)
___
### Script output
-`cmr "get src source tiny tiny-src tiny-source tinymlperf tinymlperf-src mlperf mlcommons" -j`
+`cmr "get src source tiny tiny-src tiny-source tinymlperf tinymlperf-src mlperf mlcommons " -j`
#### New environment keys (filter)
* `+PYTHONPATH`
@@ -147,8 +142,4 @@ ___
* `CM_MLPERF_TINY_TRAINING_AD`
* `CM_MLPERF_TINY_TRAINING_IC`
* `CM_MLPERF_TINY_TRAINING_KWS`
-* `CM_MLPERF_TINY_TRAINING_VWW`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_MLPERF_TINY_TRAINING_VWW`
\ No newline at end of file
diff --git a/cm-mlops/script/get-mlperf-training-nvidia-code/README.md b/cm-mlops/script/get-mlperf-training-nvidia-code/README.md
index d6d60a3a0d..433b472372 100644
--- a/cm-mlops/script/get-mlperf-training-nvidia-code/README.md
+++ b/cm-mlops/script/get-mlperf-training-nvidia-code/README.md
@@ -1,59 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ 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)
+Automatically generated README for this automation recipe: **get-mlperf-training-nvidia-code**
-
+Category: **MLPerf benchmark support**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-mlperf-training-nvidia-code,fdc630b1d41743c5) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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-mlperf-training-nvidia-code)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-training-nvidia-code)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,nvidia,mlperf,training,code,training-code*
+* All CM tags to find and reuse this script (see in above meta description): *get,nvidia,mlperf,training,code,training-code*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get nvidia mlperf training code training-code" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,nvidia,mlperf,training,code,training-code`
-#### Run this script from command line
+`cm run script --tags=get,nvidia,mlperf,training,code,training-code[,variations] `
-1. `cm run script --tags=get,nvidia,mlperf,training,code,training-code[,variations] `
+*or*
-2. `cmr "get nvidia mlperf training code training-code[ variations]" `
+`cmr "get nvidia mlperf training code training-code"`
-* `variations` can be seen [here](#variations)
+`cmr "get nvidia mlperf training code training-code [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -89,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,nvidia,mlperf,trai
#### Run this script via Docker (beta)
-`cm docker script "get nvidia mlperf training code training-code[ variations]" `
+`cm docker script "get nvidia mlperf training code training-code[variations]" `
___
### Customization
@@ -139,33 +135,26 @@ Default version: `r3.0`
* `r3.0`
* `r3.1`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-training-nvidia-code/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-training-nvidia-code/_cm.json)***
* get,git,repo
* CM names: `--adr.['mlperf-training-results']...`
- 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-mlperf-training-nvidia-code/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-training-nvidia-code/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-training-nvidia-code/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-training-nvidia-code/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-training-nvidia-code/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-training-nvidia-code/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-training-nvidia-code/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-training-nvidia-code/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-training-nvidia-code/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-training-nvidia-code/_cm.json)
___
### Script output
-`cmr "get nvidia mlperf training code training-code[,variations]" -j`
+`cmr "get nvidia mlperf training code training-code [,variations]" -j`
#### New environment keys (filter)
* `CM_MLPERF_TRAINING_NVIDIA_CODE_PATH`
#### New environment keys auto-detected from customize
-* `CM_MLPERF_TRAINING_NVIDIA_CODE_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_MLPERF_TRAINING_NVIDIA_CODE_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-mlperf-training-src/README.md b/cm-mlops/script/get-mlperf-training-src/README.md
index 43838896bb..df0104bb64 100644
--- a/cm-mlops/script/get-mlperf-training-src/README.md
+++ b/cm-mlops/script/get-mlperf-training-src/README.md
@@ -1,62 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ 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)
-
-
+Automatically generated README for this automation recipe: **get-mlperf-training-src**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-mlperf-training-src,dc440bd88e794a28) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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-mlperf-training-src)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-training-src)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,src,source,training,training-src,training-source,mlperf,mlcommons*
+* All CM tags to find and reuse this script (see in above meta description): *get,src,source,training,training-src,training-source,mlperf,mlcommons*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get src source training training-src training-source mlperf mlcommons" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,src,source,training,training-src,training-source,mlperf,mlcommons`
-#### Run this script from command line
+`cm run script --tags=get,src,source,training,training-src,training-source,mlperf,mlcommons[,variations] `
-1. `cm run script --tags=get,src,source,training,training-src,training-source,mlperf,mlcommons[,variations] `
+*or*
-2. `cmr "get src source training training-src training-source mlperf mlcommons[ variations]" `
+`cmr "get src source training training-src training-source mlperf mlcommons"`
-* `variations` can be seen [here](#variations)
+`cmr "get src source training training-src training-source mlperf mlcommons [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -92,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,src,source,trainin
#### Run this script via Docker (beta)
-`cm docker script "get src source training training-src training-source mlperf mlcommons[ variations]" `
+`cm docker script "get src source training training-src training-source mlperf mlcommons[variations]" `
___
### Customization
@@ -208,34 +201,26 @@ Default version: `master`
* `custom`
* `master`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-training-src/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-training-src/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-training-src/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-training-src/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-training-src/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-training-src/_cm.json)***
* get,git,repo
* CM names: `--adr.['mlperf-training-repo']...`
- CM script: [get-git-repo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-training-src/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-training-src/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-training-src/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-training-src/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-training-src/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-training-src/_cm.json)
___
### Script output
-`cmr "get src source training training-src training-source mlperf mlcommons[,variations]" -j`
+`cmr "get src source training training-src training-source mlperf mlcommons [,variations]" -j`
#### New environment keys (filter)
* `+PYTHONPATH`
* `CM_MLPERF_TRAINING_*`
* `CM_MLPERF_TRAINING_LAST_RELEASE`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-nvidia-docker/README.md b/cm-mlops/script/get-nvidia-docker/README.md
index abd67377c3..ec8e714c2f 100644
--- a/cm-mlops/script/get-nvidia-docker/README.md
+++ b/cm-mlops/script/get-nvidia-docker/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-nvidia-docker**
-
+Category: **Detection or installation of tools and artifacts**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-nvidia-docker,465ae240998e4779) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-nvidia-docker)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-nvidia-docker)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,install,nvidia,nvidia-container-toolkit,nvidia-docker,engine*
+* All CM tags to find and reuse this script (see in above meta description): *get,install,nvidia,nvidia-container-toolkit,nvidia-docker,engine*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get install nvidia nvidia-container-toolkit nvidia-docker engine" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,install,nvidia,nvidia-container-toolkit,nvidia-docker,engine`
-#### Run this script from command line
+`cm run script --tags=get,install,nvidia,nvidia-container-toolkit,nvidia-docker,engine `
-1. `cm run script --tags=get,install,nvidia,nvidia-container-toolkit,nvidia-docker,engine `
+*or*
+
+`cmr "get install nvidia nvidia-container-toolkit nvidia-docker engine"`
+
+`cmr "get install nvidia nvidia-container-toolkit nvidia-docker engine " `
-2. `cmr "get install nvidia nvidia-container-toolkit nvidia-docker engine" `
#### Run this script from Python
@@ -101,33 +99,25 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-nvidia-docker/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-nvidia-docker/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,docker
- CM script: [get-docker](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-docker)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-nvidia-docker/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-nvidia-docker/_cm.json)
1. ***Run native script if exists***
- * [run-ubuntu.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-nvidia-docker/run-ubuntu.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-nvidia-docker/_cm.json)
+ * [run-ubuntu.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-nvidia-docker/run-ubuntu.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-nvidia-docker/_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/get-nvidia-docker/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-nvidia-docker/_cm.json)
___
### Script output
-`cmr "get install nvidia nvidia-container-toolkit nvidia-docker engine" -j`
+`cmr "get install nvidia nvidia-container-toolkit nvidia-docker engine " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-nvidia-mitten/README.md b/cm-mlops/script/get-nvidia-mitten/README.md
index 7c0c23875a..b6714d5f1d 100644
--- a/cm-mlops/script/get-nvidia-mitten/README.md
+++ b/cm-mlops/script/get-nvidia-mitten/README.md
@@ -1,59 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-nvidia-mitten**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-nvidia-mitten,1c045f2902374de9) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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-nvidia-mitten)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-nvidia-mitten)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,nvidia,mitten,nvidia-mitten*
+* All CM tags to find and reuse this script (see in above meta description): *get,nvidia,mitten,nvidia-mitten*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get nvidia mitten nvidia-mitten" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,nvidia,mitten,nvidia-mitten`
-#### Run this script from command line
+`cm run script --tags=get,nvidia,mitten,nvidia-mitten `
-1. `cm run script --tags=get,nvidia,mitten,nvidia-mitten `
+*or*
+
+`cmr "get nvidia mitten nvidia-mitten"`
+
+`cmr "get nvidia mitten nvidia-mitten " `
-2. `cmr "get nvidia mitten nvidia-mitten" `
#### Run this script from Python
@@ -108,12 +102,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
Default version: `master`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-nvidia-mitten/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-nvidia-mitten/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,python3
@@ -122,25 +114,19 @@ ___
* get,git,_repo.https://github.com/NVIDIA/mitten
* CM names: `--adr.['nvidia-mitten-git-src']...`
- 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-nvidia-mitten/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-nvidia-mitten/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-nvidia-mitten/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-nvidia-mitten/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-nvidia-mitten/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-nvidia-mitten/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-nvidia-mitten/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-nvidia-mitten/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-nvidia-mitten/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-nvidia-mitten/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-nvidia-mitten/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-nvidia-mitten/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-nvidia-mitten/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-nvidia-mitten/_cm.json)
___
### Script output
-`cmr "get nvidia mitten nvidia-mitten" -j`
+`cmr "get nvidia mitten nvidia-mitten " -j`
#### New environment keys (filter)
* `CM_NVIDIA_MITTEN*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-onnxruntime-prebuilt/README.md b/cm-mlops/script/get-onnxruntime-prebuilt/README.md
index 25de1fd7de..f9c0905630 100644
--- a/cm-mlops/script/get-onnxruntime-prebuilt/README.md
+++ b/cm-mlops/script/get-onnxruntime-prebuilt/README.md
@@ -1,59 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ 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)
+Automatically generated README for this automation recipe: **get-onnxruntime-prebuilt**
-
+Category: **AI/ML frameworks**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-onnxruntime-prebuilt,be02c84ff57c4244) ]*
+---
#### 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-onnxruntime-prebuilt)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-onnxruntime-prebuilt)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,onnxruntime,get,prebuilt,lib,lang-c,lang-cpp*
+* All CM tags to find and reuse this script (see in above meta description): *install,onnxruntime,get,prebuilt,lib,lang-c,lang-cpp*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install onnxruntime get prebuilt lib lang-c lang-cpp" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,onnxruntime,get,prebuilt,lib,lang-c,lang-cpp`
-#### Run this script from command line
+`cm run script --tags=install,onnxruntime,get,prebuilt,lib,lang-c,lang-cpp[,variations] `
-1. `cm run script --tags=install,onnxruntime,get,prebuilt,lib,lang-c,lang-cpp[,variations] `
+*or*
-2. `cmr "install onnxruntime get prebuilt lib lang-c lang-cpp[ variations]" `
+`cmr "install onnxruntime get prebuilt lib lang-c lang-cpp"`
-* `variations` can be seen [here](#variations)
+`cmr "install onnxruntime get prebuilt lib lang-c lang-cpp [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -89,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=install,onnxruntime,ge
#### Run this script via Docker (beta)
-`cm docker script "install onnxruntime get prebuilt lib lang-c lang-cpp[ variations]" `
+`cm docker script "install onnxruntime get prebuilt lib lang-c lang-cpp[variations]" `
___
### Customization
@@ -130,27 +126,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
Default version: `1.16.3`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-onnxruntime-prebuilt/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-onnxruntime-prebuilt/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-onnxruntime-prebuilt/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-onnxruntime-prebuilt/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-onnxruntime-prebuilt/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-onnxruntime-prebuilt/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-onnxruntime-prebuilt/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-onnxruntime-prebuilt/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-onnxruntime-prebuilt/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-onnxruntime-prebuilt/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-onnxruntime-prebuilt/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-onnxruntime-prebuilt/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-onnxruntime-prebuilt/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-onnxruntime-prebuilt/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-onnxruntime-prebuilt/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-onnxruntime-prebuilt/_cm.json)
___
### Script output
-`cmr "install onnxruntime get prebuilt lib lang-c lang-cpp[,variations]" -j`
+`cmr "install onnxruntime get prebuilt lib lang-c lang-cpp [,variations]" -j`
#### New environment keys (filter)
* `+CPLUS_INCLUDE_PATH`
@@ -163,8 +156,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_ONNXRUNTIME_INCLUDE_PATH`
-* `CM_ONNXRUNTIME_LIB_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_ONNXRUNTIME_LIB_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-openssl/README.md b/cm-mlops/script/get-openssl/README.md
index 311272e1d0..242bfc2c15 100644
--- a/cm-mlops/script/get-openssl/README.md
+++ b/cm-mlops/script/get-openssl/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-openssl**
-*Note that this README is automatically generated - don't edit!*
+Category: **Detection or installation of tools and artifacts**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-openssl,febdae70e9e64e30) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-openssl)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-openssl)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,openssl,lib,lib-openssl*
+* All CM tags to find and reuse this script (see in above meta description): *get,openssl,lib,lib-openssl*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get openssl lib lib-openssl" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,openssl,lib,lib-openssl`
-1. `cm run script --tags=get,openssl,lib,lib-openssl `
+`cm run script --tags=get,openssl,lib,lib-openssl `
+
+*or*
+
+`cmr "get openssl lib lib-openssl"`
+
+`cmr "get openssl lib lib-openssl " `
-2. `cmr "get openssl lib lib-openssl" `
#### Run this script from Python
@@ -104,35 +99,28 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-openssl/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-openssl/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-openssl/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-openssl/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-openssl/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-openssl/_cm.json)***
* install,openssl
* `if (CM_REQUIRE_INSTALL == yes)`
- CM script: [install-openssl](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-openssl)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-openssl/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-openssl/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-openssl/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-openssl/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-openssl/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-openssl/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-openssl/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-openssl/_cm.json)
___
### Script output
-`cmr "get openssl lib lib-openssl" -j`
+`cmr "get openssl lib lib-openssl " -j`
#### New environment keys (filter)
* `+LD_LIBRARY_PATH`
* `CM_OPENSSL_*`
#### New environment keys auto-detected from customize
-* `CM_OPENSSL_INSTALLED_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_OPENSSL_INSTALLED_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-preprocessed-dataset-criteo/README.md b/cm-mlops/script/get-preprocessed-dataset-criteo/README.md
index bc2f064341..6b8543a3fd 100644
--- a/cm-mlops/script/get-preprocessed-dataset-criteo/README.md
+++ b/cm-mlops/script/get-preprocessed-dataset-criteo/README.md
@@ -1,64 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-preprocessed-dataset-criteo**
-*Note that this README is automatically generated - don't edit!*
+Category: **AI/ML datasets**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-preprocessed-dataset-criteo,afa59956272a4ba4) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* 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-preprocessed-dataset-criteo)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-criteo)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,dataset,criteo,recommendation,dlrm,preprocessed*
+* All CM tags to find and reuse this script (see in above meta description): *get,dataset,criteo,recommendation,dlrm,preprocessed*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get dataset criteo recommendation dlrm preprocessed" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,dataset,criteo,recommendation,dlrm,preprocessed`
-1. `cm run script --tags=get,dataset,criteo,recommendation,dlrm,preprocessed[,variations] [--input_flags]`
+`cm run script --tags=get,dataset,criteo,recommendation,dlrm,preprocessed[,variations] [--input_flags]`
-2. `cmr "get dataset criteo recommendation dlrm preprocessed[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get dataset criteo recommendation dlrm preprocessed"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get dataset criteo recommendation dlrm preprocessed [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -94,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,dataset,criteo,rec
#### Run this script via Docker (beta)
-`cm docker script "get dataset criteo recommendation dlrm preprocessed[ variations]" [--input_flags]`
+`cm docker script "get dataset criteo recommendation dlrm preprocessed[variations]" [--input_flags]`
___
### Customization
@@ -183,12 +174,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-criteo/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-criteo/_cm.json)***
* get,python3
* CM names: `--adr.['python3', 'python']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
@@ -218,26 +207,21 @@ ___
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
* get,generic-python-lib,_mlperf_logging
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-criteo/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-criteo/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-criteo/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-criteo/_cm.json)
1. ***Run native script if exists***
- * [run-multihot.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-criteo/run-multihot.sh)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-criteo/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-criteo/_cm.json)
+ * [run-multihot.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-criteo/run-multihot.sh)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-criteo/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-criteo/_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/get-preprocessed-dataset-criteo/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-criteo/_cm.json)
___
### Script output
-`cmr "get dataset criteo recommendation dlrm preprocessed[,variations]" [--input_flags] -j`
+`cmr "get dataset criteo recommendation dlrm preprocessed [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_DATASET_*`
#### New environment keys auto-detected from customize
-* `CM_DATASET_PREPROCESSED_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_DATASET_PREPROCESSED_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-preprocessed-dataset-generic/README.md b/cm-mlops/script/get-preprocessed-dataset-generic/README.md
index d33ec1d4d3..40a5f00177 100644
--- a/cm-mlops/script/get-preprocessed-dataset-generic/README.md
+++ b/cm-mlops/script/get-preprocessed-dataset-generic/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-preprocesser-script-generic**
-
+Category: **AI/ML datasets**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-preprocesser-script-generic,d5e603627e2046eb) ]*
+---
#### Summary
-* 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-preprocesser-script-generic)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocesser-script-generic)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,preprocessor,generic,image-preprocessor,script*
+* All CM tags to find and reuse this script (see in above meta description): *get,preprocessor,generic,image-preprocessor,script*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get preprocessor generic image-preprocessor script" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,preprocessor,generic,image-preprocessor,script`
-#### Run this script from command line
+`cm run script --tags=get,preprocessor,generic,image-preprocessor,script `
-1. `cm run script --tags=get,preprocessor,generic,image-preprocessor,script `
+*or*
+
+`cmr "get preprocessor generic image-preprocessor script"`
+
+`cmr "get preprocessor generic image-preprocessor script " `
-2. `cmr "get preprocessor generic image-preprocessor script" `
#### Run this script from Python
@@ -101,29 +99,21 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocesser-script-generic/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocesser-script-generic/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocesser-script-generic/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocesser-script-generic/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocesser-script-generic/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocesser-script-generic/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocesser-script-generic/_cm.json)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocesser-script-generic/_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/get-preprocesser-script-generic/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocesser-script-generic/_cm.json)
___
### Script output
-`cmr "get preprocessor generic image-preprocessor script" -j`
+`cmr "get preprocessor generic image-preprocessor script " -j`
#### New environment keys (filter)
* `+PYTHONPATH`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-preprocessed-dataset-imagenet/README.md b/cm-mlops/script/get-preprocessed-dataset-imagenet/README.md
index 95e0e8d8d9..83b0ea9348 100644
--- a/cm-mlops/script/get-preprocessed-dataset-imagenet/README.md
+++ b/cm-mlops/script/get-preprocessed-dataset-imagenet/README.md
@@ -1,64 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-preprocessed-dataset-imagenet**
-*Note that this README is automatically generated - don't edit!*
+Category: **AI/ML datasets**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-preprocessed-dataset-imagenet,f259d490bbaf45f5) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* 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-preprocessed-dataset-imagenet)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-imagenet)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,dataset,imagenet,ILSVRC,image-classification,preprocessed*
+* All CM tags to find and reuse this script (see in above meta description): *get,dataset,imagenet,ILSVRC,image-classification,preprocessed*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get dataset imagenet ILSVRC image-classification preprocessed" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,dataset,imagenet,ILSVRC,image-classification,preprocessed`
-1. `cm run script --tags=get,dataset,imagenet,ILSVRC,image-classification,preprocessed[,variations] [--input_flags]`
+`cm run script --tags=get,dataset,imagenet,ILSVRC,image-classification,preprocessed[,variations] [--input_flags]`
-2. `cmr "get dataset imagenet ILSVRC image-classification preprocessed[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get dataset imagenet ILSVRC image-classification preprocessed"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get dataset imagenet ILSVRC image-classification preprocessed [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -94,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,dataset,imagenet,I
#### Run this script via Docker (beta)
-`cm docker script "get dataset imagenet ILSVRC image-classification preprocessed[ variations]" [--input_flags]`
+`cm docker script "get dataset imagenet ILSVRC image-classification preprocessed[variations]" [--input_flags]`
___
### Customization
@@ -406,12 +397,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-imagenet/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-imagenet/_cm.json)***
* get,python3
* `if (CM_IMAGENET_PREPROCESSED_PATH != on)`
* CM names: `--adr.['python3', 'python']...`
@@ -434,19 +423,18 @@ ___
* `if (CM_DATASET_REFERENCE_PREPROCESSOR == 1) AND (CM_IMAGENET_PREPROCESSED_PATH != on)`
* CM names: `--adr.['inference-src']...`
- CM script: [get-mlperf-inference-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-src)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-imagenet/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-imagenet/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-imagenet/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-imagenet/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-imagenet/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-imagenet/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-imagenet/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-imagenet/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-imagenet/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-imagenet/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-imagenet/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-imagenet/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-imagenet/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-imagenet/_cm.json)
___
### Script output
-`cmr "get dataset imagenet ILSVRC image-classification preprocessed[,variations]" [--input_flags] -j`
+`cmr "get dataset imagenet ILSVRC image-classification preprocessed [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_DATASET_*`
@@ -458,8 +446,4 @@ ___
* `CM_DATASET_PREPROCESSED_IMAGES_LIST`
* `CM_DATASET_PREPROCESSED_PATH`
* `CM_DATASET_SIZE`
-* `CM_DATASET_TYPE`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_DATASET_TYPE`
\ No newline at end of file
diff --git a/cm-mlops/script/get-preprocessed-dataset-kits19/README.md b/cm-mlops/script/get-preprocessed-dataset-kits19/README.md
index e82be93120..396d134a9b 100644
--- a/cm-mlops/script/get-preprocessed-dataset-kits19/README.md
+++ b/cm-mlops/script/get-preprocessed-dataset-kits19/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-preprocessed-dataset-kits19**
-
+Category: **AI/ML datasets**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-preprocessed-dataset-kits19,2094d9b9ab6c4c9e) ]*
+
+---
#### Summary
-* 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-preprocessed-dataset-kits19)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-kits19)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,dataset,medical-imaging,kits19,preprocessed*
+* All CM tags to find and reuse this script (see in above meta description): *get,dataset,medical-imaging,kits19,preprocessed*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get dataset medical-imaging kits19 preprocessed" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,dataset,medical-imaging,kits19,preprocessed`
-1. `cm run script --tags=get,dataset,medical-imaging,kits19,preprocessed[,variations] [--input_flags]`
+`cm run script --tags=get,dataset,medical-imaging,kits19,preprocessed[,variations] [--input_flags]`
-2. `cmr "get dataset medical-imaging kits19 preprocessed[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get dataset medical-imaging kits19 preprocessed"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get dataset medical-imaging kits19 preprocessed [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,dataset,medical-im
#### Run this script via Docker (beta)
-`cm docker script "get dataset medical-imaging kits19 preprocessed[ variations]" [--input_flags]`
+`cm docker script "get dataset medical-imaging kits19 preprocessed[variations]" [--input_flags]`
___
### Customization
@@ -201,12 +195,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-kits19/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-kits19/_cm.json)***
* get,python3
* CM names: `--adr.['python3', 'python']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
@@ -223,25 +215,20 @@ ___
* get,generic-python-lib,_numpy
* CM names: `--adr.['numpy']...`
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-kits19/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-kits19/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-kits19/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-kits19/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-kits19/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-kits19/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-kits19/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-kits19/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-kits19/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-kits19/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-kits19/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-kits19/_cm.json)
___
### Script output
-`cmr "get dataset medical-imaging kits19 preprocessed[,variations]" [--input_flags] -j`
+`cmr "get dataset medical-imaging kits19 preprocessed [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_DATASET_*`
#### New environment keys auto-detected from customize
-* `CM_DATASET_PREPROCESSED_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_DATASET_PREPROCESSED_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-preprocessed-dataset-librispeech/README.md b/cm-mlops/script/get-preprocessed-dataset-librispeech/README.md
index acc71787c5..17156741ac 100644
--- a/cm-mlops/script/get-preprocessed-dataset-librispeech/README.md
+++ b/cm-mlops/script/get-preprocessed-dataset-librispeech/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-preprocessed-dataset-librispeech**
-
+Category: **AI/ML datasets**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-preprocessed-dataset-librispeech,e9f62fc969d5483a) ]*
+
+---
#### Summary
-* 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-preprocessed-dataset-librispeech)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-librispeech)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,dataset,speech-recognition,librispeech,preprocessed*
+* All CM tags to find and reuse this script (see in above meta description): *get,dataset,speech-recognition,librispeech,preprocessed*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get dataset speech-recognition librispeech preprocessed" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,dataset,speech-recognition,librispeech,preprocessed`
-1. `cm run script --tags=get,dataset,speech-recognition,librispeech,preprocessed[,variations] [--input_flags]`
+`cm run script --tags=get,dataset,speech-recognition,librispeech,preprocessed[,variations] [--input_flags]`
-2. `cmr "get dataset speech-recognition librispeech preprocessed[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get dataset speech-recognition librispeech preprocessed"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get dataset speech-recognition librispeech preprocessed [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,dataset,speech-rec
#### Run this script via Docker (beta)
-`cm docker script "get dataset speech-recognition librispeech preprocessed[ variations]" [--input_flags]`
+`cm docker script "get dataset speech-recognition librispeech preprocessed[variations]" [--input_flags]`
___
### Customization
@@ -189,12 +183,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-librispeech/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-librispeech/_cm.json)***
* get,python3
* CM names: `--adr.['python3', 'python']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
@@ -212,26 +204,21 @@ ___
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
* get,sys-util,generic,_sox
- CM script: [get-generic-sys-util](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-sys-util)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-librispeech/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-librispeech/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-librispeech/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-librispeech/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-librispeech/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-librispeech/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-librispeech/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-librispeech/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-librispeech/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-librispeech/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-librispeech/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-librispeech/_cm.json)
___
### Script output
-`cmr "get dataset speech-recognition librispeech preprocessed[,variations]" [--input_flags] -j`
+`cmr "get dataset speech-recognition librispeech preprocessed [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_DATASET_*`
#### New environment keys auto-detected from customize
* `CM_DATASET_PREPROCESSED_JSON`
-* `CM_DATASET_PREPROCESSED_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_DATASET_PREPROCESSED_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-preprocessed-dataset-openimages/README.md b/cm-mlops/script/get-preprocessed-dataset-openimages/README.md
index 1403bc44ec..d2deba2d80 100644
--- a/cm-mlops/script/get-preprocessed-dataset-openimages/README.md
+++ b/cm-mlops/script/get-preprocessed-dataset-openimages/README.md
@@ -1,64 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-preprocessed-dataset-openimages**
-*Note that this README is automatically generated - don't edit!*
+Category: **AI/ML datasets**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-preprocessed-dataset-openimages,9842f1be8cba4c7b) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* 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-preprocessed-dataset-openimages)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-openimages)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,dataset,openimages,open-images,object-detection,preprocessed*
+* All CM tags to find and reuse this script (see in above meta description): *get,dataset,openimages,open-images,object-detection,preprocessed*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get dataset openimages open-images object-detection preprocessed" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,dataset,openimages,open-images,object-detection,preprocessed`
-1. `cm run script --tags=get,dataset,openimages,open-images,object-detection,preprocessed[,variations] [--input_flags]`
+`cm run script --tags=get,dataset,openimages,open-images,object-detection,preprocessed[,variations] [--input_flags]`
-2. `cmr "get dataset openimages open-images object-detection preprocessed[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get dataset openimages open-images object-detection preprocessed"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get dataset openimages open-images object-detection preprocessed [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -94,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,dataset,openimages
#### Run this script via Docker (beta)
-`cm docker script "get dataset openimages open-images object-detection preprocessed[ variations]" [--input_flags]`
+`cm docker script "get dataset openimages open-images object-detection preprocessed[variations]" [--input_flags]`
___
### Customization
@@ -357,12 +348,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-openimages/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-openimages/_cm.json)***
* get,python3
* CM names: `--adr.['python3', 'python']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
@@ -387,19 +376,18 @@ ___
* get,generic-python-lib,_numpy
* CM names: `--adr.['numpy']...`
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-openimages/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-openimages/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-openimages/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-openimages/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-openimages/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-openimages/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-openimages/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-openimages/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-openimages/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-openimages/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-openimages/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-openimages/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-openimages/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-openimages/_cm.json)
___
### Script output
-`cmr "get dataset openimages open-images object-detection preprocessed[,variations]" [--input_flags] -j`
+`cmr "get dataset openimages open-images object-detection preprocessed [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_DATASET_*`
@@ -412,8 +400,4 @@ ___
* `CM_DATASET_PREPROCESSED_PATH`
* `CM_DATASET_QUANT_OFFSET`
* `CM_DATASET_QUANT_SCALE`
-* `CM_DATASET_TYPE`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_DATASET_TYPE`
\ No newline at end of file
diff --git a/cm-mlops/script/get-preprocessed-dataset-openorca/README.md b/cm-mlops/script/get-preprocessed-dataset-openorca/README.md
index dd252b6c61..44386e3a24 100644
--- a/cm-mlops/script/get-preprocessed-dataset-openorca/README.md
+++ b/cm-mlops/script/get-preprocessed-dataset-openorca/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-preprocessed-dataset-openorca**
-
+Category: **AI/ML datasets**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-preprocessed-dataset-openorca,5614c39cb1564d72) ]*
+---
#### Summary
-* 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-preprocessed-dataset-openorca)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-openorca)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,dataset,openorca,language-processing,preprocessed*
+* All CM tags to find and reuse this script (see in above meta description): *get,dataset,openorca,language-processing,preprocessed*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get dataset openorca language-processing preprocessed" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,dataset,openorca,language-processing,preprocessed`
-#### Run this script from command line
+`cm run script --tags=get,dataset,openorca,language-processing,preprocessed[,variations] `
-1. `cm run script --tags=get,dataset,openorca,language-processing,preprocessed[,variations] `
+*or*
-2. `cmr "get dataset openorca language-processing preprocessed[ variations]" `
+`cmr "get dataset openorca language-processing preprocessed"`
-* `variations` can be seen [here](#variations)
+`cmr "get dataset openorca language-processing preprocessed [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,dataset,openorca,l
#### Run this script via Docker (beta)
-`cm docker script "get dataset openorca language-processing preprocessed[ variations]" `
+`cm docker script "get dataset openorca language-processing preprocessed[variations]" `
___
### Customization
@@ -141,12 +138,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-openorca/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-openorca/_cm.json)***
* get,sys-utils-cm
- CM script: [get-sys-utils-cm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm)
* get,python3
@@ -166,25 +161,20 @@ ___
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
* get,ml-model,llama2
- CM script: [get-ml-model-llama2](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-llama2)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-openorca/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-openorca/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-openorca/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-openorca/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-openorca/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-openorca/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-openorca/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-openorca/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-openorca/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-openorca/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-openorca/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-openorca/_cm.json)
___
### Script output
-`cmr "get dataset openorca language-processing preprocessed[,variations]" -j`
+`cmr "get dataset openorca language-processing preprocessed [,variations]" -j`
#### New environment keys (filter)
* `CM_DATASET_PREPROCESSED_PATH`
#### New environment keys auto-detected from customize
-* `CM_DATASET_PREPROCESSED_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_DATASET_PREPROCESSED_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-preprocessed-dataset-squad/README.md b/cm-mlops/script/get-preprocessed-dataset-squad/README.md
index 9e1ec863a3..862ccfbc31 100644
--- a/cm-mlops/script/get-preprocessed-dataset-squad/README.md
+++ b/cm-mlops/script/get-preprocessed-dataset-squad/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-preprocessed-dataset-squad**
-
+Category: **AI/ML datasets**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-preprocessed-dataset-squad,7cd1d9b7e8af4788) ]*
+
+---
#### Summary
-* 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-preprocessed-dataset-squad)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-squad)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *get,dataset,preprocessed,tokenized,squad*
+* All CM tags to find and reuse this script (see in above meta description): *get,dataset,preprocessed,tokenized,squad*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get dataset preprocessed tokenized squad" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,dataset,preprocessed,tokenized,squad`
-1. `cm run script --tags=get,dataset,preprocessed,tokenized,squad[,variations] `
+`cm run script --tags=get,dataset,preprocessed,tokenized,squad[,variations] `
-2. `cmr "get dataset preprocessed tokenized squad[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get dataset preprocessed tokenized squad"`
+
+`cmr "get dataset preprocessed tokenized squad [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,dataset,preprocess
#### Run this script via Docker (beta)
-`cm docker script "get dataset preprocessed tokenized squad[ variations]" `
+`cm docker script "get dataset preprocessed tokenized squad[variations]" `
___
### Customization
@@ -193,12 +190,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-squad/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-squad/_cm.yaml)***
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
@@ -217,19 +212,18 @@ ___
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
* get,generic-python-lib,_package.tensorflow
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-squad/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-squad/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-squad/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-squad/_cm.yaml)
1. ***Run native script if exists***
- * [run-packed.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-squad/run-packed.sh)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-squad/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-squad/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-squad/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-squad/_cm.yaml)
-
+ * [run-packed.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-squad/run-packed.sh)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-squad/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-squad/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-squad/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-squad/_cm.yaml)
___
### Script output
-`cmr "get dataset preprocessed tokenized squad[,variations]" -j`
+`cmr "get dataset preprocessed tokenized squad [,variations]" -j`
#### New environment keys (filter)
* `CM_DATASET_SQUAD_TOKENIZED_*`
@@ -243,8 +237,4 @@ ___
* `CM_DATASET_SQUAD_TOKENIZED_PACKED_FILENAMES_FILE`
* `CM_DATASET_SQUAD_TOKENIZED_PICKLE_FILE`
* `CM_DATASET_SQUAD_TOKENIZED_ROOT`
-* `CM_DATASET_SQUAD_TOKENIZED_SEGMENT_IDS`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_DATASET_SQUAD_TOKENIZED_SEGMENT_IDS`
\ No newline at end of file
diff --git a/cm-mlops/script/get-python3/README.md b/cm-mlops/script/get-python3/README.md
index 26a199c3be..227637668a 100644
--- a/cm-mlops/script/get-python3/README.md
+++ b/cm-mlops/script/get-python3/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-python3**
-*Note that this README is automatically generated - don't edit!*
+Category: **Python automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-python3,d0b5dd74373f4a62) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Python automation.*
-* 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-python3)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-python3)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,python,python3,get-python,get-python3*
+* All CM tags to find and reuse this script (see in above meta description): *get,python,python3,get-python,get-python3*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get python python3 get-python get-python3" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,python,python3,get-python,get-python3`
-1. `cm run script --tags=get,python,python3,get-python,get-python3[,variations] `
+`cm run script --tags=get,python,python3,get-python,get-python3[,variations] `
-2. `cmr "get python python3 get-python get-python3[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get python python3 get-python get-python3"`
+
+`cmr "get python python3 get-python get-python3 [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,python,python3,get
#### Run this script via Docker (beta)
-`cm docker script "get python python3 get-python get-python3[ variations]" `
+`cm docker script "get python python3 get-python get-python3[variations]" `
___
### Customization
@@ -140,28 +134,25 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-python3/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-python3/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-python3/_cm.json)***
* install,python,src
* `if (CM_REQUIRE_INSTALL == yes)`
- CM script: [install-python-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-src)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-python3/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-python3/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-python3/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-python3/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-python3/_cm.json)
___
### Script output
-`cmr "get python python3 get-python get-python3[,variations]" -j`
+`cmr "get python python3 get-python get-python3 [,variations]" -j`
#### New environment keys (filter)
* `+C_INCLUDE_PATH`
@@ -176,8 +167,4 @@ ___
* `CM_PYTHON_CACHE_TAGS`
* `CM_PYTHON_MAJOR_VERSION`
* `CM_PYTHON_MINOR_VERSION`
-* `CM_PYTHON_PATCH_VERSION`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_PYTHON_PATCH_VERSION`
\ No newline at end of file
diff --git a/cm-mlops/script/get-qaic-apps-sdk/README.md b/cm-mlops/script/get-qaic-apps-sdk/README.md
index 4c7e7fa5d6..f235fbfcce 100644
--- a/cm-mlops/script/get-qaic-apps-sdk/README.md
+++ b/cm-mlops/script/get-qaic-apps-sdk/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-qaic-apps-sdk**
-
+Category: **AI/ML frameworks**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-qaic-apps-sdk,0a9e206af6764da9) ]*
+---
#### 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-qaic-apps-sdk)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-apps-sdk)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,detect,qaic,apps,sdk,apps-sdk,qaic-apps-sdk*
+* All CM tags to find and reuse this script (see in above meta description): *get,detect,qaic,apps,sdk,apps-sdk,qaic-apps-sdk*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get detect qaic apps sdk apps-sdk qaic-apps-sdk" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,detect,qaic,apps,sdk,apps-sdk,qaic-apps-sdk`
-#### Run this script from command line
+`cm run script --tags=get,detect,qaic,apps,sdk,apps-sdk,qaic-apps-sdk `
-1. `cm run script --tags=get,detect,qaic,apps,sdk,apps-sdk,qaic-apps-sdk `
+*or*
+
+`cmr "get detect qaic apps sdk apps-sdk qaic-apps-sdk"`
+
+`cmr "get detect qaic apps sdk apps-sdk qaic-apps-sdk " `
-2. `cmr "get detect qaic apps sdk apps-sdk qaic-apps-sdk" `
#### Run this script from Python
@@ -101,23 +99,20 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-apps-sdk/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-apps-sdk/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-apps-sdk/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-apps-sdk/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-apps-sdk/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-apps-sdk/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-apps-sdk/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-apps-sdk/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-apps-sdk/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-apps-sdk/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-apps-sdk/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-apps-sdk/_cm.json)
___
### Script output
-`cmr "get detect qaic apps sdk apps-sdk qaic-apps-sdk" -j`
+`cmr "get detect qaic apps sdk apps-sdk qaic-apps-sdk " -j`
#### New environment keys (filter)
* `+CPLUS_INCLUDE_PATH`
@@ -128,8 +123,4 @@ ___
* `CM_QAIC_EXEC_PATH`
#### New environment keys auto-detected from customize
-* `CM_QAIC_EXEC_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_QAIC_EXEC_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-qaic-platform-sdk/README.md b/cm-mlops/script/get-qaic-platform-sdk/README.md
index bfb4958de5..b63abaa41b 100644
--- a/cm-mlops/script/get-qaic-platform-sdk/README.md
+++ b/cm-mlops/script/get-qaic-platform-sdk/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-qaic-platform-sdk**
-
+Category: **AI/ML frameworks**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-qaic-platform-sdk,a60f86918dc9457d) ]*
+---
#### 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-qaic-platform-sdk)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-platform-sdk)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,detect,qaic,platform,sdk,platform-sdk,qaic-platform-sdk*
+* All CM tags to find and reuse this script (see in above meta description): *get,detect,qaic,platform,sdk,platform-sdk,qaic-platform-sdk*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get detect qaic platform sdk platform-sdk qaic-platform-sdk" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,detect,qaic,platform,sdk,platform-sdk,qaic-platform-sdk`
-#### Run this script from command line
+`cm run script --tags=get,detect,qaic,platform,sdk,platform-sdk,qaic-platform-sdk `
-1. `cm run script --tags=get,detect,qaic,platform,sdk,platform-sdk,qaic-platform-sdk `
+*or*
+
+`cmr "get detect qaic platform sdk platform-sdk qaic-platform-sdk"`
+
+`cmr "get detect qaic platform sdk platform-sdk qaic-platform-sdk " `
-2. `cmr "get detect qaic platform sdk platform-sdk qaic-platform-sdk" `
#### Run this script from Python
@@ -101,25 +99,22 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-platform-sdk/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-platform-sdk/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-platform-sdk/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-platform-sdk/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-platform-sdk/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-platform-sdk/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-platform-sdk/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-platform-sdk/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-platform-sdk/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-platform-sdk/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-platform-sdk/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-platform-sdk/_cm.json)
___
### Script output
-`cmr "get detect qaic platform sdk platform-sdk qaic-platform-sdk" -j`
+`cmr "get detect qaic platform sdk platform-sdk qaic-platform-sdk " -j`
#### New environment keys (filter)
* `+CPLUS_INCLUDE_PATH`
@@ -132,8 +127,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_QAIC_RUNNER_PATH`
-* `CM_QAIC_TOOLS_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_QAIC_TOOLS_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-qaic-software-kit/README.md b/cm-mlops/script/get-qaic-software-kit/README.md
index c091388755..6b78eb1c76 100644
--- a/cm-mlops/script/get-qaic-software-kit/README.md
+++ b/cm-mlops/script/get-qaic-software-kit/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-qaic-software-kit**
-
+Category: **AI/ML frameworks**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-qaic-software-kit,3344655922694bbb) ]*
+---
#### 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-qaic-software-kit)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-software-kit)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,qaic,software,kit,qaic-software-kit*
+* All CM tags to find and reuse this script (see in above meta description): *get,qaic,software,kit,qaic-software-kit*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get qaic software kit qaic-software-kit" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,qaic,software,kit,qaic-software-kit`
-#### Run this script from command line
+`cm run script --tags=get,qaic,software,kit,qaic-software-kit[,variations] `
-1. `cm run script --tags=get,qaic,software,kit,qaic-software-kit[,variations] `
+*or*
-2. `cmr "get qaic software kit qaic-software-kit[ variations]" `
+`cmr "get qaic software kit qaic-software-kit"`
-* `variations` can be seen [here](#variations)
+`cmr "get qaic software kit qaic-software-kit [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,qaic,software,kit,
#### Run this script via Docker (beta)
-`cm docker script "get qaic software kit qaic-software-kit[ variations]" `
+`cm docker script "get qaic software kit qaic-software-kit[variations]" `
___
### Customization
@@ -138,12 +135,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-software-kit/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-software-kit/_cm.json)***
* get,git,repo
* CM names: `--adr.['qaic-software-git-repo']...`
- CM script: [get-git-repo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo)
@@ -161,18 +156,17 @@ ___
- CM script: [get-cl](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cl)
- CM script: [get-gcc](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-gcc)
- CM script: [get-llvm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-llvm)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-software-kit/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-software-kit/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-software-kit/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-software-kit/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-software-kit/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-software-kit/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-software-kit/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-software-kit/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-software-kit/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-software-kit/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-software-kit/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-software-kit/_cm.json)
___
### Script output
-`cmr "get qaic software kit qaic-software-kit[,variations]" -j`
+`cmr "get qaic software kit qaic-software-kit [,variations]" -j`
#### New environment keys (filter)
* `+PATH`
@@ -181,8 +175,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_QAIC_RUNNER_PATH`
-* `CM_QAIC_SOFTWARE_KIT_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_QAIC_SOFTWARE_KIT_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-rclone/README.md b/cm-mlops/script/get-rclone/README.md
index a30753b525..415c071647 100644
--- a/cm-mlops/script/get-rclone/README.md
+++ b/cm-mlops/script/get-rclone/README.md
@@ -1,59 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ 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)
+Automatically generated README for this automation recipe: **get-rclone**
-
+Category: **Detection or installation of tools and artifacts**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-rclone,22ffb43c49c9419e) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-rclone)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-rclone)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,rclone*
+* All CM tags to find and reuse this script (see in above meta description): *get,rclone*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get rclone" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,rclone`
-#### Run this script from command line
+`cm run script --tags=get,rclone[,variations] `
-1. `cm run script --tags=get,rclone[,variations] `
+*or*
-2. `cmr "get rclone[ variations]" `
+`cmr "get rclone"`
-* `variations` can be seen [here](#variations)
+`cmr "get rclone [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -89,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,rclone) to generat
#### Run this script via Docker (beta)
-`cm docker script "get rclone[ variations]" `
+`cm docker script "get rclone[variations]" `
___
### Customization
@@ -126,27 +122,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
Default version: `1.65.2`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-rclone/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-rclone/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-rclone/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-rclone/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-rclone/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-rclone/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-rclone/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-rclone/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-rclone/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-rclone/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-rclone/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-rclone/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-rclone/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-rclone/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-rclone/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-rclone/_cm.json)
___
### Script output
-`cmr "get rclone[,variations]" -j`
+`cmr "get rclone [,variations]" -j`
#### New environment keys (filter)
* `+PATH`
@@ -156,8 +149,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_RCLONE_BIN_WITH_PATH`
-* `CM_RCLONE_CACHE_TAGS`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_RCLONE_CACHE_TAGS`
\ No newline at end of file
diff --git a/cm-mlops/script/get-rocm/README.md b/cm-mlops/script/get-rocm/README.md
index de76d0b405..50962358a2 100644
--- a/cm-mlops/script/get-rocm/README.md
+++ b/cm-mlops/script/get-rocm/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-rocm**
-
+Category: **AI/ML frameworks**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-rocm,23a69f9477cb4dab) ]*
+
+---
#### 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-rocm)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-rocm)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,rocm,get-rocm*
+* All CM tags to find and reuse this script (see in above meta description): *get,rocm,get-rocm*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get rocm get-rocm" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,rocm,get-rocm`
-1. `cm run script --tags=get,rocm,get-rocm `
+`cm run script --tags=get,rocm,get-rocm `
+
+*or*
+
+`cmr "get rocm get-rocm"`
+
+`cmr "get rocm get-rocm " `
-2. `cmr "get rocm get-rocm" `
#### Run this script from Python
@@ -101,27 +99,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-rocm/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-rocm/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-rocm/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-rocm/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-rocm/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-rocm/_cm.json)***
* install,rocm
* `if (CM_REQUIRE_INSTALL == yes)`
- CM script: [install-rocm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-rocm)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-rocm/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-rocm/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-rocm/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-rocm/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-rocm/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-rocm/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-rocm/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-rocm/_cm.json)
___
### Script output
-`cmr "get rocm get-rocm" -j`
+`cmr "get rocm get-rocm " -j`
#### New environment keys (filter)
* `+PATH`
@@ -129,8 +124,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_ROCM_CACHE_TAGS`
-* `CM_ROCM_INSTALLED_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_ROCM_INSTALLED_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-spec-ptd/README.md b/cm-mlops/script/get-spec-ptd/README.md
index 2a404cb34b..a3d397d21d 100644
--- a/cm-mlops/script/get-spec-ptd/README.md
+++ b/cm-mlops/script/get-spec-ptd/README.md
@@ -1,64 +1,64 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Input description](#input-description)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ 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)
-
-
+Automatically generated README for this automation recipe: **get-spec-ptd**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-spec-ptd,7423a878e4524136) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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-spec-ptd)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-spec-ptd)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,spec,ptd,ptdaemon,power,daemon,power-daemon,mlperf,mlcommons*
+* All CM tags to find and reuse this script (see in above meta description): *get,spec,ptd,ptdaemon,power,daemon,power-daemon,mlperf,mlcommons*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get spec ptd ptdaemon power daemon power-daemon mlperf mlcommons" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,spec,ptd,ptdaemon,power,daemon,power-daemon,mlperf,mlcommons`
-1. `cm run script --tags=get,spec,ptd,ptdaemon,power,daemon,power-daemon,mlperf,mlcommons [--input_flags]`
+`cm run script --tags=get,spec,ptd,ptdaemon,power,daemon,power-daemon,mlperf,mlcommons [--input_flags]`
-2. `cmr "get spec ptd ptdaemon power daemon power-daemon mlperf mlcommons" [--input_flags]`
+*or*
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get spec ptd ptdaemon power daemon power-daemon mlperf mlcommons"`
+`cmr "get spec ptd ptdaemon power daemon power-daemon mlperf mlcommons " [--input_flags]`
+
+
+
+#### Input Flags
+
+* --**input**=Path to SPEC PTDaemon (Optional)
+
+**Above CLI flags can be used in the Python CM API as follows:**
+
+```python
+r=cm.access({... , "input":...}
+```
#### Run this script from Python
@@ -99,16 +99,6 @@ ___
### Customization
-#### Input description
-
-* --**input** Path to SPEC PTDaemon (Optional)
-
-**Above CLI flags can be used in the Python CM API as follows:**
-
-```python
-r=cm.access({... , "input":...}
-```
-
#### Script flags mapped to environment
Click here to expand this section.
@@ -144,12 +134,10 @@ Default version: `main`
* `custom`
* `main`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-spec-ptd/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-spec-ptd/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,python3
@@ -157,18 +145,17 @@ ___
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
* get,git,repo,_repo.https://github.com/mlcommons/power
- 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-spec-ptd/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-spec-ptd/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-spec-ptd/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-spec-ptd/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-spec-ptd/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-spec-ptd/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-spec-ptd/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-spec-ptd/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-spec-ptd/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-spec-ptd/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-spec-ptd/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-spec-ptd/_cm.json)
___
### Script output
-`cmr "get spec ptd ptdaemon power daemon power-daemon mlperf mlcommons" [--input_flags] -j`
+`cmr "get spec ptd ptdaemon power daemon power-daemon mlperf mlcommons " [--input_flags] -j`
#### New environment keys (filter)
* `CM_MLPERF_PTD_PATH`
@@ -176,8 +163,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_MLPERF_PTD_PATH`
-* `CM_SPEC_PTD_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_SPEC_PTD_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-sys-utils-cm/README.md b/cm-mlops/script/get-sys-utils-cm/README.md
index 7bbf118fa2..4b1e6b0acb 100644
--- a/cm-mlops/script/get-sys-utils-cm/README.md
+++ b/cm-mlops/script/get-sys-utils-cm/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **get-sys-utils-cm**
-
+Category: **Detection or installation of tools and artifacts**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-sys-utils-cm,bc90993277e84b8e) ]*
+
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-sys-utils-cm)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-cm)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,sys-utils-cm*
+* All CM tags to find and reuse this script (see in above meta description): *get,sys-utils-cm*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get sys-utils-cm" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,sys-utils-cm`
-1. `cm run script --tags=get,sys-utils-cm[,variations] [--input_flags]`
+`cm run script --tags=get,sys-utils-cm[,variations] [--input_flags]`
-2. `cmr "get sys-utils-cm[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get sys-utils-cm"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get sys-utils-cm [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,sys-utils-cm) to g
#### Run this script via Docker (beta)
-`cm docker script "get sys-utils-cm[ variations]" [--input_flags]`
+`cm docker script "get sys-utils-cm[variations]" [--input_flags]`
___
### Customization
@@ -136,37 +130,29 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-cm/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-cm/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-cm/_cm.json)
1. ***Run native script if exists***
- * [run-arch.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm/run-arch.sh)
- * [run-debian.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm/run-debian.sh)
- * [run-macos.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm/run-macos.sh)
- * [run-rhel.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm/run-rhel.sh)
- * [run-sles.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm/run-sles.sh)
- * [run-ubuntu.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm/run-ubuntu.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm/_cm.json)
+ * [run-arch.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-cm/run-arch.sh)
+ * [run-debian.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-cm/run-debian.sh)
+ * [run-macos.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-cm/run-macos.sh)
+ * [run-rhel.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-cm/run-rhel.sh)
+ * [run-sles.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-cm/run-sles.sh)
+ * [run-ubuntu.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-cm/run-ubuntu.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-cm/_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/get-sys-utils-cm/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-cm/_cm.json)
___
### Script output
-`cmr "get sys-utils-cm[,variations]" [--input_flags] -j`
+`cmr "get sys-utils-cm [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `+PATH`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-sys-utils-min/README.md b/cm-mlops/script/get-sys-utils-min/README.md
index cea0f9657b..7197513dd9 100644
--- a/cm-mlops/script/get-sys-utils-min/README.md
+++ b/cm-mlops/script/get-sys-utils-min/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-sys-utils-min**
-
+Category: **Detection or installation of tools and artifacts**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-sys-utils-min,a9af7714d3d94779) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-sys-utils-min)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-min)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,sys-utils-min*
+* All CM tags to find and reuse this script (see in above meta description): *get,sys-utils-min*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get sys-utils-min" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,sys-utils-min`
-#### Run this script from command line
+`cm run script --tags=get,sys-utils-min `
-1. `cm run script --tags=get,sys-utils-min `
+*or*
+
+`cmr "get sys-utils-min"`
+
+`cmr "get sys-utils-min " `
-2. `cmr "get sys-utils-min" `
#### Run this script from Python
@@ -101,29 +99,21 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-min/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-min/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-min/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-min/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-min/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-min/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-min/_cm.json)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-min/_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/get-sys-utils-min/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-min/_cm.json)
___
### Script output
-`cmr "get sys-utils-min" -j`
+`cmr "get sys-utils-min " -j`
#### New environment keys (filter)
* `+PATH`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-target-device/README.md b/cm-mlops/script/get-target-device/README.md
index 6b814d302b..b598aeffd9 100644
--- a/cm-mlops/script/get-target-device/README.md
+++ b/cm-mlops/script/get-target-device/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-target-device**
-*Note that this README is automatically generated - don't edit!*
+Category: **Hardware automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-target-device,3709c39c71b84492) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Hardware automation.*
-* 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-target-device)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-target-device)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *get,target,device,target-device*
+* All CM tags to find and reuse this script (see in above meta description): *get,target,device,target-device*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get target device target-device" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,target,device,target-device`
-1. `cm run script --tags=get,target,device,target-device[,variations] `
+`cm run script --tags=get,target,device,target-device[,variations] `
-2. `cmr "get target device target-device[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get target device target-device"`
+
+`cmr "get target device target-device [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,target,device,targ
#### Run this script via Docker (beta)
-`cm docker script "get target device target-device[ variations]" `
+`cm docker script "get target device target-device[variations]" `
___
### Customization
@@ -129,12 +123,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-target-device/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-target-device/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -147,17 +139,16 @@ ___
* `if (CM_TARGET_DEVICE_ENV_TYPE == cuda)`
* CM names: `--adr.['get-cuda-devices', '46d133d9ef92422d']...`
- CM script: [get-cuda-devices](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda-devices)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-target-device/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-target-device/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-target-device/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-target-device/_cm.yaml)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-target-device/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-target-device/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-target-device/_cm.yaml)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-target-device/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-target-device/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-target-device/_cm.yaml)
___
### Script output
-`cmr "get target device target-device[,variations]" -j`
+`cmr "get target device target-device [,variations]" -j`
#### New environment keys (filter)
* `+ LDFLAGS`
@@ -173,8 +164,4 @@ ___
* `CUDA_HOME*`
#### New environment keys auto-detected from customize
-* `CM_TARGET_DEVICE_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_TARGET_DEVICE_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-tensorrt/README.md b/cm-mlops/script/get-tensorrt/README.md
index a9a6e3e207..d0562e558d 100644
--- a/cm-mlops/script/get-tensorrt/README.md
+++ b/cm-mlops/script/get-tensorrt/README.md
@@ -1,66 +1,67 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Input description](#input-description)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-tensorrt**
-*Note that this README is automatically generated - don't edit!*
+Category: **CUDA automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-tensorrt,2a84ca505e4c408d) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *CUDA automation.*
-* 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-tensorrt)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tensorrt)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,tensorrt,nvidia*
+* All CM tags to find and reuse this script (see in above meta description): *get,tensorrt,nvidia*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get tensorrt nvidia" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,tensorrt,nvidia`
-1. `cm run script --tags=get,tensorrt,nvidia[,variations] [--input_flags]`
+`cm run script --tags=get,tensorrt,nvidia[,variations] [--input_flags]`
-2. `cmr "get tensorrt nvidia[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get tensorrt nvidia"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "get tensorrt nvidia [variations]" [--input_flags]`
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
+
+
+#### Input Flags
+
+* --**input**=Full path to the installed TensorRT library (nvinfer)
+* --**tar_file**=Full path to the TensorRT Tar file downloaded from the Nvidia website (https://developer.nvidia.com/tensorrt)
+
+**Above CLI flags can be used in the Python CM API as follows:**
+
+```python
+r=cm.access({... , "input":...}
+```
#### Run this script from Python
@@ -95,7 +96,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,tensorrt,nvidia) t
#### Run this script via Docker (beta)
-`cm docker script "get tensorrt nvidia[ variations]" [--input_flags]`
+`cm docker script "get tensorrt nvidia[variations]" [--input_flags]`
___
### Customization
@@ -115,17 +116,6 @@ ___
-#### Input description
-
-* --**input** Full path to the installed TensorRT library (nvinfer)
-* --**tar_file** Full path to the TensorRT Tar file downloaded from the Nvidia website (https://developer.nvidia.com/tensorrt)
-
-**Above CLI flags can be used in the Python CM API as follows:**
-
-```python
-r=cm.access({... , "input":...}
-```
-
#### Script flags mapped to environment
Click here to expand this section.
@@ -152,29 +142,26 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tensorrt/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tensorrt/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tensorrt/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tensorrt/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tensorrt/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tensorrt/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tensorrt/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tensorrt/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tensorrt/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tensorrt/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tensorrt/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tensorrt/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tensorrt/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tensorrt/_cm.json)
___
### Script output
-`cmr "get tensorrt nvidia[,variations]" [--input_flags] -j`
+`cmr "get tensorrt nvidia [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `+ LDFLAGS`
@@ -188,8 +175,4 @@ ___
* `CM_TENSORRT_INSTALL_PATH`
* `CM_TENSORRT_LIB_PATH`
-* `CM_TENSORRT_VERSION`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_TENSORRT_VERSION`
\ No newline at end of file
diff --git a/cm-mlops/script/get-terraform/README.md b/cm-mlops/script/get-terraform/README.md
index a83e739276..f15886e9a5 100644
--- a/cm-mlops/script/get-terraform/README.md
+++ b/cm-mlops/script/get-terraform/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-terraform**
-*Note that this README is automatically generated - don't edit!*
+Category: **Cloud automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-terraform,66b33c38a4d7461e) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Cloud automation.*
-* 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-terraform)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-terraform)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,terraform,get-terraform*
+* All CM tags to find and reuse this script (see in above meta description): *get,terraform,get-terraform*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get terraform get-terraform" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,terraform,get-terraform`
-1. `cm run script --tags=get,terraform,get-terraform `
+`cm run script --tags=get,terraform,get-terraform `
+
+*or*
+
+`cmr "get terraform get-terraform"`
+
+`cmr "get terraform get-terraform " `
-2. `cmr "get terraform get-terraform" `
#### Run this script from Python
@@ -104,27 +99,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-terraform/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-terraform/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-terraform/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-terraform/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-terraform/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-terraform/_cm.json)***
* install,terraform
* `if (CM_REQUIRE_INSTALL == yes)`
- CM script: [install-terraform-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-terraform-from-src)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-terraform/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-terraform/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-terraform/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-terraform/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-terraform/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-terraform/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-terraform/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-terraform/_cm.json)
___
### Script output
-`cmr "get terraform get-terraform" -j`
+`cmr "get terraform get-terraform " -j`
#### New environment keys (filter)
* `+PATH`
@@ -132,8 +124,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_TERRAFORM_CACHE_TAGS`
-* `CM_TERRAFORM_INSTALLED_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_TERRAFORM_INSTALLED_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/get-tvm-model/README.md b/cm-mlops/script/get-tvm-model/README.md
index 7d8b8360eb..ddced43751 100644
--- a/cm-mlops/script/get-tvm-model/README.md
+++ b/cm-mlops/script/get-tvm-model/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-tvm-model**
-*Note that this README is automatically generated - don't edit!*
+Category: **AI/ML models**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-tvm-model,c1b7b656b6224307) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *AI/ML models.*
-* 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-tvm-model)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tvm-model)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,ml-model-tvm,tvm-model*
+* All CM tags to find and reuse this script (see in above meta description): *get,ml-model-tvm,tvm-model*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get ml-model-tvm tvm-model" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,ml-model-tvm,tvm-model`
-1. `cm run script --tags=get,ml-model-tvm,tvm-model[,variations] `
+`cm run script --tags=get,ml-model-tvm,tvm-model[,variations] `
-2. `cmr "get ml-model-tvm tvm-model[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get ml-model-tvm tvm-model"`
+
+`cmr "get ml-model-tvm tvm-model [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,ml-model-tvm,tvm-m
#### Run this script via Docker (beta)
-`cm docker script "get ml-model-tvm tvm-model[ variations]" `
+`cm docker script "get ml-model-tvm tvm-model[variations]" `
___
### Customization
@@ -234,12 +228,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tvm-model/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tvm-model/_cm.json)***
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
@@ -254,8 +246,8 @@ ___
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
* get,generic-python-lib,_attrs
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tvm-model/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tvm-model/_cm.json)***
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tvm-model/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tvm-model/_cm.json)***
* get,ml-model,raw
* CM names: `--adr.['original-model']...`
- CM script: [get-ml-model-3d-unet-kits19](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-3d-unet-kits19)
@@ -273,15 +265,14 @@ ___
- CM script: [get-ml-model-stable-diffusion](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-stable-diffusion)
- CM script: [get-ml-model-tiny-resnet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-tiny-resnet)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tvm-model/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tvm-model/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tvm-model/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tvm-model/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tvm-model/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tvm-model/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tvm-model/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tvm-model/_cm.json)
___
### Script output
-`cmr "get ml-model-tvm tvm-model[,variations]" -j`
+`cmr "get ml-model-tvm tvm-model [,variations]" -j`
#### New environment keys (filter)
* `CM_ML_MODEL_*`
@@ -296,8 +287,4 @@ ___
* `CM_ML_MODEL_ORIGINAL_FILE_WITH_PATH`
* `CM_ML_MODEL_PATH`
* `CM_TUNE_TVM_MODEL`
-* `CM_TVM_FRONTEND_FRAMEWORK`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_TVM_FRONTEND_FRAMEWORK`
\ No newline at end of file
diff --git a/cm-mlops/script/get-tvm/README.md b/cm-mlops/script/get-tvm/README.md
index 41e00aad87..9c7fafd64d 100644
--- a/cm-mlops/script/get-tvm/README.md
+++ b/cm-mlops/script/get-tvm/README.md
@@ -1,62 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ 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)
-
-
+Automatically generated README for this automation recipe: **get-tvm**
-*Note that this README is automatically generated - don't edit!*
+Category: **AI/ML frameworks**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-tvm,93c89140e6224f4b) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### 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-tvm)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tvm)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,tvm,get-tvm*
+* All CM tags to find and reuse this script (see in above meta description): *get,tvm,get-tvm*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get tvm get-tvm" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,tvm,get-tvm`
-1. `cm run script --tags=get,tvm,get-tvm[,variations] `
+`cm run script --tags=get,tvm,get-tvm[,variations] `
-2. `cmr "get tvm get-tvm[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "get tvm get-tvm"`
+
+`cmr "get tvm get-tvm [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -92,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,tvm,get-tvm) to ge
#### Run this script via Docker (beta)
-`cm docker script "get tvm get-tvm[ variations]" `
+`cm docker script "get tvm get-tvm[variations]" `
___
### Customization
@@ -165,12 +158,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
* `v0.8.0`
* `v0.9.0`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tvm/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tvm/_cm.json)***
* cmake,get-cmake
- CM script: [get-cmake](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmake)
* detect,cpu
@@ -185,18 +176,17 @@ ___
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
* get,generic-python-lib,_psutil
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tvm/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tvm/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tvm/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tvm/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tvm/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tvm/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tvm/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tvm/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tvm/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tvm/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tvm/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tvm/_cm.json)
___
### Script output
-`cmr "get tvm get-tvm[,variations]" -j`
+`cmr "get tvm get-tvm [,variations]" -j`
#### New environment keys (filter)
* `+DYLD_FALLBACK_LIBRARY_PATH`
@@ -207,8 +197,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_TVM_PATH_INCLUDE`
-* `CM_TVM_PATH_LIB`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_TVM_PATH_LIB`
\ No newline at end of file
diff --git a/cm-mlops/script/get-xilinx-sdk/README.md b/cm-mlops/script/get-xilinx-sdk/README.md
index eff4edb4f0..2b402b84cc 100644
--- a/cm-mlops/script/get-xilinx-sdk/README.md
+++ b/cm-mlops/script/get-xilinx-sdk/README.md
@@ -1,59 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ 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)
+Automatically generated README for this automation recipe: **get-xilinx-sdk**
-
+Category: **Detection or installation of tools and artifacts**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-xilinx-sdk,76d4d1bd09df4490) ]*
+
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-xilinx-sdk)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-xilinx-sdk)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,xilinx,sdk*
+* All CM tags to find and reuse this script (see in above meta description): *get,xilinx,sdk*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get xilinx sdk" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,xilinx,sdk`
-1. `cm run script --tags=get,xilinx,sdk [--input_flags]`
+`cm run script --tags=get,xilinx,sdk [--input_flags]`
-2. `cmr "get xilinx sdk" [--input_flags]`
+*or*
+
+`cmr "get xilinx sdk"`
+
+`cmr "get xilinx sdk " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -124,31 +118,23 @@ Default version: `2019.1`
* `2019.1`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-xilinx-sdk/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-xilinx-sdk/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-xilinx-sdk/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-xilinx-sdk/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-xilinx-sdk/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-xilinx-sdk/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-xilinx-sdk/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-xilinx-sdk/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-xilinx-sdk/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-xilinx-sdk/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-xilinx-sdk/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-xilinx-sdk/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-xilinx-sdk/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-xilinx-sdk/_cm.json)
___
### Script output
-`cmr "get xilinx sdk" [--input_flags] -j`
+`cmr "get xilinx sdk " [--input_flags] -j`
#### New environment keys (filter)
* `+PATH`
* `CM_XILINX_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-zendnn/README.md b/cm-mlops/script/get-zendnn/README.md
index 3ff06df97a..d3f560dcab 100644
--- a/cm-mlops/script/get-zendnn/README.md
+++ b/cm-mlops/script/get-zendnn/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **get-zendnn**
-
+Category: **Detection or installation of tools and artifacts**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-zendnn,d1c6feb0ee684b09) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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-zendnn)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zendnn)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,zendnn,amd,from.src*
+* All CM tags to find and reuse this script (see in above meta description): *get,zendnn,amd,from.src*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get zendnn amd from.src" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,zendnn,amd,from.src`
-#### Run this script from command line
+`cm run script --tags=get,zendnn,amd,from.src `
-1. `cm run script --tags=get,zendnn,amd,from.src `
+*or*
+
+`cmr "get zendnn amd from.src"`
+
+`cmr "get zendnn amd from.src " `
-2. `cmr "get zendnn amd from.src" `
#### Run this script from Python
@@ -101,12 +99,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zendnn/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zendnn/_cm.json)***
* get,amd,aocl
* CM names: `--adr.['aocl']...`
- CM script: [get-aocl](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-aocl)
@@ -116,24 +112,18 @@ ___
- CM script: [detect-cpu](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
* get,git,_repo.https://github.com/amd/ZenDNN.git
- 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-zendnn/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zendnn/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zendnn/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zendnn/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zendnn/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zendnn/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zendnn/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zendnn/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zendnn/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zendnn/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zendnn/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zendnn/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zendnn/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zendnn/_cm.json)
___
### Script output
-`cmr "get zendnn amd from.src" -j`
+`cmr "get zendnn amd from.src " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-zephyr-sdk/README.md b/cm-mlops/script/get-zephyr-sdk/README.md
index ca28fbe836..070b698cf7 100644
--- a/cm-mlops/script/get-zephyr-sdk/README.md
+++ b/cm-mlops/script/get-zephyr-sdk/README.md
@@ -1,59 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-zephyr-sdk**
-*Note that this README is automatically generated - don't edit!*
+Category: **TinyML automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-zephyr-sdk,c70ae1a7567f4a7b) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *TinyML automation.*
-* 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-zephyr-sdk)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zephyr-sdk)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,zephyr-sdk*
+* All CM tags to find and reuse this script (see in above meta description): *get,zephyr-sdk*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get zephyr-sdk" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,zephyr-sdk`
-#### Run this script from command line
+`cm run script --tags=get,zephyr-sdk `
-1. `cm run script --tags=get,zephyr-sdk `
+*or*
+
+`cmr "get zephyr-sdk"`
+
+`cmr "get zephyr-sdk " `
-2. `cmr "get zephyr-sdk" `
#### Run this script from Python
@@ -111,32 +105,24 @@ Default version: `0.13.2`
* `0.13.2`
* `0.15.0`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zephyr-sdk/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zephyr-sdk/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zephyr-sdk/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zephyr-sdk/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zephyr-sdk/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zephyr-sdk/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zephyr-sdk/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zephyr-sdk/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zephyr-sdk/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zephyr-sdk/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zephyr-sdk/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zephyr-sdk/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zephyr-sdk/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zephyr-sdk/_cm.json)
___
### Script output
-`cmr "get zephyr-sdk" -j`
+`cmr "get zephyr-sdk " -j`
#### New environment keys (filter)
* `ZEPHYR_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/get-zephyr/README.md b/cm-mlops/script/get-zephyr/README.md
index fb7b53ea03..5b31dbb4f2 100644
--- a/cm-mlops/script/get-zephyr/README.md
+++ b/cm-mlops/script/get-zephyr/README.md
@@ -1,59 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-
-
+Automatically generated README for this automation recipe: **get-zephyr**
-*Note that this README is automatically generated - don't edit!*
+Category: **TinyML automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=get-zephyr,d4105c2cdb044276) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *TinyML automation.*
-* 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-zephyr)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zephyr)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,zephyr*
+* All CM tags to find and reuse this script (see in above meta description): *get,zephyr*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get zephyr" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=get,zephyr`
-1. `cm run script --tags=get,zephyr `
+`cm run script --tags=get,zephyr `
+
+*or*
+
+`cmr "get zephyr"`
+
+`cmr "get zephyr " `
-2. `cmr "get zephyr" `
#### Run this script from Python
@@ -109,12 +103,10 @@ Default version: `v2.7`
* `v2.7`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zephyr/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zephyr/_cm.json)***
* get,python3
* CM names: `--adr.['python3', 'python']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
@@ -122,26 +114,21 @@ ___
- CM script: [get-cmake](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmake)
* get,generic-python-lib,_west
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zephyr/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zephyr/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zephyr/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zephyr/_cm.json)
1. ***Run native script if exists***
- * [run-ubuntu.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zephyr/run-ubuntu.sh)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zephyr/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zephyr/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zephyr/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zephyr/_cm.json)
-
+ * [run-ubuntu.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zephyr/run-ubuntu.sh)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zephyr/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zephyr/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zephyr/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zephyr/_cm.json)
___
### Script output
-`cmr "get zephyr" -j`
+`cmr "get zephyr " -j`
#### New environment keys (filter)
* `CM_ZEPHYR_*`
#### New environment keys auto-detected from customize
-* `CM_ZEPHYR_DIR`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_ZEPHYR_DIR`
\ No newline at end of file
diff --git a/cm-mlops/script/gui/README.md b/cm-mlops/script/gui/README.md
index 4237b832c5..20ee96c07c 100644
--- a/cm-mlops/script/gui/README.md
+++ b/cm-mlops/script/gui/README.md
@@ -1,31 +1,15 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Input description](#input-description)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **gui**
-
+Category: **GUI**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Developers: [Grigori Fursin](https://cKnowledge.org/gfursin)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=gui,605cac42514a4c69) ]*
+
+---
This CM script provides a unified GUI to run CM scripts using [Streamlit library](https://streamlit.io).
@@ -43,37 +27,60 @@ python3 -m http.server 80
```
+
+---
#### Summary
-* Category: *GUI.*
-* 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/gui)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/gui)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *cm,gui,cm-gui,script-gui,cm-script-gui,streamlit*
+* All CM tags to find and reuse this script (see in above meta description): *cm,gui,cm-gui,script-gui,cm-script-gui,streamlit*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "cm gui cm-gui script-gui cm-script-gui streamlit" --help````
-#### Run this script from command line
+#### Customize and run this script from the command line with different variations and flags
-1. `cm run script --tags=cm,gui,cm-gui,script-gui,cm-script-gui,streamlit[,variations] [--input_flags]`
+`cm run script --tags=cm,gui,cm-gui,script-gui,cm-script-gui,streamlit`
-2. `cmr "cm gui cm-gui script-gui cm-script-gui streamlit[ variations]" [--input_flags]`
+`cm run script --tags=cm,gui,cm-gui,script-gui,cm-script-gui,streamlit[,variations] [--input_flags]`
-* `variations` can be seen [here](#variations)
+*or*
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "cm gui cm-gui script-gui cm-script-gui streamlit"`
+
+`cmr "cm gui cm-gui script-gui cm-script-gui streamlit [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
+
+
+#### Input Flags
+
+* --**script**=script tags
+* --**app**=gui app
+
+**Above CLI flags can be used in the Python CM API as follows:**
+```python
+r=cm.access({... , "script":...}
+```
#### Run this script from Python
@@ -108,7 +115,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=cm,gui,cm-gui,script-g
#### Run this script via Docker (beta)
-`cm docker script "cm gui cm-gui script-gui cm-script-gui streamlit[ variations]" [--input_flags]`
+`cm docker script "cm gui cm-gui script-gui cm-script-gui streamlit[variations]" [--input_flags]`
___
### Customization
@@ -160,17 +167,6 @@ ___
-#### Input description
-
-* --**script** script tags
-* --**app** gui app
-
-**Above CLI flags can be used in the Python CM API as follows:**
-
-```python
-r=cm.access({... , "script":...}
-```
-
#### Script flags mapped to environment
Click here to expand this section.
@@ -215,12 +211,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/gui/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/gui/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -234,24 +228,18 @@ ___
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
* get,generic-python-lib,_streamlit
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/gui/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/gui/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/gui/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/gui/_cm.yaml)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/gui/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/gui/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/gui/_cm.yaml)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/gui/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/gui/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/gui/_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/gui/_cm.yaml)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/gui/_cm.yaml)
___
### Script output
-`cmr "cm gui cm-gui script-gui cm-script-gui streamlit[,variations]" [--input_flags] -j`
+`cmr "cm gui cm-gui script-gui cm-script-gui streamlit [,variations]" [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/import-mlperf-inference-to-experiment/README.md b/cm-mlops/script/import-mlperf-inference-to-experiment/README.md
index 8073adfb9b..1a02202258 100644
--- a/cm-mlops/script/import-mlperf-inference-to-experiment/README.md
+++ b/cm-mlops/script/import-mlperf-inference-to-experiment/README.md
@@ -1,64 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **import-mlperf-inference-to-experiment**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Developers: [Grigori Fursin](https://cKnowledge.org/gfursin)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=import-mlperf-inference-to-experiment,72099fa962ea499c) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/import-mlperf-inference-to-experiment)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-inference-to-experiment)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *import,mlperf,inference,mlperf-inference,experiment,2experiment,to-experiment*
+* All CM tags to find and reuse this script (see in above meta description): *import,mlperf,inference,mlperf-inference,experiment,2experiment,to-experiment*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "import mlperf inference mlperf-inference experiment 2experiment to-experiment" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=import,mlperf,inference,mlperf-inference,experiment,2experiment,to-experiment`
-1. `cm run script --tags=import,mlperf,inference,mlperf-inference,experiment,2experiment,to-experiment[,variations] [--input_flags]`
+`cm run script --tags=import,mlperf,inference,mlperf-inference,experiment,2experiment,to-experiment[,variations] [--input_flags]`
-2. `cmr "import mlperf inference mlperf-inference experiment 2experiment to-experiment[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "import mlperf inference mlperf-inference experiment 2experiment to-experiment"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "import mlperf inference mlperf-inference experiment 2experiment to-experiment [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -94,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=import,mlperf,inferenc
#### Run this script via Docker (beta)
-`cm docker script "import mlperf inference mlperf-inference experiment 2experiment to-experiment[ variations]" [--input_flags]`
+`cm docker script "import mlperf inference mlperf-inference experiment 2experiment to-experiment[variations]" [--input_flags]`
___
### Customization
@@ -118,12 +109,13 @@ ___
Click here to expand this section.
+* `--submitter=value` → `CM_MLPERF_SUBMITTER=value`
* `--target_repo=value` → `CM_IMPORT_MLPERF_INFERENCE_TARGET_REPO=value`
**Above CLI flags can be used in the Python CM API as follows:**
```python
-r=cm.access({... , "target_repo":...}
+r=cm.access({... , "submitter":...}
```
@@ -139,32 +131,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/import-mlperf-inference-to-experiment/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-inference-to-experiment/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,sys-utils-cm
- CM script: [get-sys-utils-cm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/import-mlperf-inference-to-experiment/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/import-mlperf-inference-to-experiment/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-inference-to-experiment/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-inference-to-experiment/_cm.yaml)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/import-mlperf-inference-to-experiment/_cm.yaml)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-inference-to-experiment/_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/import-mlperf-inference-to-experiment/_cm.yaml)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-inference-to-experiment/_cm.yaml)
___
### Script output
-`cmr "import mlperf inference mlperf-inference experiment 2experiment to-experiment[,variations]" [--input_flags] -j`
+`cmr "import mlperf inference mlperf-inference experiment 2experiment to-experiment [,variations]" [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/import-mlperf-tiny-to-experiment/README.md b/cm-mlops/script/import-mlperf-tiny-to-experiment/README.md
index 92c1e31ebf..ab2cf804d1 100644
--- a/cm-mlops/script/import-mlperf-tiny-to-experiment/README.md
+++ b/cm-mlops/script/import-mlperf-tiny-to-experiment/README.md
@@ -1,61 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **import-mlperf-tiny-to-experiment**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Developers: [Grigori Fursin](https://cKnowledge.org/gfursin)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=import-mlperf-tiny-to-experiment,83e3efd7611f469b) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/import-mlperf-tiny-to-experiment)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-tiny-to-experiment)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *import,mlperf,tiny,mlperf-tiny,experiment,2experiment,to-experiment*
+* All CM tags to find and reuse this script (see in above meta description): *import,mlperf,tiny,mlperf-tiny,experiment,2experiment,to-experiment*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "import mlperf tiny mlperf-tiny experiment 2experiment to-experiment" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=import,mlperf,tiny,mlperf-tiny,experiment,2experiment,to-experiment`
-1. `cm run script --tags=import,mlperf,tiny,mlperf-tiny,experiment,2experiment,to-experiment [--input_flags]`
+`cm run script --tags=import,mlperf,tiny,mlperf-tiny,experiment,2experiment,to-experiment [--input_flags]`
-2. `cmr "import mlperf tiny mlperf-tiny experiment 2experiment to-experiment" [--input_flags]`
+*or*
+
+`cmr "import mlperf tiny mlperf-tiny experiment 2experiment to-experiment"`
+
+`cmr "import mlperf tiny mlperf-tiny experiment 2experiment to-experiment " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -122,32 +114,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/import-mlperf-tiny-to-experiment/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-tiny-to-experiment/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,sys-utils-cm
- CM script: [get-sys-utils-cm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/import-mlperf-tiny-to-experiment/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/import-mlperf-tiny-to-experiment/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-tiny-to-experiment/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-tiny-to-experiment/_cm.yaml)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/import-mlperf-tiny-to-experiment/_cm.yaml)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-tiny-to-experiment/_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/import-mlperf-tiny-to-experiment/_cm.yaml)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-tiny-to-experiment/_cm.yaml)
___
### Script output
-`cmr "import mlperf tiny mlperf-tiny experiment 2experiment to-experiment" [--input_flags] -j`
+`cmr "import mlperf tiny mlperf-tiny experiment 2experiment to-experiment " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/import-mlperf-training-to-experiment/README.md b/cm-mlops/script/import-mlperf-training-to-experiment/README.md
index 51e332cc9d..4de8407719 100644
--- a/cm-mlops/script/import-mlperf-training-to-experiment/README.md
+++ b/cm-mlops/script/import-mlperf-training-to-experiment/README.md
@@ -1,61 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **import-mlperf-training-to-experiment**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Developers: [Grigori Fursin](https://cKnowledge.org/gfursin)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=import-mlperf-training-to-experiment,b13d9b7337414f17) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/import-mlperf-training-to-experiment)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-training-to-experiment)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *import,mlperf,training,mlperf-training,experiment,2experiment,to-experiment*
+* All CM tags to find and reuse this script (see in above meta description): *import,mlperf,training,mlperf-training,experiment,2experiment,to-experiment*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "import mlperf training mlperf-training experiment 2experiment to-experiment" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=import,mlperf,training,mlperf-training,experiment,2experiment,to-experiment`
-1. `cm run script --tags=import,mlperf,training,mlperf-training,experiment,2experiment,to-experiment [--input_flags]`
+`cm run script --tags=import,mlperf,training,mlperf-training,experiment,2experiment,to-experiment [--input_flags]`
-2. `cmr "import mlperf training mlperf-training experiment 2experiment to-experiment" [--input_flags]`
+*or*
+
+`cmr "import mlperf training mlperf-training experiment 2experiment to-experiment"`
+
+`cmr "import mlperf training mlperf-training experiment 2experiment to-experiment " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -122,12 +114,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/import-mlperf-training-to-experiment/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-training-to-experiment/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,sys-utils-cm
@@ -137,23 +127,17 @@ ___
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
* get,mlperf,logging
- CM script: [get-mlperf-logging](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-logging)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/import-mlperf-training-to-experiment/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/import-mlperf-training-to-experiment/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-training-to-experiment/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-training-to-experiment/_cm.yaml)
1. ***Run native script if exists***
- * [run_mlperf_logger.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/import-mlperf-training-to-experiment/run_mlperf_logger.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/import-mlperf-training-to-experiment/_cm.yaml)
+ * [run_mlperf_logger.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-training-to-experiment/run_mlperf_logger.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-training-to-experiment/_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/import-mlperf-training-to-experiment/_cm.yaml)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-training-to-experiment/_cm.yaml)
___
### Script output
-`cmr "import mlperf training mlperf-training experiment 2experiment to-experiment" [--input_flags] -j`
+`cmr "import mlperf training mlperf-training experiment 2experiment to-experiment " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/install-aws-cli/README.md b/cm-mlops/script/install-aws-cli/README.md
index a25ad4b2bd..9b2f8718b0 100644
--- a/cm-mlops/script/install-aws-cli/README.md
+++ b/cm-mlops/script/install-aws-cli/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **install-aws-cli**
-
+Category: **Cloud automation**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-aws-cli,4d3efd333c3f4d36) ]*
+---
#### Summary
-* Category: *Cloud automation.*
-* 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/install-aws-cli)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-aws-cli)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,script,aws-cli,aws,cli*
+* All CM tags to find and reuse this script (see in above meta description): *install,script,aws-cli,aws,cli*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install script aws-cli aws cli" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,script,aws-cli,aws,cli`
-#### Run this script from command line
+`cm run script --tags=install,script,aws-cli,aws,cli `
-1. `cm run script --tags=install,script,aws-cli,aws,cli `
+*or*
+
+`cmr "install script aws-cli aws cli"`
+
+`cmr "install script aws-cli aws cli " `
-2. `cmr "install script aws-cli aws cli" `
#### Run this script from Python
@@ -101,34 +99,26 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-aws-cli/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-aws-cli/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-aws-cli/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-aws-cli/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-aws-cli/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-aws-cli/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-aws-cli/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-aws-cli/_cm.json)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-aws-cli/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-aws-cli/_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/install-aws-cli/_cm.json)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-aws-cli/_cm.json)***
* get,aws-cli
* `if (CM_REQUIRE_INSTALL != yes)`
- CM script: [get-aws-cli](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-aws-cli)
-
___
### Script output
-`cmr "install script aws-cli aws cli" -j`
+`cmr "install script aws-cli aws cli " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/install-bazel/README.md b/cm-mlops/script/install-bazel/README.md
index 4bcee553ef..7eb6119d07 100644
--- a/cm-mlops/script/install-bazel/README.md
+++ b/cm-mlops/script/install-bazel/README.md
@@ -1,56 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
+Automatically generated README for this automation recipe: **install-bazel**
-
+Category: **Detection or installation of tools and artifacts**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-bazel,dfd3d2bf5b764175) ]*
+
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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/install-bazel)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-bazel)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,script,bazel*
+* All CM tags to find and reuse this script (see in above meta description): *install,script,bazel*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install script bazel" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=install,script,bazel`
-1. `cm run script --tags=install,script,bazel `
+`cm run script --tags=install,script,bazel `
+
+*or*
+
+`cmr "install script bazel"`
+
+`cmr "install script bazel " `
-2. `cmr "install script bazel" `
#### Run this script from Python
@@ -105,31 +102,28 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
Default version: `7.0.2`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-bazel/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-bazel/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-bazel/customize.py)***
- 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 "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-bazel/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/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)
+ * [run-aarch64.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-bazel/run-aarch64.sh)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-bazel/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-bazel/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-bazel/_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/install-bazel/_cm.json)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-bazel/_cm.json)***
* get,bazel
* `if (CM_REQUIRE_INSTALL != yes)`
- CM script: [get-bazel](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-bazel)
-
___
### Script output
-`cmr "install script bazel" -j`
+`cmr "install script bazel " -j`
#### New environment keys (filter)
* `CM_BAZEL_*`
@@ -138,8 +132,4 @@ ___
* `CM_BAZEL_BIN_WITH_PATH`
* `CM_BAZEL_DOWNLOAD_FILE`
* `CM_BAZEL_DOWNLOAD_URL`
-* `CM_BAZEL_INSTALLED_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_BAZEL_INSTALLED_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/install-cmake-prebuilt/README.md b/cm-mlops/script/install-cmake-prebuilt/README.md
index 5991cc1131..89bc1c9144 100644
--- a/cm-mlops/script/install-cmake-prebuilt/README.md
+++ b/cm-mlops/script/install-cmake-prebuilt/README.md
@@ -1,56 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
+Automatically generated README for this automation recipe: **install-cmake-prebuilt**
-
+Category: **Detection or installation of tools and artifacts**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-cmake-prebuilt,5a39ef05992b4103) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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/install-cmake-prebuilt)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cmake-prebuilt)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,prebuilt,cmake,prebuilt-cmake,install-prebuilt-cmake*
+* All CM tags to find and reuse this script (see in above meta description): *install,prebuilt,cmake,prebuilt-cmake,install-prebuilt-cmake*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install prebuilt cmake prebuilt-cmake install-prebuilt-cmake" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,prebuilt,cmake,prebuilt-cmake,install-prebuilt-cmake`
-#### Run this script from command line
+`cm run script --tags=install,prebuilt,cmake,prebuilt-cmake,install-prebuilt-cmake `
-1. `cm run script --tags=install,prebuilt,cmake,prebuilt-cmake,install-prebuilt-cmake `
+*or*
+
+`cmr "install prebuilt cmake prebuilt-cmake install-prebuilt-cmake"`
+
+`cmr "install prebuilt cmake prebuilt-cmake install-prebuilt-cmake " `
-2. `cmr "install prebuilt cmake prebuilt-cmake install-prebuilt-cmake" `
#### Run this script from Python
@@ -105,29 +102,26 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
Default version: `3.28.3`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cmake-prebuilt/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cmake-prebuilt/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cmake-prebuilt/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cmake-prebuilt/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cmake-prebuilt/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cmake-prebuilt/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cmake-prebuilt/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cmake-prebuilt/_cm.json)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cmake-prebuilt/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cmake-prebuilt/_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/install-cmake-prebuilt/_cm.json)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cmake-prebuilt/_cm.json)***
* get,cmake
* `if (CM_REQUIRE_INSTALL != yes)`
- CM script: [get-cmake](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmake)
-
___
### Script output
-`cmr "install prebuilt cmake prebuilt-cmake install-prebuilt-cmake" -j`
+`cmr "install prebuilt cmake prebuilt-cmake install-prebuilt-cmake " -j`
#### New environment keys (filter)
* `+C_INCLUDE_PATH`
@@ -140,8 +134,4 @@ ___
* `CM_CMAKE_BIN_WITH_PATH`
* `CM_CMAKE_INSTALLED_PATH`
* `CM_CMAKE_PACKAGE`
-* `CM_GET_DEPENDENT_CACHED_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_GET_DEPENDENT_CACHED_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/install-cuda-package-manager/README.md b/cm-mlops/script/install-cuda-package-manager/README.md
index ff01f87012..c8af286eeb 100644
--- a/cm-mlops/script/install-cuda-package-manager/README.md
+++ b/cm-mlops/script/install-cuda-package-manager/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **install-cuda-package-manager**
-
+Category: **CUDA automation**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-cuda-package-manager,c1afdff8542f45be) ]*
+---
#### Summary
-* Category: *CUDA automation.*
-* 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/install-cuda-package-manager)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cuda-package-manager)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,package-manager,cuda,package-manager-cuda,install-pm-cuda*
+* All CM tags to find and reuse this script (see in above meta description): *install,package-manager,cuda,package-manager-cuda,install-pm-cuda*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install package-manager cuda package-manager-cuda install-pm-cuda" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,package-manager,cuda,package-manager-cuda,install-pm-cuda`
-#### Run this script from command line
+`cm run script --tags=install,package-manager,cuda,package-manager-cuda,install-pm-cuda `
-1. `cm run script --tags=install,package-manager,cuda,package-manager-cuda,install-pm-cuda `
+*or*
+
+`cmr "install package-manager cuda package-manager-cuda install-pm-cuda"`
+
+`cmr "install package-manager cuda package-manager-cuda install-pm-cuda " `
-2. `cmr "install package-manager cuda package-manager-cuda install-pm-cuda" `
#### Run this script from Python
@@ -101,35 +99,27 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cuda-package-manager/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cuda-package-manager/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cuda-package-manager/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cuda-package-manager/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cuda-package-manager/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cuda-package-manager/_cm.json)
1. ***Run native script if exists***
- * [run-ubuntu.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cuda-package-manager/run-ubuntu.sh)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cuda-package-manager/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cuda-package-manager/_cm.json)
+ * [run-ubuntu.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cuda-package-manager/run-ubuntu.sh)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cuda-package-manager/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cuda-package-manager/_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/install-cuda-package-manager/_cm.json)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cuda-package-manager/_cm.json)***
* get,cuda
* `if (CM_REQUIRE_INSTALL != yes)`
- CM script: [get-cuda](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda)
-
___
### Script output
-`cmr "install package-manager cuda package-manager-cuda install-pm-cuda" -j`
+`cmr "install package-manager cuda package-manager-cuda install-pm-cuda " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/install-cuda-prebuilt/README.md b/cm-mlops/script/install-cuda-prebuilt/README.md
index 57a77fe4c5..6a93b32171 100644
--- a/cm-mlops/script/install-cuda-prebuilt/README.md
+++ b/cm-mlops/script/install-cuda-prebuilt/README.md
@@ -1,65 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ 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)
-
-
+Automatically generated README for this automation recipe: **install-cuda-prebuilt**
-*Note that this README is automatically generated - don't edit!*
+Category: **CUDA automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-cuda-prebuilt,14eadcd42ba340c3) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *CUDA automation.*
-* 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/install-cuda-prebuilt)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cuda-prebuilt)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,prebuilt,cuda,prebuilt-cuda,install-prebuilt-cuda*
+* All CM tags to find and reuse this script (see in above meta description): *install,prebuilt,cuda,prebuilt-cuda,install-prebuilt-cuda*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install prebuilt cuda prebuilt-cuda install-prebuilt-cuda" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=install,prebuilt,cuda,prebuilt-cuda,install-prebuilt-cuda`
-1. `cm run script --tags=install,prebuilt,cuda,prebuilt-cuda,install-prebuilt-cuda[,variations] [--input_flags]`
+`cm run script --tags=install,prebuilt,cuda,prebuilt-cuda,install-prebuilt-cuda[,variations] [--input_flags]`
-2. `cmr "install prebuilt cuda prebuilt-cuda install-prebuilt-cuda[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "install prebuilt cuda prebuilt-cuda install-prebuilt-cuda"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "install prebuilt cuda prebuilt-cuda install-prebuilt-cuda [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -95,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=install,prebuilt,cuda,
#### Run this script via Docker (beta)
-`cm docker script "install prebuilt cuda prebuilt-cuda install-prebuilt-cuda[ variations]" [--input_flags]`
+`cm docker script "install prebuilt cuda prebuilt-cuda install-prebuilt-cuda[variations]" [--input_flags]`
___
### Customization
@@ -158,32 +148,29 @@ Default version: `11.8.0`
* `12.2.0`
* `12.3.2`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cuda-prebuilt/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cuda-prebuilt/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cuda-prebuilt/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cuda-prebuilt/_cm.json)***
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cuda-prebuilt/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cuda-prebuilt/_cm.json)***
* download,file
* CM names: `--adr.['download-script']...`
- CM script: [download-file](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-file)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cuda-prebuilt/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cuda-prebuilt/_cm.json)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cuda-prebuilt/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cuda-prebuilt/_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/install-cuda-prebuilt/_cm.json)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cuda-prebuilt/_cm.json)***
* get,cuda
* `if (CM_REQUIRE_INSTALL != yes)`
- CM script: [get-cuda](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda)
-
___
### Script output
-`cmr "install prebuilt cuda prebuilt-cuda install-prebuilt-cuda[,variations]" [--input_flags] -j`
+`cmr "install prebuilt cuda prebuilt-cuda install-prebuilt-cuda [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_CUDA_*`
@@ -191,8 +178,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_CUDA_INSTALLED_PATH`
-* `CM_NVCC_BIN_WITH_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_NVCC_BIN_WITH_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/install-gcc-src/README.md b/cm-mlops/script/install-gcc-src/README.md
index 4b63deb194..bfa3bd5e7e 100644
--- a/cm-mlops/script/install-gcc-src/README.md
+++ b/cm-mlops/script/install-gcc-src/README.md
@@ -1,56 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
+Automatically generated README for this automation recipe: **install-gcc-src**
-
+Category: **Compiler automation**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-gcc-src,faae0ebd6e1242db) ]*
+---
#### Summary
-* Category: *Compiler automation.*
-* 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/install-gcc-src)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-gcc-src)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,src,gcc,src-gcc*
+* All CM tags to find and reuse this script (see in above meta description): *install,src,gcc,src-gcc*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install src gcc src-gcc" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,src,gcc,src-gcc`
-#### Run this script from command line
+`cm run script --tags=install,src,gcc,src-gcc `
-1. `cm run script --tags=install,src,gcc,src-gcc `
+*or*
+
+`cmr "install src gcc src-gcc"`
+
+`cmr "install src gcc src-gcc " `
-2. `cmr "install src gcc src-gcc" `
#### Run this script from Python
@@ -106,34 +103,26 @@ Default version: `12`
* `master`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-gcc-src/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-gcc-src/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-gcc-src/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-gcc-src/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-gcc-src/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-gcc-src/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-gcc-src/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-gcc-src/_cm.json)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-gcc-src/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-gcc-src/_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/install-gcc-src/_cm.json)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-gcc-src/_cm.json)***
* get,gcc
* `if (CM_REQUIRE_INSTALL != yes)`
- CM script: [get-gcc](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-gcc)
-
___
### Script output
-`cmr "install src gcc src-gcc" -j`
+`cmr "install src gcc src-gcc " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/install-generic-conda-package/README.md b/cm-mlops/script/install-generic-conda-package/README.md
index 50696d0c19..01e962f232 100644
--- a/cm-mlops/script/install-generic-conda-package/README.md
+++ b/cm-mlops/script/install-generic-conda-package/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **install-generic-conda-package**
-
+Category: **Python automation**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-generic-conda-package,d9275487f5314195) ]*
+---
#### Summary
-* Category: *Python automation.*
-* 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/install-generic-conda-package)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-generic-conda-package)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,install,generic,generic-conda-lib,conda-lib,conda-package,generic-conda-package*
+* All CM tags to find and reuse this script (see in above meta description): *get,install,generic,generic-conda-lib,conda-lib,conda-package,generic-conda-package*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get install generic generic-conda-lib conda-lib conda-package generic-conda-package" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,install,generic,generic-conda-lib,conda-lib,conda-package,generic-conda-package`
-#### Run this script from command line
+`cm run script --tags=get,install,generic,generic-conda-lib,conda-lib,conda-package,generic-conda-package[,variations] `
-1. `cm run script --tags=get,install,generic,generic-conda-lib,conda-lib,conda-package,generic-conda-package[,variations] `
+*or*
-2. `cmr "get install generic generic-conda-lib conda-lib conda-package generic-conda-package[ variations]" `
+`cmr "get install generic generic-conda-lib conda-lib conda-package generic-conda-package"`
-* `variations` can be seen [here](#variations)
+`cmr "get install generic generic-conda-lib conda-lib conda-package generic-conda-package [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,install,generic,ge
#### Run this script via Docker (beta)
-`cm docker script "get install generic generic-conda-lib conda-lib conda-package generic-conda-package[ variations]" `
+`cm docker script "get install generic generic-conda-lib conda-lib conda-package generic-conda-package[variations]" `
___
### Customization
@@ -132,12 +129,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-generic-conda-package/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-generic-conda-package/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -148,24 +143,18 @@ ___
* get,conda
* CM names: `--adr.['conda']...`
- CM script: [get-conda](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-conda)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-generic-conda-package/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-generic-conda-package/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-generic-conda-package/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-generic-conda-package/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-generic-conda-package/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-generic-conda-package/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-generic-conda-package/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-generic-conda-package/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-generic-conda-package/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-generic-conda-package/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-generic-conda-package/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-generic-conda-package/_cm.json)
___
### Script output
-`cmr "get install generic generic-conda-lib conda-lib conda-package generic-conda-package[,variations]" -j`
+`cmr "get install generic generic-conda-lib conda-lib conda-package generic-conda-package [,variations]" -j`
#### New environment keys (filter)
* `CM_PYTHONLIB_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/install-gflags/README.md b/cm-mlops/script/install-gflags/README.md
index 9e9c7a2653..695bf28180 100644
--- a/cm-mlops/script/install-gflags/README.md
+++ b/cm-mlops/script/install-gflags/README.md
@@ -1,56 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
+Automatically generated README for this automation recipe: **install-gflags**
-
+Category: **Detection or installation of tools and artifacts**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-gflags,10bb562c29ea459e) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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/install-gflags)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-gflags)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,src,get,gflags*
+* All CM tags to find and reuse this script (see in above meta description): *install,src,get,gflags*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install src get gflags" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,src,get,gflags`
-#### Run this script from command line
+`cm run script --tags=install,src,get,gflags `
-1. `cm run script --tags=install,src,get,gflags `
+*or*
+
+`cmr "install src get gflags"`
+
+`cmr "install src get gflags " `
-2. `cmr "install src get gflags" `
#### Run this script from Python
@@ -106,35 +103,27 @@ Default version: `2.2.2`
* `2.2.2`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-gflags/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-gflags/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
- CM script: [detect-cpu](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
* get,cmake
- CM script: [get-cmake](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmake)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-gflags/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-gflags/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-gflags/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-gflags/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-gflags/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-gflags/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-gflags/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-gflags/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-gflags/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-gflags/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-gflags/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-gflags/_cm.json)
___
### Script output
-`cmr "install src get gflags" -j`
+`cmr "install src get gflags " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/install-github-cli/README.md b/cm-mlops/script/install-github-cli/README.md
index abe52948d2..df2074423d 100644
--- a/cm-mlops/script/install-github-cli/README.md
+++ b/cm-mlops/script/install-github-cli/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **install-github-cli**
-
+Category: **Detection or installation of tools and artifacts**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-github-cli,cd948ec309344bf8) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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/install-github-cli)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-github-cli)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,gh,github,cli,github-cli*
+* All CM tags to find and reuse this script (see in above meta description): *install,gh,github,cli,github-cli*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install gh github cli github-cli" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,gh,github,cli,github-cli`
-#### Run this script from command line
+`cm run script --tags=install,gh,github,cli,github-cli `
-1. `cm run script --tags=install,gh,github,cli,github-cli `
+*or*
+
+`cmr "install gh github cli github-cli"`
+
+`cmr "install gh github cli github-cli " `
-2. `cmr "install gh github cli github-cli" `
#### Run this script from Python
@@ -101,33 +99,25 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-github-cli/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-github-cli/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-github-cli/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-github-cli/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-github-cli/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-github-cli/_cm.json)
1. ***Run native script if exists***
- * [run-macos.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-github-cli/run-macos.sh)
- * [run-rhel.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-github-cli/run-rhel.sh)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-github-cli/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-github-cli/_cm.json)
+ * [run-macos.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-github-cli/run-macos.sh)
+ * [run-rhel.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-github-cli/run-rhel.sh)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-github-cli/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-github-cli/_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/install-github-cli/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-github-cli/_cm.json)
___
### Script output
-`cmr "install gh github cli github-cli" -j`
+`cmr "install gh github cli github-cli " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/install-ipex-from-src/README.md b/cm-mlops/script/install-ipex-from-src/README.md
index dc2e8214d4..cd53770cd9 100644
--- a/cm-mlops/script/install-ipex-from-src/README.md
+++ b/cm-mlops/script/install-ipex-from-src/README.md
@@ -1,60 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **install-ipex-from-src**
-
+Category: **Compiler automation**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-*Build IPEX from sources.*
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-ipex-from-src,09364fff2bf04516) ]*
+---
#### Summary
-* Category: *Compiler automation.*
-* 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/install-ipex-from-src)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-ipex-from-src)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,get,src,from.src,ipex,src-ipex*
+* All CM tags to find and reuse this script (see in above meta description): *install,get,src,from.src,ipex,src-ipex*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install get src from.src ipex src-ipex" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,get,src,from.src,ipex,src-ipex`
-#### Run this script from command line
+`cm run script --tags=install,get,src,from.src,ipex,src-ipex[,variations] `
-1. `cm run script --tags=install,get,src,from.src,ipex,src-ipex[,variations] `
+*or*
-2. `cmr "install get src from.src ipex src-ipex[ variations]" `
+`cmr "install get src from.src ipex src-ipex"`
-* `variations` can be seen [here](#variations)
+`cmr "install get src from.src ipex src-ipex [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -90,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=install,get,src,from.s
#### Run this script via Docker (beta)
-`cm docker script "install get src from.src ipex src-ipex[ variations]" `
+`cm docker script "install get src from.src ipex src-ipex[variations]" `
___
### Customization
@@ -167,12 +162,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-ipex-from-src/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-ipex-from-src/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -188,24 +181,18 @@ ___
* get,git,repo
* CM names: `--adr.['ipex-src-repo']...`
- 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/install-ipex-from-src/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-ipex-from-src/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-ipex-from-src/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-ipex-from-src/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-ipex-from-src/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-ipex-from-src/_cm.json)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-ipex-from-src/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-ipex-from-src/_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/install-ipex-from-src/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-ipex-from-src/_cm.json)
___
### Script output
-`cmr "install get src from.src ipex src-ipex[,variations]" -j`
+`cmr "install get src from.src ipex src-ipex [,variations]" -j`
#### New environment keys (filter)
* `CM_IPEX_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/install-llvm-prebuilt/README.md b/cm-mlops/script/install-llvm-prebuilt/README.md
index 469f428443..24c9573349 100644
--- a/cm-mlops/script/install-llvm-prebuilt/README.md
+++ b/cm-mlops/script/install-llvm-prebuilt/README.md
@@ -1,61 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-
-
+Automatically generated README for this automation recipe: **install-llvm-prebuilt**
-*Note that this README is automatically generated - don't edit!*
+Category: **Compiler automation**
-### About
+License: **Apache 2.0**
-*Install prebuilt LLVM compiler.*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-llvm-prebuilt,cda9094971724a0a) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
-See extra [notes](README-extra.md) from the authors and contributors.
-
+---
#### Summary
-* Category: *Compiler automation.*
-* 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/install-llvm-prebuilt)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-llvm-prebuilt)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,prebuilt,llvm,prebuilt-llvm,install-prebuilt-llvm*
+* All CM tags to find and reuse this script (see in above meta description): *install,prebuilt,llvm,prebuilt-llvm,install-prebuilt-llvm*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install prebuilt llvm prebuilt-llvm install-prebuilt-llvm" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=install,prebuilt,llvm,prebuilt-llvm,install-prebuilt-llvm`
-1. `cm run script --tags=install,prebuilt,llvm,prebuilt-llvm,install-prebuilt-llvm `
+`cm run script --tags=install,prebuilt,llvm,prebuilt-llvm,install-prebuilt-llvm `
+
+*or*
+
+`cmr "install prebuilt llvm prebuilt-llvm install-prebuilt-llvm"`
+
+`cmr "install prebuilt llvm prebuilt-llvm install-prebuilt-llvm " `
-2. `cmr "install prebuilt llvm prebuilt-llvm install-prebuilt-llvm" `
#### Run this script from Python
@@ -110,30 +102,27 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
Default version: `15.0.6`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-llvm-prebuilt/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-llvm-prebuilt/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-llvm-prebuilt/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-llvm-prebuilt/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-llvm-prebuilt/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-llvm-prebuilt/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-llvm-prebuilt/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-llvm-prebuilt/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-llvm-prebuilt/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-llvm-prebuilt/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-llvm-prebuilt/_cm.json)***
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-llvm-prebuilt/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-llvm-prebuilt/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-llvm-prebuilt/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-llvm-prebuilt/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-llvm-prebuilt/_cm.json)***
* get,llvm
* `if (CM_REQUIRE_INSTALL != yes)`
- CM script: [get-llvm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-llvm)
-
___
### Script output
-`cmr "install prebuilt llvm prebuilt-llvm install-prebuilt-llvm" -j`
+`cmr "install prebuilt llvm prebuilt-llvm install-prebuilt-llvm " -j`
#### New environment keys (filter)
* `+CPLUS_INCLUDE_PATH`
@@ -146,8 +135,4 @@ ___
* `CM_LLVM_CLANG_BIN_WITH_PATH`
* `CM_LLVM_INSTALLED_PATH`
-* `CM_LLVM_PACKAGE`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_LLVM_PACKAGE`
\ No newline at end of file
diff --git a/cm-mlops/script/install-llvm-src/README.md b/cm-mlops/script/install-llvm-src/README.md
index 881d22e283..7991e0ab8d 100644
--- a/cm-mlops/script/install-llvm-src/README.md
+++ b/cm-mlops/script/install-llvm-src/README.md
@@ -1,60 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **install-llvm-src**
-
+Category: **Compiler automation**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-*Build LLVM compiler from sources (can take >30 min).*
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-llvm-src,2af16e9a6c5f4702) ]*
+---
#### Summary
-* Category: *Compiler automation.*
-* 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/install-llvm-src)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-llvm-src)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,src,llvm,from.src,src-llvm*
+* All CM tags to find and reuse this script (see in above meta description): *install,src,llvm,from.src,src-llvm*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install src llvm from.src src-llvm" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,src,llvm,from.src,src-llvm`
-#### Run this script from command line
+`cm run script --tags=install,src,llvm,from.src,src-llvm[,variations] `
-1. `cm run script --tags=install,src,llvm,from.src,src-llvm[,variations] `
+*or*
-2. `cmr "install src llvm from.src src-llvm[ variations]" `
+`cmr "install src llvm from.src src-llvm"`
-* `variations` can be seen [here](#variations)
+`cmr "install src llvm from.src src-llvm [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -90,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=install,src,llvm,from.
#### Run this script via Docker (beta)
-`cm docker script "install src llvm from.src src-llvm[ variations]" `
+`cm docker script "install src llvm from.src src-llvm[variations]" `
___
### Customization
@@ -251,12 +246,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-llvm-src/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-llvm-src/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -270,21 +263,20 @@ ___
* get,git,repo
* CM names: `--adr.['llvm-src-repo']...`
- 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/install-llvm-src/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-llvm-src/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-llvm-src/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-llvm-src/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-llvm-src/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-llvm-src/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-llvm-src/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-llvm-src/_cm.json)***
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-llvm-src/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-llvm-src/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-llvm-src/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-llvm-src/_cm.json)***
* get,llvm
* `if (CM_REQUIRE_INSTALL != yes)`
- CM script: [get-llvm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-llvm)
-
___
### Script output
-`cmr "install src llvm from.src src-llvm[,variations]" -j`
+`cmr "install src llvm from.src src-llvm [,variations]" -j`
#### New environment keys (filter)
* `+C_INCLUDE_PATH`
@@ -296,8 +288,4 @@ ___
* `CM_GET_DEPENDENT_CACHED_PATH`
* `CM_LLVM_CLANG_BIN_WITH_PATH`
* `CM_LLVM_CMAKE_CMD`
-* `CM_LLVM_INSTALLED_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_LLVM_INSTALLED_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/install-mlperf-logging-from-src/README.md b/cm-mlops/script/install-mlperf-logging-from-src/README.md
index 79443c6ca2..2b955f2899 100644
--- a/cm-mlops/script/install-mlperf-logging-from-src/README.md
+++ b/cm-mlops/script/install-mlperf-logging-from-src/README.md
@@ -1,56 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
+Automatically generated README for this automation recipe: **install-mlperf-logging-from-src**
-
+Category: **MLPerf benchmark support**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-mlperf-logging-from-src,f67cb84a5dc942c3) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/install-mlperf-logging-from-src)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-mlperf-logging-from-src)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *install,mlperf,logging,from.src*
+* All CM tags to find and reuse this script (see in above meta description): *install,mlperf,logging,from.src*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install mlperf logging from.src" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,mlperf,logging,from.src`
-#### Run this script from command line
+`cm run script --tags=install,mlperf,logging,from.src `
-1. `cm run script --tags=install,mlperf,logging,from.src `
+*or*
+
+`cmr "install mlperf logging from.src"`
+
+`cmr "install mlperf logging from.src " `
-2. `cmr "install mlperf logging from.src" `
#### Run this script from Python
@@ -105,35 +102,27 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
* `master`
* `v3.1`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-mlperf-logging-from-src/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-mlperf-logging-from-src/_cm.yaml)***
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
* get,git,repo,_repo.https://github.com/mlcommons/logging
- 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/install-mlperf-logging-from-src/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-mlperf-logging-from-src/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-mlperf-logging-from-src/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-mlperf-logging-from-src/_cm.yaml)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-mlperf-logging-from-src/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-mlperf-logging-from-src/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-mlperf-logging-from-src/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-mlperf-logging-from-src/_cm.yaml)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-mlperf-logging-from-src/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-mlperf-logging-from-src/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-mlperf-logging-from-src/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-mlperf-logging-from-src/_cm.yaml)
___
### Script output
-`cmr "install mlperf logging from.src" -j`
+`cmr "install mlperf logging from.src " -j`
#### New environment keys (filter)
* `CM_MLPERF_LOGGING_REPO_PATH`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/install-nccl-libs/README.md b/cm-mlops/script/install-nccl-libs/README.md
index b414433dac..7b9e65bb64 100644
--- a/cm-mlops/script/install-nccl-libs/README.md
+++ b/cm-mlops/script/install-nccl-libs/README.md
@@ -1,57 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **install-nccl-libs**
-
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-nccl-libs,d1c76da2adb44201) ]*
+---
#### Summary
-* 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/install-nccl-libs)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-nccl-libs)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *install,nccl,libs*
+* All CM tags to find and reuse this script (see in above meta description): *install,nccl,libs*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install nccl libs" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,nccl,libs`
-#### Run this script from command line
+`cm run script --tags=install,nccl,libs[,variations] `
-1. `cm run script --tags=install,nccl,libs[,variations] `
+*or*
-2. `cmr "install nccl libs[ variations]" `
+`cmr "install nccl libs"`
-* `variations` can be seen [here](#variations)
+`cmr "install nccl libs [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -87,7 +83,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=install,nccl,libs) to
#### Run this script via Docker (beta)
-`cm docker script "install nccl libs[ variations]" `
+`cm docker script "install nccl libs[variations]" `
___
### Customization
@@ -118,30 +114,22 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-nccl-libs/_cm.yaml)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-nccl-libs/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-nccl-libs/_cm.yaml)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-nccl-libs/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-nccl-libs/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-nccl-libs/_cm.yaml)
1. ***Run native script if exists***
- * [run-ubuntu.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-nccl-libs/run-ubuntu.sh)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-nccl-libs/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-nccl-libs/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-nccl-libs/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-nccl-libs/_cm.yaml)
-
+ * [run-ubuntu.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-nccl-libs/run-ubuntu.sh)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-nccl-libs/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-nccl-libs/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-nccl-libs/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-nccl-libs/_cm.yaml)
___
### Script output
-`cmr "install nccl libs[,variations]" -j`
+`cmr "install nccl libs [,variations]" -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/install-numactl-from-src/README.md b/cm-mlops/script/install-numactl-from-src/README.md
index 49d6044ec1..fc1328c04e 100644
--- a/cm-mlops/script/install-numactl-from-src/README.md
+++ b/cm-mlops/script/install-numactl-from-src/README.md
@@ -1,60 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **install-numactl-from-src**
-
+Category: **Detection or installation of tools and artifacts**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-*Build numactl from sources.*
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-numactl-from-src,4f355ae8ca1948b2) ]*
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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/install-numactl-from-src)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-numactl-from-src)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,src,from.src,numactl,src-numactl*
+* All CM tags to find and reuse this script (see in above meta description): *install,src,from.src,numactl,src-numactl*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install src from.src numactl src-numactl" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,src,from.src,numactl,src-numactl`
-#### Run this script from command line
+`cm run script --tags=install,src,from.src,numactl,src-numactl[,variations] `
-1. `cm run script --tags=install,src,from.src,numactl,src-numactl[,variations] `
+*or*
-2. `cmr "install src from.src numactl src-numactl[ variations]" `
+`cmr "install src from.src numactl src-numactl"`
-* `variations` can be seen [here](#variations)
+`cmr "install src from.src numactl src-numactl [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -90,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=install,src,from.src,n
#### Run this script via Docker (beta)
-`cm docker script "install src from.src numactl src-numactl[ variations]" `
+`cm docker script "install src from.src numactl src-numactl[variations]" `
___
### Customization
@@ -148,12 +143,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-numactl-from-src/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-numactl-from-src/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -161,25 +154,19 @@ ___
* get,git,repo
* CM names: `--adr.['numactl-src-repo']...`
- 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/install-numactl-from-src/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-numactl-from-src/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-numactl-from-src/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-numactl-from-src/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-numactl-from-src/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-numactl-from-src/_cm.json)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-numactl-from-src/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-numactl-from-src/_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/install-numactl-from-src/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-numactl-from-src/_cm.json)
___
### Script output
-`cmr "install src from.src numactl src-numactl[,variations]" -j`
+`cmr "install src from.src numactl src-numactl [,variations]" -j`
#### New environment keys (filter)
* `+PATH`
* `CM_NUMACTL_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/install-onednn-from-src/README.md b/cm-mlops/script/install-onednn-from-src/README.md
index 43aa65c488..baac91350c 100644
--- a/cm-mlops/script/install-onednn-from-src/README.md
+++ b/cm-mlops/script/install-onednn-from-src/README.md
@@ -1,60 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **install-onednn-from-src**
-
+Category: **Compiler automation**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-*Build oneDNN from sources.*
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-onednn-from-src,fe3a652e315f4c8f) ]*
+---
#### Summary
-* Category: *Compiler automation.*
-* 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/install-onednn-from-src)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-onednn-from-src)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,get,src,from.src,onednn,src-onednn*
+* All CM tags to find and reuse this script (see in above meta description): *install,get,src,from.src,onednn,src-onednn*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install get src from.src onednn src-onednn" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,get,src,from.src,onednn,src-onednn`
-#### Run this script from command line
+`cm run script --tags=install,get,src,from.src,onednn,src-onednn[,variations] `
-1. `cm run script --tags=install,get,src,from.src,onednn,src-onednn[,variations] `
+*or*
-2. `cmr "install get src from.src onednn src-onednn[ variations]" `
+`cmr "install get src from.src onednn src-onednn"`
-* `variations` can be seen [here](#variations)
+`cmr "install get src from.src onednn src-onednn [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -90,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=install,get,src,from.s
#### Run this script via Docker (beta)
-`cm docker script "install get src from.src onednn src-onednn[ variations]" `
+`cm docker script "install get src from.src onednn src-onednn[variations]" `
___
### Customization
@@ -153,12 +148,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-onednn-from-src/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-onednn-from-src/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -170,25 +163,20 @@ ___
* get,git,repo
* CM names: `--adr.['onednn-src-repo']...`
- 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/install-onednn-from-src/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-onednn-from-src/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-onednn-from-src/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-onednn-from-src/_cm.json)
1. ***Run native script if exists***
- * [run-intel-mlperf-inference.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-onednn-from-src/run-intel-mlperf-inference.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-onednn-from-src/_cm.json)
+ * [run-intel-mlperf-inference.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-onednn-from-src/run-intel-mlperf-inference.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-onednn-from-src/_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/install-onednn-from-src/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-onednn-from-src/_cm.json)
___
### Script output
-`cmr "install get src from.src onednn src-onednn[,variations]" -j`
+`cmr "install get src from.src onednn src-onednn [,variations]" -j`
#### New environment keys (filter)
* `CM_ONEDNN_*`
#### New environment keys auto-detected from customize
-* `CM_ONEDNN_INSTALLED_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_ONEDNN_INSTALLED_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/install-onnxruntime-from-src/README.md b/cm-mlops/script/install-onnxruntime-from-src/README.md
index ca3ea30b31..7170210582 100644
--- a/cm-mlops/script/install-onnxruntime-from-src/README.md
+++ b/cm-mlops/script/install-onnxruntime-from-src/README.md
@@ -1,60 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **install-onnxruntime-from-src**
-
+Category: **Compiler automation**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-*Build onnxruntime from sources.*
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-onnxruntime-from-src,9798c7e7a5944cee) ]*
+---
#### Summary
-* Category: *Compiler automation.*
-* 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/install-onnxruntime-from-src)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-onnxruntime-from-src)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,get,src,from.src,onnxruntime,src-onnxruntime*
+* All CM tags to find and reuse this script (see in above meta description): *install,get,src,from.src,onnxruntime,src-onnxruntime*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install get src from.src onnxruntime src-onnxruntime" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,get,src,from.src,onnxruntime,src-onnxruntime`
-#### Run this script from command line
+`cm run script --tags=install,get,src,from.src,onnxruntime,src-onnxruntime[,variations] `
-1. `cm run script --tags=install,get,src,from.src,onnxruntime,src-onnxruntime[,variations] `
+*or*
-2. `cmr "install get src from.src onnxruntime src-onnxruntime[ variations]" `
+`cmr "install get src from.src onnxruntime src-onnxruntime"`
-* `variations` can be seen [here](#variations)
+`cmr "install get src from.src onnxruntime src-onnxruntime [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -90,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=install,get,src,from.s
#### Run this script via Docker (beta)
-`cm docker script "install get src from.src onnxruntime src-onnxruntime[ variations]" `
+`cm docker script "install get src from.src onnxruntime src-onnxruntime[variations]" `
___
### Customization
@@ -152,12 +147,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-onnxruntime-from-src/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-onnxruntime-from-src/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -175,24 +168,18 @@ ___
* get,git,repo
* CM names: `--adr.['onnxruntime-src-repo']...`
- 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/install-onnxruntime-from-src/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-onnxruntime-from-src/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-onnxruntime-from-src/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-onnxruntime-from-src/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-onnxruntime-from-src/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-onnxruntime-from-src/_cm.json)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-onnxruntime-from-src/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-onnxruntime-from-src/_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/install-onnxruntime-from-src/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-onnxruntime-from-src/_cm.json)
___
### Script output
-`cmr "install get src from.src onnxruntime src-onnxruntime[,variations]" -j`
+`cmr "install get src from.src onnxruntime src-onnxruntime [,variations]" -j`
#### New environment keys (filter)
* `CM_ONNXRUNTIME_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/install-openssl/README.md b/cm-mlops/script/install-openssl/README.md
index 0f964fb574..c46b1b9841 100644
--- a/cm-mlops/script/install-openssl/README.md
+++ b/cm-mlops/script/install-openssl/README.md
@@ -1,56 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
+Automatically generated README for this automation recipe: **install-openssl**
-
+Category: **Detection or installation of tools and artifacts**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-openssl,be472d3b1d014169) ]*
+
+---
#### Summary
-* Category: *Detection or installation of tools and artifacts.*
-* 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/install-openssl)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-openssl)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,src,openssl,openssl-lib*
+* All CM tags to find and reuse this script (see in above meta description): *install,src,openssl,openssl-lib*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install src openssl openssl-lib" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=install,src,openssl,openssl-lib`
-1. `cm run script --tags=install,src,openssl,openssl-lib `
+`cm run script --tags=install,src,openssl,openssl-lib `
+
+*or*
+
+`cmr "install src openssl openssl-lib"`
+
+`cmr "install src openssl openssl-lib " `
-2. `cmr "install src openssl openssl-lib" `
#### Run this script from Python
@@ -106,31 +103,28 @@ Default version: `1.1.1`
* `1.1.1`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-openssl/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-openssl/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
- CM script: [detect-cpu](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-openssl/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-openssl/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-openssl/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-openssl/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-openssl/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-openssl/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-openssl/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-openssl/_cm.json)***
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-openssl/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-openssl/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-openssl/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-openssl/_cm.json)***
* get,openssl
* `if (CM_REQUIRE_INSTALL != yes)`
- CM script: [get-openssl](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-openssl)
-
___
### Script output
-`cmr "install src openssl openssl-lib" -j`
+`cmr "install src openssl openssl-lib " -j`
#### New environment keys (filter)
* `+LD_LIBRARY_PATH`
@@ -138,8 +132,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_OPENSSL_BIN_WITH_PATH`
-* `CM_OPENSSL_INSTALLED_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_OPENSSL_INSTALLED_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/install-pip-package-for-cmind-python/README.md b/cm-mlops/script/install-pip-package-for-cmind-python/README.md
index 2956940ce2..a4fdf16d0f 100644
--- a/cm-mlops/script/install-pip-package-for-cmind-python/README.md
+++ b/cm-mlops/script/install-pip-package-for-cmind-python/README.md
@@ -1,57 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **install-pip-package-for-cmind-python**
-
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-pip-package-for-cmind-python,b16ed087abab459c) ]*
+---
#### Summary
-* 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/install-pip-package-for-cmind-python)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pip-package-for-cmind-python)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *install,pip,package,pip-package,for-cmind-python,for.cmind-python*
+* All CM tags to find and reuse this script (see in above meta description): *install,pip,package,pip-package,for-cmind-python,for.cmind-python*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install pip package pip-package for-cmind-python for.cmind-python" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,pip,package,pip-package,for-cmind-python,for.cmind-python`
-#### Run this script from command line
+`cm run script --tags=install,pip,package,pip-package,for-cmind-python,for.cmind-python[,variations] `
-1. `cm run script --tags=install,pip,package,pip-package,for-cmind-python,for.cmind-python[,variations] `
+*or*
-2. `cmr "install pip package pip-package for-cmind-python for.cmind-python[ variations]" `
+`cmr "install pip package pip-package for-cmind-python for.cmind-python"`
-* `variations` can be seen [here](#variations)
+`cmr "install pip package pip-package for-cmind-python for.cmind-python [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -87,7 +83,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=install,pip,package,pi
#### Run this script via Docker (beta)
-`cm docker script "install pip package pip-package for-cmind-python for.cmind-python[ variations]" `
+`cm docker script "install pip package pip-package for-cmind-python for.cmind-python[variations]" `
___
### Customization
@@ -117,28 +113,20 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-pip-package-for-cmind-python/_cm.yaml)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-pip-package-for-cmind-python/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-pip-package-for-cmind-python/_cm.yaml)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pip-package-for-cmind-python/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pip-package-for-cmind-python/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pip-package-for-cmind-python/_cm.yaml)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-pip-package-for-cmind-python/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-pip-package-for-cmind-python/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-pip-package-for-cmind-python/_cm.yaml)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pip-package-for-cmind-python/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pip-package-for-cmind-python/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pip-package-for-cmind-python/_cm.yaml)
___
### Script output
-`cmr "install pip package pip-package for-cmind-python for.cmind-python[,variations]" -j`
+`cmr "install pip package pip-package for-cmind-python for.cmind-python [,variations]" -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/install-python-src/README.md b/cm-mlops/script/install-python-src/README.md
index 534555e944..4bfd73e580 100644
--- a/cm-mlops/script/install-python-src/README.md
+++ b/cm-mlops/script/install-python-src/README.md
@@ -1,59 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ 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)
+Automatically generated README for this automation recipe: **install-python-src**
-
+Category: **Python automation**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-python-src,12d3a608afe14a1e) ]*
+---
#### Summary
-* Category: *Python automation.*
-* 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/install-python-src)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-python-src)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,src,python,python3,src-python3,src-python*
+* All CM tags to find and reuse this script (see in above meta description): *install,src,python,python3,src-python3,src-python*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install src python python3 src-python3 src-python" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,src,python,python3,src-python3,src-python`
-#### Run this script from command line
+`cm run script --tags=install,src,python,python3,src-python3,src-python[,variations] `
-1. `cm run script --tags=install,src,python,python3,src-python3,src-python[,variations] `
+*or*
-2. `cmr "install src python python3 src-python3 src-python[ variations]" `
+`cmr "install src python python3 src-python3 src-python"`
-* `variations` can be seen [here](#variations)
+`cmr "install src python python3 src-python3 src-python [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -89,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=install,src,python,pyt
#### Run this script via Docker (beta)
-`cm docker script "install src python python3 src-python3 src-python[ variations]" `
+`cm docker script "install src python python3 src-python3 src-python[variations]" `
___
### Customization
@@ -152,32 +148,29 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
Default version: `3.10.13`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-src/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-python-src/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
- CM script: [detect-cpu](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-src/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-src/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-python-src/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-python-src/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-src/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-src/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-src/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-src/_cm.json)***
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-python-src/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-python-src/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-python-src/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-python-src/_cm.json)***
* get,python3
* `if (CM_REQUIRE_INSTALL != yes)`
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
-
___
### Script output
-`cmr "install src python python3 src-python3 src-python[,variations]" -j`
+`cmr "install src python python3 src-python3 src-python [,variations]" -j`
#### New environment keys (filter)
* `+C_INCLUDE_PATH`
@@ -187,8 +180,4 @@ ___
* `CM_PYTHON_INSTALL_PATH`
#### New environment keys auto-detected from customize
-* `CM_PYTHON_BIN_WITH_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_PYTHON_BIN_WITH_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/install-python-venv/README.md b/cm-mlops/script/install-python-venv/README.md
index 1966e3089d..3588ca8bc2 100644
--- a/cm-mlops/script/install-python-venv/README.md
+++ b/cm-mlops/script/install-python-venv/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **install-python-venv**
-
+Category: **Python automation**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-python-venv,7633ebada4584c6c) ]*
+
+---
#### Summary
-* Category: *Python automation.*
-* 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/install-python-venv)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-python-venv)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,python,get-python-venv,python-venv*
+* All CM tags to find and reuse this script (see in above meta description): *install,python,get-python-venv,python-venv*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install python get-python-venv python-venv" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=install,python,get-python-venv,python-venv`
-1. `cm run script --tags=install,python,get-python-venv,python-venv[,variations] `
+`cm run script --tags=install,python,get-python-venv,python-venv[,variations] `
-2. `cmr "install python get-python-venv python-venv[ variations]" `
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "install python get-python-venv python-venv"`
+
+`cmr "install python get-python-venv python-venv [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=install,python,get-pyt
#### Run this script via Docker (beta)
-`cm docker script "install python get-python-venv python-venv[ variations]" `
+`cm docker script "install python get-python-venv python-venv[variations]" `
___
### Customization
@@ -124,30 +121,27 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-venv/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-python-venv/_cm.json)***
* get,python,-virtual
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-venv/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-venv/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-python-venv/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-python-venv/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-venv/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-venv/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-venv/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-venv/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-venv/_cm.json)***
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-python-venv/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-python-venv/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-python-venv/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-python-venv/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-python-venv/_cm.json)***
* get,python3
* CM names: `--adr.['register-python']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
-
___
### Script output
-`cmr "install python get-python-venv python-venv[,variations]" -j`
+`cmr "install python get-python-venv python-venv [,variations]" -j`
#### New environment keys (filter)
* `CM_PYTHON_BIN_WITH_PATH`
@@ -157,8 +151,4 @@ ___
* `CM_PYTHON_BIN_WITH_PATH`
* `CM_VIRTUAL_ENV_DIR`
* `CM_VIRTUAL_ENV_PATH`
-* `CM_VIRTUAL_ENV_SCRIPTS_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_VIRTUAL_ENV_SCRIPTS_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/install-pytorch-from-src/README.md b/cm-mlops/script/install-pytorch-from-src/README.md
index e1a3fa11c9..db0aba0520 100644
--- a/cm-mlops/script/install-pytorch-from-src/README.md
+++ b/cm-mlops/script/install-pytorch-from-src/README.md
@@ -1,60 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **install-pytorch-from-src**
-
+Category: **Compiler automation**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-*Build pytorch from sources.*
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-pytorch-from-src,64eaf3e81de94f41) ]*
+---
#### Summary
-* Category: *Compiler automation.*
-* 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/install-pytorch-from-src)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pytorch-from-src)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,get,src,from.src,pytorch,src-pytorch*
+* All CM tags to find and reuse this script (see in above meta description): *install,get,src,from.src,pytorch,src-pytorch*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install get src from.src pytorch src-pytorch" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,get,src,from.src,pytorch,src-pytorch`
-#### Run this script from command line
+`cm run script --tags=install,get,src,from.src,pytorch,src-pytorch[,variations] `
-1. `cm run script --tags=install,get,src,from.src,pytorch,src-pytorch[,variations] `
+*or*
-2. `cmr "install get src from.src pytorch src-pytorch[ variations]" `
+`cmr "install get src from.src pytorch src-pytorch"`
-* `variations` can be seen [here](#variations)
+`cmr "install get src from.src pytorch src-pytorch [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -90,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=install,get,src,from.s
#### Run this script via Docker (beta)
-`cm docker script "install get src from.src pytorch src-pytorch[ variations]" `
+`cm docker script "install get src from.src pytorch src-pytorch[variations]" `
___
### Customization
@@ -221,12 +216,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-pytorch-from-src/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pytorch-from-src/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -238,25 +231,19 @@ ___
* get,git,repo
* CM names: `--adr.['pytorch-src-repo']...`
- 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/install-pytorch-from-src/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-pytorch-from-src/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pytorch-from-src/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pytorch-from-src/_cm.json)
1. ***Run native script if exists***
- * [run-intel-mlperf-inference-v3_1.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-pytorch-from-src/run-intel-mlperf-inference-v3_1.sh)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-pytorch-from-src/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-pytorch-from-src/_cm.json)
+ * [run-intel-mlperf-inference-v3_1.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pytorch-from-src/run-intel-mlperf-inference-v3_1.sh)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pytorch-from-src/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pytorch-from-src/_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/install-pytorch-from-src/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pytorch-from-src/_cm.json)
___
### Script output
-`cmr "install get src from.src pytorch src-pytorch[,variations]" -j`
+`cmr "install get src from.src pytorch src-pytorch [,variations]" -j`
#### New environment keys (filter)
* `CM_PYTORCH_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/install-pytorch-kineto-from-src/README.md b/cm-mlops/script/install-pytorch-kineto-from-src/README.md
index e8697f18e7..9c5ad5af0a 100644
--- a/cm-mlops/script/install-pytorch-kineto-from-src/README.md
+++ b/cm-mlops/script/install-pytorch-kineto-from-src/README.md
@@ -1,60 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **install-pytorch-kineto-from-src**
-
+Category: **Compiler automation**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-*Build pytorch kineto from sources.*
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-pytorch-kineto-from-src,98a4b061712d4483) ]*
+---
#### Summary
-* Category: *Compiler automation.*
-* 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/install-pytorch-kineto-from-src)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pytorch-kineto-from-src)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,get,src,from.src,pytorch-kineto,kineto,src-pytorch-kineto*
+* All CM tags to find and reuse this script (see in above meta description): *install,get,src,from.src,pytorch-kineto,kineto,src-pytorch-kineto*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install get src from.src pytorch-kineto kineto src-pytorch-kineto" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,get,src,from.src,pytorch-kineto,kineto,src-pytorch-kineto`
-#### Run this script from command line
+`cm run script --tags=install,get,src,from.src,pytorch-kineto,kineto,src-pytorch-kineto[,variations] `
-1. `cm run script --tags=install,get,src,from.src,pytorch-kineto,kineto,src-pytorch-kineto[,variations] `
+*or*
-2. `cmr "install get src from.src pytorch-kineto kineto src-pytorch-kineto[ variations]" `
+`cmr "install get src from.src pytorch-kineto kineto src-pytorch-kineto"`
-* `variations` can be seen [here](#variations)
+`cmr "install get src from.src pytorch-kineto kineto src-pytorch-kineto [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -90,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=install,get,src,from.s
#### Run this script via Docker (beta)
-`cm docker script "install get src from.src pytorch-kineto kineto src-pytorch-kineto[ variations]" `
+`cm docker script "install get src from.src pytorch-kineto kineto src-pytorch-kineto[variations]" `
___
### Customization
@@ -163,12 +158,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-pytorch-kineto-from-src/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pytorch-kineto-from-src/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -182,24 +175,18 @@ ___
* get,git,repo
* CM names: `--adr.['pytorch-kineto-src-repo']...`
- 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/install-pytorch-kineto-from-src/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-pytorch-kineto-from-src/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pytorch-kineto-from-src/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pytorch-kineto-from-src/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-pytorch-kineto-from-src/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-pytorch-kineto-from-src/_cm.json)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pytorch-kineto-from-src/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pytorch-kineto-from-src/_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/install-pytorch-kineto-from-src/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pytorch-kineto-from-src/_cm.json)
___
### Script output
-`cmr "install get src from.src pytorch-kineto kineto src-pytorch-kineto[,variations]" -j`
+`cmr "install get src from.src pytorch-kineto kineto src-pytorch-kineto [,variations]" -j`
#### New environment keys (filter)
* `CM_PYTORCH_KINETO_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/install-qaic-compute-sdk-from-src/README.md b/cm-mlops/script/install-qaic-compute-sdk-from-src/README.md
index 36cc667da0..ada40a2243 100644
--- a/cm-mlops/script/install-qaic-compute-sdk-from-src/README.md
+++ b/cm-mlops/script/install-qaic-compute-sdk-from-src/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **install-qaic-compute-sdk-from-src**
-
+Category: **AI/ML frameworks**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-qaic-compute-sdk-from-src,9701bdda97fa4045) ]*
+---
#### 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/install-qaic-compute-sdk-from-src)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-qaic-compute-sdk-from-src)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,qaic,from.src,software,compute,compute-sdk,qaic-compute-sdk,sdk*
+* All CM tags to find and reuse this script (see in above meta description): *get,qaic,from.src,software,compute,compute-sdk,qaic-compute-sdk,sdk*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get qaic from.src software compute compute-sdk qaic-compute-sdk sdk" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,qaic,from.src,software,compute,compute-sdk,qaic-compute-sdk,sdk`
-#### Run this script from command line
+`cm run script --tags=get,qaic,from.src,software,compute,compute-sdk,qaic-compute-sdk,sdk[,variations] `
-1. `cm run script --tags=get,qaic,from.src,software,compute,compute-sdk,qaic-compute-sdk,sdk[,variations] `
+*or*
-2. `cmr "get qaic from.src software compute compute-sdk qaic-compute-sdk sdk[ variations]" `
+`cmr "get qaic from.src software compute compute-sdk qaic-compute-sdk sdk"`
-* `variations` can be seen [here](#variations)
+`cmr "get qaic from.src software compute compute-sdk qaic-compute-sdk sdk [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,qaic,from.src,soft
#### Run this script via Docker (beta)
-`cm docker script "get qaic from.src software compute compute-sdk qaic-compute-sdk sdk[ variations]" `
+`cm docker script "get qaic from.src software compute compute-sdk qaic-compute-sdk sdk[variations]" `
___
### Customization
@@ -158,12 +155,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-qaic-compute-sdk-from-src/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-qaic-compute-sdk-from-src/_cm.json)***
* get,git,repo,_repo.https://github.com/quic/software-kit-for-qualcomm-cloud-ai-100-cc
* CM names: `--adr.['qaic-software-git-repo']...`
- CM script: [get-git-repo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo)
@@ -186,26 +181,21 @@ ___
* download-and-extract,_extract,_url.https://codelinaro.jfrog.io/artifactory/codelinaro-toolchain-for-hexagon/v15.0.5/clang+llvm-15.0.5-cross-hexagon-unknown-linux-musl.tar.xz
* CM names: `--adr.['dae']...`
- CM script: [download-and-extract](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-and-extract)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-qaic-compute-sdk-from-src/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-qaic-compute-sdk-from-src/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-qaic-compute-sdk-from-src/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-qaic-compute-sdk-from-src/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-qaic-compute-sdk-from-src/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-qaic-compute-sdk-from-src/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-qaic-compute-sdk-from-src/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-qaic-compute-sdk-from-src/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-qaic-compute-sdk-from-src/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-qaic-compute-sdk-from-src/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-qaic-compute-sdk-from-src/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-qaic-compute-sdk-from-src/_cm.json)
___
### Script output
-`cmr "get qaic from.src software compute compute-sdk qaic-compute-sdk sdk[,variations]" -j`
+`cmr "get qaic from.src software compute compute-sdk qaic-compute-sdk sdk [,variations]" -j`
#### New environment keys (filter)
* `+PATH`
* `CM_QAIC_COMPUTE_SDK_PATH`
#### New environment keys auto-detected from customize
-* `CM_QAIC_COMPUTE_SDK_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_QAIC_COMPUTE_SDK_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/install-rocm/README.md b/cm-mlops/script/install-rocm/README.md
index 5fb1ad384f..8bbe710108 100644
--- a/cm-mlops/script/install-rocm/README.md
+++ b/cm-mlops/script/install-rocm/README.md
@@ -1,56 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
+Automatically generated README for this automation recipe: **install-rocm**
-
+Category: **AI/ML frameworks**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-rocm,9d13f90463ce4545) ]*
+
+---
#### 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/install-rocm)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-rocm)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,rocm,install-rocm*
+* All CM tags to find and reuse this script (see in above meta description): *install,rocm,install-rocm*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install rocm install-rocm" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=install,rocm,install-rocm`
-1. `cm run script --tags=install,rocm,install-rocm `
+`cm run script --tags=install,rocm,install-rocm `
+
+*or*
+
+`cmr "install rocm install-rocm"`
+
+`cmr "install rocm install-rocm " `
-2. `cmr "install rocm install-rocm" `
#### Run this script from Python
@@ -105,28 +102,25 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
Default version: `5.7.1`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-rocm/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-rocm/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-rocm/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-rocm/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-rocm/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-rocm/_cm.json)
1. ***Run native script if exists***
- * [run-rhel.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-rocm/run-rhel.sh)
- * [run-ubuntu.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-rocm/run-ubuntu.sh)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-rocm/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-rocm/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-rocm/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-rocm/_cm.json)
-
+ * [run-rhel.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-rocm/run-rhel.sh)
+ * [run-ubuntu.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-rocm/run-ubuntu.sh)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-rocm/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-rocm/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-rocm/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-rocm/_cm.json)
___
### Script output
-`cmr "install rocm install-rocm" -j`
+`cmr "install rocm install-rocm " -j`
#### New environment keys (filter)
* `+PATH`
@@ -134,8 +128,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_ROCM_BIN_WITH_PATH`
-* `CM_ROCM_INSTALLED_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_ROCM_INSTALLED_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/install-tensorflow-for-c/README.md b/cm-mlops/script/install-tensorflow-for-c/README.md
index 3b4e97d0be..ecec97bb28 100644
--- a/cm-mlops/script/install-tensorflow-for-c/README.md
+++ b/cm-mlops/script/install-tensorflow-for-c/README.md
@@ -1,56 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
+Automatically generated README for this automation recipe: **install-tensorflow-for-c**
-
+Category: **AI/ML frameworks**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-tensorflow-for-c,d73783d8302547d7) ]*
+---
#### 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/install-tensorflow-for-c)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tensorflow-for-c)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,tensorflow,lib,lang-c*
+* All CM tags to find and reuse this script (see in above meta description): *install,tensorflow,lib,lang-c*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install tensorflow lib lang-c" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,tensorflow,lib,lang-c`
-#### Run this script from command line
+`cm run script --tags=install,tensorflow,lib,lang-c `
-1. `cm run script --tags=install,tensorflow,lib,lang-c `
+*or*
+
+`cmr "install tensorflow lib lang-c"`
+
+`cmr "install tensorflow lib lang-c " `
-2. `cmr "install tensorflow lib lang-c" `
#### Run this script from Python
@@ -105,31 +102,23 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
Default version: `2.8.0`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tensorflow-for-c/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tensorflow-for-c/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tensorflow-for-c/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tensorflow-for-c/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tensorflow-for-c/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tensorflow-for-c/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tensorflow-for-c/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tensorflow-for-c/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tensorflow-for-c/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tensorflow-for-c/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tensorflow-for-c/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tensorflow-for-c/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tensorflow-for-c/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tensorflow-for-c/_cm.json)
___
### Script output
-`cmr "install tensorflow lib lang-c" -j`
+`cmr "install tensorflow lib lang-c " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/install-tensorflow-from-src/README.md b/cm-mlops/script/install-tensorflow-from-src/README.md
index 0acb4770a4..febdbbd0f3 100644
--- a/cm-mlops/script/install-tensorflow-from-src/README.md
+++ b/cm-mlops/script/install-tensorflow-from-src/README.md
@@ -1,59 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ 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)
+Automatically generated README for this automation recipe: **install-tensorflow-from-src**
-
+Category: **AI/ML frameworks**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-tensorflow-from-src,a974533c4c854597) ]*
+---
#### 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/install-tensorflow-from-src)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tensorflow-from-src)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,install,tensorflow,lib,source,from-source,from-src,src,from.src*
+* All CM tags to find and reuse this script (see in above meta description): *get,install,tensorflow,lib,source,from-source,from-src,src,from.src*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get install tensorflow lib source from-source from-src src from.src" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,install,tensorflow,lib,source,from-source,from-src,src,from.src`
-#### Run this script from command line
+`cm run script --tags=get,install,tensorflow,lib,source,from-source,from-src,src,from.src[,variations] `
-1. `cm run script --tags=get,install,tensorflow,lib,source,from-source,from-src,src,from.src[,variations] `
+*or*
-2. `cmr "get install tensorflow lib source from-source from-src src from.src[ variations]" `
+`cmr "get install tensorflow lib source from-source from-src src from.src"`
-* `variations` can be seen [here](#variations)
+`cmr "get install tensorflow lib source from-source from-src src from.src [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -89,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=get,install,tensorflow
#### Run this script via Docker (beta)
-`cm docker script "get install tensorflow lib source from-source from-src src from.src[ variations]" `
+`cm docker script "get install tensorflow lib source from-source from-src src from.src[variations]" `
___
### Customization
@@ -137,12 +133,10 @@ Default version: `master`
* `v2.8.0`
* `v2.9.0`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tensorflow-from-src/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tensorflow-from-src/_cm.json)***
* detect,cpu
- CM script: [detect-cpu](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
* detect,os
@@ -152,18 +146,17 @@ ___
- CM script: [get-generic-sys-util](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-sys-util)
* get,generic-python-lib,_package.numpy
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tensorflow-from-src/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tensorflow-from-src/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tensorflow-from-src/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tensorflow-from-src/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tensorflow-from-src/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tensorflow-from-src/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tensorflow-from-src/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tensorflow-from-src/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tensorflow-from-src/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tensorflow-from-src/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tensorflow-from-src/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tensorflow-from-src/_cm.json)
___
### Script output
-`cmr "get install tensorflow lib source from-source from-src src from.src[,variations]" -j`
+`cmr "get install tensorflow lib source from-source from-src src from.src [,variations]" -j`
#### New environment keys (filter)
* `+CPLUS_INCLUDE_PATH`
@@ -171,8 +164,3 @@ ___
* `+DYLD_FALLBACK_LIBRARY_PATH`
* `+LD_LIBRARY_PATH`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/install-terraform-from-src/README.md b/cm-mlops/script/install-terraform-from-src/README.md
index 6a36255b11..d839f25113 100644
--- a/cm-mlops/script/install-terraform-from-src/README.md
+++ b/cm-mlops/script/install-terraform-from-src/README.md
@@ -1,56 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
+Automatically generated README for this automation recipe: **install-terraform-from-src**
-
+Category: **Cloud automation**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-terraform-from-src,d79d47a074f34428) ]*
+
+---
#### Summary
-* Category: *Cloud automation.*
-* 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/install-terraform-from-src)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-terraform-from-src)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,terraform,from-src*
+* All CM tags to find and reuse this script (see in above meta description): *install,terraform,from-src*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install terraform from-src" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=install,terraform,from-src`
-1. `cm run script --tags=install,terraform,from-src `
+`cm run script --tags=install,terraform,from-src `
+
+*or*
+
+`cmr "install terraform from-src"`
+
+`cmr "install terraform from-src " `
-2. `cmr "install terraform from-src" `
#### Run this script from Python
@@ -106,28 +103,25 @@ Default version: `main`
* `main`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-terraform-from-src/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-terraform-from-src/_cm.json)***
* detect,cpu
- CM script: [detect-cpu](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
* get,tool,go
- CM script: [get-go](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-go)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-terraform-from-src/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-terraform-from-src/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-terraform-from-src/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-terraform-from-src/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-terraform-from-src/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-terraform-from-src/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-terraform-from-src/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-terraform-from-src/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-terraform-from-src/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-terraform-from-src/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-terraform-from-src/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-terraform-from-src/_cm.json)
___
### Script output
-`cmr "install terraform from-src" -j`
+`cmr "install terraform from-src " -j`
#### New environment keys (filter)
* `+PATH`
@@ -135,8 +129,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_TERRAFORM_BIN_WITH_PATH`
-* `CM_TERRAFORM_INSTALLED_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_TERRAFORM_INSTALLED_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/install-tflite-from-src/README.md b/cm-mlops/script/install-tflite-from-src/README.md
index ba198aaf30..2fde922659 100644
--- a/cm-mlops/script/install-tflite-from-src/README.md
+++ b/cm-mlops/script/install-tflite-from-src/README.md
@@ -1,56 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
+Automatically generated README for this automation recipe: **install-tflite-from-src**
-
+Category: **AI/ML frameworks**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-tflite-from-src,5c72dab5eb88407c) ]*
+---
#### 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/install-tflite-from-src)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tflite-from-src)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *get,install,tflite-cmake,tensorflow-lite-cmake,from-src*
+* All CM tags to find and reuse this script (see in above meta description): *get,install,tflite-cmake,tensorflow-lite-cmake,from-src*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "get install tflite-cmake tensorflow-lite-cmake from-src" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=get,install,tflite-cmake,tensorflow-lite-cmake,from-src`
-#### Run this script from command line
+`cm run script --tags=get,install,tflite-cmake,tensorflow-lite-cmake,from-src `
-1. `cm run script --tags=get,install,tflite-cmake,tensorflow-lite-cmake,from-src `
+*or*
+
+`cmr "get install tflite-cmake tensorflow-lite-cmake from-src"`
+
+`cmr "get install tflite-cmake tensorflow-lite-cmake from-src " `
-2. `cmr "get install tflite-cmake tensorflow-lite-cmake from-src" `
#### Run this script from Python
@@ -107,12 +104,10 @@ Default version: `master`
* `master`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tflite-from-src/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tflite-from-src/_cm.json)***
* detect,cpu
- CM script: [detect-cpu](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
* get,compiler
@@ -122,18 +117,17 @@ ___
- CM script: [get-llvm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-llvm)
* get,cmake
- CM script: [get-cmake](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmake)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tflite-from-src/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tflite-from-src/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tflite-from-src/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tflite-from-src/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tflite-from-src/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tflite-from-src/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tflite-from-src/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tflite-from-src/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tflite-from-src/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tflite-from-src/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tflite-from-src/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tflite-from-src/_cm.json)
___
### Script output
-`cmr "get install tflite-cmake tensorflow-lite-cmake from-src" -j`
+`cmr "get install tflite-cmake tensorflow-lite-cmake from-src " -j`
#### New environment keys (filter)
* `+CPLUS_INCLUDE_PATH`
@@ -141,8 +135,3 @@ ___
* `+DYLD_FALLBACK_LIBRARY_PATH`
* `+LD_LIBRARY_PATH`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/install-torchvision-from-src/README.md b/cm-mlops/script/install-torchvision-from-src/README.md
index d01effb76e..34e41647f8 100644
--- a/cm-mlops/script/install-torchvision-from-src/README.md
+++ b/cm-mlops/script/install-torchvision-from-src/README.md
@@ -1,60 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **install-torchvision-from-src**
-
+Category: **Compiler automation**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-*Build pytorchvision from sources.*
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-torchvision-from-src,68b855780d474546) ]*
+---
#### Summary
-* Category: *Compiler automation.*
-* 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/install-torchvision-from-src)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-torchvision-from-src)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,get,src,from.src,pytorchvision,torchvision,src-pytorchvision*
+* All CM tags to find and reuse this script (see in above meta description): *install,get,src,from.src,pytorchvision,torchvision,src-pytorchvision*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install get src from.src pytorchvision torchvision src-pytorchvision" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,get,src,from.src,pytorchvision,torchvision,src-pytorchvision`
-#### Run this script from command line
+`cm run script --tags=install,get,src,from.src,pytorchvision,torchvision,src-pytorchvision[,variations] `
-1. `cm run script --tags=install,get,src,from.src,pytorchvision,torchvision,src-pytorchvision[,variations] `
+*or*
-2. `cmr "install get src from.src pytorchvision torchvision src-pytorchvision[ variations]" `
+`cmr "install get src from.src pytorchvision torchvision src-pytorchvision"`
-* `variations` can be seen [here](#variations)
+`cmr "install get src from.src pytorchvision torchvision src-pytorchvision [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -90,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=install,get,src,from.s
#### Run this script via Docker (beta)
-`cm docker script "install get src from.src pytorchvision torchvision src-pytorchvision[ variations]" `
+`cm docker script "install get src from.src pytorchvision torchvision src-pytorchvision[variations]" `
___
### Customization
@@ -168,12 +163,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-torchvision-from-src/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-torchvision-from-src/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -185,24 +178,18 @@ ___
* get,git,repo
* CM names: `--adr.['pytorchision-src-repo', 'torchision-src-repo']...`
- 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/install-torchvision-from-src/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-torchvision-from-src/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-torchvision-from-src/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-torchvision-from-src/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-torchvision-from-src/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-torchvision-from-src/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-torchvision-from-src/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-torchvision-from-src/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-torchvision-from-src/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-torchvision-from-src/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-torchvision-from-src/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-torchvision-from-src/_cm.json)
___
### Script output
-`cmr "install get src from.src pytorchvision torchvision src-pytorchvision[,variations]" -j`
+`cmr "install get src from.src pytorchvision torchvision src-pytorchvision [,variations]" -j`
#### New environment keys (filter)
* `CM_PYTORCHVISION_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/install-tpp-pytorch-extension/README.md b/cm-mlops/script/install-tpp-pytorch-extension/README.md
index 18b42e6244..b55bfe432c 100644
--- a/cm-mlops/script/install-tpp-pytorch-extension/README.md
+++ b/cm-mlops/script/install-tpp-pytorch-extension/README.md
@@ -1,60 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **install-tpp-pytorch-extension**
-
+Category: **Compiler automation**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-*Build TPP-PEX from sources.*
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-tpp-pytorch-extension,1701d2f5f4e84d42) ]*
+---
#### Summary
-* Category: *Compiler automation.*
-* 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/install-tpp-pytorch-extension)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tpp-pytorch-extension)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,get,src,from.src,tpp-pex,src-tpp-pex*
+* All CM tags to find and reuse this script (see in above meta description): *install,get,src,from.src,tpp-pex,src-tpp-pex*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install get src from.src tpp-pex src-tpp-pex" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,get,src,from.src,tpp-pex,src-tpp-pex`
-#### Run this script from command line
+`cm run script --tags=install,get,src,from.src,tpp-pex,src-tpp-pex[,variations] `
-1. `cm run script --tags=install,get,src,from.src,tpp-pex,src-tpp-pex[,variations] `
+*or*
-2. `cmr "install get src from.src tpp-pex src-tpp-pex[ variations]" `
+`cmr "install get src from.src tpp-pex src-tpp-pex"`
-* `variations` can be seen [here](#variations)
+`cmr "install get src from.src tpp-pex src-tpp-pex [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -90,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=install,get,src,from.s
#### Run this script via Docker (beta)
-`cm docker script "install get src from.src tpp-pex src-tpp-pex[ variations]" `
+`cm docker script "install get src from.src tpp-pex src-tpp-pex[variations]" `
___
### Customization
@@ -167,12 +162,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tpp-pytorch-extension/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tpp-pytorch-extension/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -188,24 +181,18 @@ ___
* get,git,repo
* CM names: `--adr.['tpp-pex-src-repo']...`
- 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/install-tpp-pytorch-extension/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tpp-pytorch-extension/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tpp-pytorch-extension/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tpp-pytorch-extension/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tpp-pytorch-extension/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tpp-pytorch-extension/_cm.json)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tpp-pytorch-extension/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tpp-pytorch-extension/_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/install-tpp-pytorch-extension/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tpp-pytorch-extension/_cm.json)
___
### Script output
-`cmr "install get src from.src tpp-pex src-tpp-pex[,variations]" -j`
+`cmr "install get src from.src tpp-pex src-tpp-pex [,variations]" -j`
#### New environment keys (filter)
* `CM_TPP_PEX_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/install-transformers-from-src/README.md b/cm-mlops/script/install-transformers-from-src/README.md
index 06e922a29f..f1db25e6cd 100644
--- a/cm-mlops/script/install-transformers-from-src/README.md
+++ b/cm-mlops/script/install-transformers-from-src/README.md
@@ -1,60 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **install-transformers-from-src**
-
+Category: **Compiler automation**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-*Build transformers from sources.*
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=install-transformers-from-src,88512c48ea5c4186) ]*
+---
#### Summary
-* Category: *Compiler automation.*
-* 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/install-transformers-from-src)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-transformers-from-src)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *install,src,from.src,transformers,src-transformers*
+* All CM tags to find and reuse this script (see in above meta description): *install,src,from.src,transformers,src-transformers*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "install src from.src transformers src-transformers" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=install,src,from.src,transformers,src-transformers`
-#### Run this script from command line
+`cm run script --tags=install,src,from.src,transformers,src-transformers[,variations] `
-1. `cm run script --tags=install,src,from.src,transformers,src-transformers[,variations] `
+*or*
-2. `cmr "install src from.src transformers src-transformers[ variations]" `
+`cmr "install src from.src transformers src-transformers"`
-* `variations` can be seen [here](#variations)
+`cmr "install src from.src transformers src-transformers [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -90,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=install,src,from.src,t
#### Run this script via Docker (beta)
-`cm docker script "install src from.src transformers src-transformers[ variations]" `
+`cm docker script "install src from.src transformers src-transformers[variations]" `
___
### Customization
@@ -165,12 +160,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-transformers-from-src/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-transformers-from-src/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -186,24 +179,18 @@ ___
* get,git,repo
* CM names: `--adr.['transformers-src-repo']...`
- 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/install-transformers-from-src/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-transformers-from-src/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-transformers-from-src/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-transformers-from-src/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-transformers-from-src/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-transformers-from-src/_cm.json)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-transformers-from-src/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-transformers-from-src/_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/install-transformers-from-src/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-transformers-from-src/_cm.json)
___
### Script output
-`cmr "install src from.src transformers src-transformers[,variations]" -j`
+`cmr "install src from.src transformers src-transformers [,variations]" -j`
#### New environment keys (filter)
* `CM_TRANSFORMERS_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/launch-benchmark/README.md b/cm-mlops/script/launch-benchmark/README.md
index 8828daf496..2e8a813899 100644
--- a/cm-mlops/script/launch-benchmark/README.md
+++ b/cm-mlops/script/launch-benchmark/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
-
-
+Automatically generated README for this automation recipe: **launch-benchmark**
-*Note that this README is automatically generated - don't edit!*
+Category: **Collective benchmarking**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=launch-benchmark,5dc7662804bc4cad) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Collective benchmarking.*
-* 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/launch-benchmark)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/launch-benchmark)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *launch,benchmark*
+* All CM tags to find and reuse this script (see in above meta description): *launch,benchmark*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "launch benchmark" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=launch,benchmark`
-#### Run this script from command line
+`cm run script --tags=launch,benchmark `
-1. `cm run script --tags=launch,benchmark `
+*or*
+
+`cmr "launch benchmark"`
+
+`cmr "launch benchmark " `
-2. `cmr "launch benchmark" `
#### Run this script from Python
@@ -104,28 +99,20 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/launch-benchmark/_cm.yaml)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/launch-benchmark/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/launch-benchmark/_cm.yaml)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/launch-benchmark/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/launch-benchmark/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/launch-benchmark/_cm.yaml)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/launch-benchmark/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/launch-benchmark/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/launch-benchmark/_cm.yaml)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/launch-benchmark/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/launch-benchmark/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/launch-benchmark/_cm.yaml)
___
### Script output
-`cmr "launch benchmark" -j`
+`cmr "launch benchmark " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/prepare-training-data-bert/README.md b/cm-mlops/script/prepare-training-data-bert/README.md
index e0e8d7b520..0cf162f6e1 100644
--- a/cm-mlops/script/prepare-training-data-bert/README.md
+++ b/cm-mlops/script/prepare-training-data-bert/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **prepare-training-data-bert**
-
+Category: **MLPerf benchmark support**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=prepare-training-data-bert,1e06a7abe23545eb) ]*
+
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/prepare-training-data-bert)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-bert)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *prepare,mlperf,training,data,input,bert*
+* All CM tags to find and reuse this script (see in above meta description): *prepare,mlperf,training,data,input,bert*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "prepare mlperf training data input bert" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=prepare,mlperf,training,data,input,bert`
-1. `cm run script --tags=prepare,mlperf,training,data,input,bert[,variations] [--input_flags]`
+`cm run script --tags=prepare,mlperf,training,data,input,bert[,variations] [--input_flags]`
-2. `cmr "prepare mlperf training data input bert[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "prepare mlperf training data input bert"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "prepare mlperf training data input bert [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=prepare,mlperf,trainin
#### Run this script via Docker (beta)
-`cm docker script "prepare mlperf training data input bert[ variations]" [--input_flags]`
+`cm docker script "prepare mlperf training data input bert[variations]" [--input_flags]`
___
### Customization
@@ -159,14 +153,12 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-bert/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-bert/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-bert/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-bert/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-bert/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-bert/_cm.json)***
* download,file,_gdown,_url.https://drive.google.com/uc?id=1fbGClQMi2CoMv7fwrwTC5YYPooQBdcFW
- CM script: [download-file](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-file)
* download,file,_gdown,_url.https://drive.google.com/uc?id=1USK108J6hMM_d27xCHi738qBL8_BT1u1
@@ -182,17 +174,16 @@ ___
* download,file,_gdown,_url.https://drive.google.com/uc?id=1vAcVmXSLsLeQ1q7gvHnQUSth5W_f_pwv
- CM script: [download-file](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-file)
1. ***Run native script if exists***
- * [run-nvidia.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-bert/run-nvidia.sh)
- * [run-reference.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-bert/run-reference.sh)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-bert/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-bert/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-bert/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-bert/_cm.json)
-
+ * [run-nvidia.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-bert/run-nvidia.sh)
+ * [run-reference.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-bert/run-reference.sh)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-bert/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-bert/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-bert/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-bert/_cm.json)
___
### Script output
-`cmr "prepare mlperf training data input bert[,variations]" [--input_flags] -j`
+`cmr "prepare mlperf training data input bert [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_MLPERF_TRAINING_BERT_*`
@@ -201,8 +192,4 @@ ___
* `CM_MLPERF_TRAINING_BERT_CONFIG_PATH`
* `CM_MLPERF_TRAINING_BERT_DATA_PATH`
* `CM_MLPERF_TRAINING_BERT_TFRECORDS_PATH`
-* `CM_MLPERF_TRAINING_BERT_VOCAB_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_MLPERF_TRAINING_BERT_VOCAB_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/prepare-training-data-resnet/README.md b/cm-mlops/script/prepare-training-data-resnet/README.md
index 8a086a50ed..cb2e437847 100644
--- a/cm-mlops/script/prepare-training-data-resnet/README.md
+++ b/cm-mlops/script/prepare-training-data-resnet/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **prepare-training-data-resnet**
-
+Category: **MLPerf benchmark support**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=prepare-training-data-resnet,d42a8a8ca2704f9f) ]*
+
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/prepare-training-data-resnet)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-resnet)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *prepare,mlperf,training,data,input,resnet*
+* All CM tags to find and reuse this script (see in above meta description): *prepare,mlperf,training,data,input,resnet*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "prepare mlperf training data input resnet" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=prepare,mlperf,training,data,input,resnet`
-1. `cm run script --tags=prepare,mlperf,training,data,input,resnet[,variations] [--input_flags]`
+`cm run script --tags=prepare,mlperf,training,data,input,resnet[,variations] [--input_flags]`
-2. `cmr "prepare mlperf training data input resnet[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "prepare mlperf training data input resnet"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "prepare mlperf training data input resnet [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=prepare,mlperf,trainin
#### Run this script via Docker (beta)
-`cm docker script "prepare mlperf training data input resnet[ variations]" [--input_flags]`
+`cm docker script "prepare mlperf training data input resnet[variations]" [--input_flags]`
___
### Customization
@@ -173,12 +167,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-resnet/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-resnet/_cm.json)***
* get,dataset,imagenet,train
* CM names: `--adr.['imagenet-train']...`
- CM script: [get-dataset-imagenet-train](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-train)
@@ -187,24 +179,23 @@ ___
- CM script: [get-dataset-imagenet-val](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-val)
* get,generic-sys-util,_rsync
- CM script: [get-generic-sys-util](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-sys-util)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-resnet/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-resnet/_cm.json)***
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-resnet/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-resnet/_cm.json)***
* download,file,_wget,_url.https://raw.githubusercontent.com/tensorflow/models/master/research/slim/datasets/imagenet_2012_validation_synset_labels.txt
- CM script: [download-file](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-file)
* download,file,_wget,_url.https://raw.githubusercontent.com/tensorflow/tpu/master/tools/datasets/imagenet_to_gcs.py
* `if (CM_TMP_VARIATION == reference)`
- CM script: [download-file](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-file)
1. ***Run native script if exists***
- * [run-nvidia.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-resnet/run-nvidia.sh)
- * [run-reference.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-resnet/run-reference.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-resnet/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-resnet/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-resnet/_cm.json)
-
+ * [run-nvidia.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-resnet/run-nvidia.sh)
+ * [run-reference.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-resnet/run-reference.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-resnet/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-resnet/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-resnet/_cm.json)
___
### Script output
-`cmr "prepare mlperf training data input resnet[,variations]" [--input_flags] -j`
+`cmr "prepare mlperf training data input resnet [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_MLPERF_TRAINING_NVIDIA_RESNET_PREPROCESSED_PATH`
@@ -213,8 +204,4 @@ ___
* `CM_MLPERF_TRAINING_NVIDIA_RESNET_PREPROCESSED_PATH`
* `CM_MLPERF_TRAINING_RESNET_DATA_PATH`
-* `CM_MLPERF_TRAINING_RESNET_TFRECORDS_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_MLPERF_TRAINING_RESNET_TFRECORDS_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/preprocess-mlperf-inference-submission/README.md b/cm-mlops/script/preprocess-mlperf-inference-submission/README.md
index 138d4dcf48..322583a506 100644
--- a/cm-mlops/script/preprocess-mlperf-inference-submission/README.md
+++ b/cm-mlops/script/preprocess-mlperf-inference-submission/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **preprocess-mlperf-inference-submission**
-
+Category: **MLPerf benchmark support**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=preprocess-mlperf-inference-submission,c23068394a314266) ]*
+
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/preprocess-mlperf-inference-submission)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/preprocess-mlperf-inference-submission)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *run,mlc,mlcommons,mlperf,inference,submission,mlperf-inference,processor,preprocessor,preprocess*
+* All CM tags to find and reuse this script (see in above meta description): *run,mlc,mlcommons,mlperf,inference,submission,mlperf-inference,processor,preprocessor,preprocess*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "run mlc mlcommons mlperf inference submission mlperf-inference processor preprocessor preprocess" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=run,mlc,mlcommons,mlperf,inference,submission,mlperf-inference,processor,preprocessor,preprocess`
-1. `cm run script --tags=run,mlc,mlcommons,mlperf,inference,submission,mlperf-inference,processor,preprocessor,preprocess [--input_flags]`
+`cm run script --tags=run,mlc,mlcommons,mlperf,inference,submission,mlperf-inference,processor,preprocessor,preprocess [--input_flags]`
-2. `cmr "run mlc mlcommons mlperf inference submission mlperf-inference processor preprocessor preprocess" [--input_flags]`
+*or*
+
+`cmr "run mlc mlcommons mlperf inference submission mlperf-inference processor preprocessor preprocess"`
+
+`cmr "run mlc mlcommons mlperf inference submission mlperf-inference processor preprocessor preprocess " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -120,12 +115,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/preprocess-mlperf-inference-submission/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/preprocess-mlperf-inference-submission/_cm.json)***
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
@@ -136,23 +129,17 @@ ___
* `if (CM_MLPERF_INFERENCE_SUBMISSION_DIR != on)`
* CM names: `--adr.['get-mlperf-submission-dir']...`
- CM script: [get-mlperf-inference-submission-dir](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-submission-dir)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/preprocess-mlperf-inference-submission/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/preprocess-mlperf-inference-submission/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/preprocess-mlperf-inference-submission/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/preprocess-mlperf-inference-submission/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/preprocess-mlperf-inference-submission/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/preprocess-mlperf-inference-submission/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/preprocess-mlperf-inference-submission/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/preprocess-mlperf-inference-submission/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/preprocess-mlperf-inference-submission/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/preprocess-mlperf-inference-submission/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/preprocess-mlperf-inference-submission/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/preprocess-mlperf-inference-submission/_cm.json)
___
### Script output
-`cmr "run mlc mlcommons mlperf inference submission mlperf-inference processor preprocessor preprocess" [--input_flags] -j`
+`cmr "run mlc mlcommons mlperf inference submission mlperf-inference processor preprocessor preprocess " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/print-croissant-desc/README.md b/cm-mlops/script/print-croissant-desc/README.md
index 01ffc884db..1d7e989a32 100644
--- a/cm-mlops/script/print-croissant-desc/README.md
+++ b/cm-mlops/script/print-croissant-desc/README.md
@@ -1,61 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **print-croissant-desc**
-*Note that this README is automatically generated - don't edit!*
+Category: **Tests**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=print-croissant-desc,59116d5c98a04d4f) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Tests.*
-* 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/print-croissant-desc)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-croissant-desc)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *print,croissant,desc*
+* All CM tags to find and reuse this script (see in above meta description): *print,croissant,desc*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "print croissant desc" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=print,croissant,desc`
-1. `cm run script --tags=print,croissant,desc [--input_flags]`
+`cm run script --tags=print,croissant,desc [--input_flags]`
-2. `cmr "print croissant desc" [--input_flags]`
+*or*
+
+`cmr "print croissant desc"`
+
+`cmr "print croissant desc " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -123,12 +115,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-croissant-desc/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-croissant-desc/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,sys-utils-cm
@@ -140,23 +130,17 @@ ___
* CM names: `--adr.['croissant']...`
- CM script: [get-croissant](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-croissant)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-croissant-desc/_cm.yaml)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-croissant-desc/_cm.yaml)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-croissant-desc/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-croissant-desc/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-croissant-desc/_cm.yaml)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-croissant-desc/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-croissant-desc/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-croissant-desc/_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/print-croissant-desc/_cm.yaml)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-croissant-desc/_cm.yaml)
___
### Script output
-`cmr "print croissant desc" [--input_flags] -j`
+`cmr "print croissant desc " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/print-hello-world-java/README.md b/cm-mlops/script/print-hello-world-java/README.md
index a2b0a02007..af2aacf9b6 100644
--- a/cm-mlops/script/print-hello-world-java/README.md
+++ b/cm-mlops/script/print-hello-world-java/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **print-hello-world-java**
-
+Category: **Tests**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=print-hello-world-java,3b62dc46cce3489c) ]*
+---
#### Summary
-* Category: *Tests.*
-* 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/print-hello-world-java)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-java)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *print,hello world,hello-world,hello,world,java*
+* All CM tags to find and reuse this script (see in above meta description): *print,hello world,hello-world,hello,world,java*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "print hello world hello-world hello world java" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=print,hello world,hello-world,hello,world,java`
-#### Run this script from command line
+`cm run script --tags=print,hello world,hello-world,hello,world,java `
-1. `cm run script --tags=print,hello world,hello-world,hello,world,java `
+*or*
+
+`cmr "print hello world hello-world hello world java"`
+
+`cmr "print hello world hello-world hello world java " `
-2. `cmr "print hello world hello-world hello world java" `
#### Run this script from Python
@@ -101,35 +99,27 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-java/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-java/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,java
* CM names: `--adr.['java']...`
- CM script: [get-java](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-java)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-java/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-java/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-java/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-java/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-java/_cm.json)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-java/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-java/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-java/_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/print-hello-world-java/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-java/_cm.json)
___
### Script output
-`cmr "print hello world hello-world hello world java" -j`
+`cmr "print hello world hello-world hello world java " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/print-hello-world-javac/README.md b/cm-mlops/script/print-hello-world-javac/README.md
index 5d51c01b5c..ef9a2e6a7e 100644
--- a/cm-mlops/script/print-hello-world-javac/README.md
+++ b/cm-mlops/script/print-hello-world-javac/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **print-hello-world-javac**
-
+Category: **Tests**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=print-hello-world-javac,040fafd538104819) ]*
+---
#### Summary
-* Category: *Tests.*
-* 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/print-hello-world-javac)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-javac)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *print,hello world,hello-world,hello,world,javac*
+* All CM tags to find and reuse this script (see in above meta description): *print,hello world,hello-world,hello,world,javac*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "print hello world hello-world hello world javac" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=print,hello world,hello-world,hello,world,javac`
-#### Run this script from command line
+`cm run script --tags=print,hello world,hello-world,hello,world,javac `
-1. `cm run script --tags=print,hello world,hello-world,hello,world,javac `
+*or*
+
+`cmr "print hello world hello-world hello world javac"`
+
+`cmr "print hello world hello-world hello world javac " `
-2. `cmr "print hello world hello-world hello world javac" `
#### Run this script from Python
@@ -101,35 +99,27 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-javac/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-javac/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,javac
* CM names: `--adr.['javac']...`
- CM script: [get-javac](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-javac)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-javac/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-javac/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-javac/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-javac/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-javac/_cm.json)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-javac/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-javac/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-javac/_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/print-hello-world-javac/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-javac/_cm.json)
___
### Script output
-`cmr "print hello world hello-world hello world javac" -j`
+`cmr "print hello world hello-world hello world javac " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/print-hello-world-py/README.md b/cm-mlops/script/print-hello-world-py/README.md
index b8e800dc3c..9b6618c197 100644
--- a/cm-mlops/script/print-hello-world-py/README.md
+++ b/cm-mlops/script/print-hello-world-py/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **print-hello-world-py**
-
+Category: **Tests**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=print-hello-world-py,d83274c7eb754d90) ]*
+---
#### Summary
-* Category: *Tests.*
-* 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/print-hello-world-py)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-py)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *print,hello world,hello-world,hello,world,python*
+* All CM tags to find and reuse this script (see in above meta description): *print,hello world,hello-world,hello,world,python*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "print hello world hello-world hello world python" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=print,hello world,hello-world,hello,world,python`
-#### Run this script from command line
+`cm run script --tags=print,hello world,hello-world,hello,world,python `
-1. `cm run script --tags=print,hello world,hello-world,hello,world,python `
+*or*
+
+`cmr "print hello world hello-world hello world python"`
+
+`cmr "print hello world hello-world hello world python " `
-2. `cmr "print hello world hello-world hello world python" `
#### Run this script from Python
@@ -101,12 +99,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-py/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-py/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,sys-utils-cm
@@ -118,23 +114,17 @@ ___
* `if (CM_SKIP_PRINT != True OR CM_SKIP_PRINT2 != True)`
- CM script: [print-python-version](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-python-version)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-py/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-py/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-py/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-py/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-py/_cm.json)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-py/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-py/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-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/print-hello-world-py/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-py/_cm.json)
___
### Script output
-`cmr "print hello world hello-world hello world python" -j`
+`cmr "print hello world hello-world hello world python " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/print-hello-world/README.md b/cm-mlops/script/print-hello-world/README.md
index f42c40fe23..d2f6d33263 100644
--- a/cm-mlops/script/print-hello-world/README.md
+++ b/cm-mlops/script/print-hello-world/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **print-hello-world**
-
+Category: **Tests**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=print-hello-world,b9f0acba4aca4baa) ]*
+
+---
#### Summary
-* Category: *Tests.*
-* 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/print-hello-world)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *print,hello-world,hello world,hello,world,native-script,native,script*
+* All CM tags to find and reuse this script (see in above meta description): *print,hello-world,hello world,hello,world,native-script,native,script*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "print hello-world hello world hello world native-script native script" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=print,hello-world,hello world,hello,world,native-script,native,script`
-1. `cm run script --tags=print,hello-world,hello world,hello,world,native-script,native,script [--input_flags]`
+`cm run script --tags=print,hello-world,hello world,hello,world,native-script,native,script [--input_flags]`
-2. `cmr "print hello-world hello world hello world native-script native script" [--input_flags]`
+*or*
+
+`cmr "print hello-world hello world hello world native-script native script"`
+
+`cmr "print hello-world hello world hello world native-script native script " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -120,31 +115,23 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world/_cm.json)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world/_cm.json)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world/_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/print-hello-world/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world/_cm.json)
___
### Script output
-`cmr "print hello-world hello world hello world native-script native script" [--input_flags] -j`
+`cmr "print hello-world hello world hello world native-script native script " [--input_flags] -j`
#### New environment keys (filter)
* `CM_ENV_TEST*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/print-python-version/README.md b/cm-mlops/script/print-python-version/README.md
index 04fbfbced8..a18eb31f44 100644
--- a/cm-mlops/script/print-python-version/README.md
+++ b/cm-mlops/script/print-python-version/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **print-python-version**
-
+Category: **Tests**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=print-python-version,d3a538fa4abb464b) ]*
+---
#### Summary
-* Category: *Tests.*
-* 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/print-python-version)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-python-version)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *print,python,version,python-version*
+* All CM tags to find and reuse this script (see in above meta description): *print,python,version,python-version*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "print python version python-version" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=print,python,version,python-version`
-#### Run this script from command line
+`cm run script --tags=print,python,version,python-version `
-1. `cm run script --tags=print,python,version,python-version `
+*or*
+
+`cmr "print python version python-version"`
+
+`cmr "print python version python-version " `
-2. `cmr "print python version python-version" `
#### Run this script from Python
@@ -101,33 +99,25 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-python-version/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-python-version/_cm.json)***
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-python-version/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-python-version/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-python-version/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-python-version/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-python-version/_cm.json)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-python-version/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-python-version/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-python-version/_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/print-python-version/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-python-version/_cm.json)
___
### Script output
-`cmr "print python version python-version" -j`
+`cmr "print python version python-version " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/process-ae-users/README.md b/cm-mlops/script/process-ae-users/README.md
index 41213ac674..326236b746 100644
--- a/cm-mlops/script/process-ae-users/README.md
+++ b/cm-mlops/script/process-ae-users/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **process-ae-users**
-
+Category: **Reproducibility and artifact evaluation**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=process-ae-users,5800f1ed677e4efb) ]*
+
+---
#### Summary
-* Category: *Reproducibility and artifact evaluation.*
-* 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/process-ae-users)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/process-ae-users)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *process,ae,users*
+* All CM tags to find and reuse this script (see in above meta description): *process,ae,users*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "process ae users" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=process,ae,users`
-1. `cm run script --tags=process,ae,users [--input_flags]`
+`cm run script --tags=process,ae,users [--input_flags]`
-2. `cmr "process ae users" [--input_flags]`
+*or*
+
+`cmr "process ae users"`
+
+`cmr "process ae users " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -119,33 +114,25 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/process-ae-users/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/process-ae-users/_cm.json)***
* get,python3
* CM names: `--adr.['python3', 'python']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/process-ae-users/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/process-ae-users/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/process-ae-users/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/process-ae-users/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/process-ae-users/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/process-ae-users/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/process-ae-users/_cm.json)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/process-ae-users/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/process-ae-users/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/process-ae-users/_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/process-ae-users/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/process-ae-users/_cm.json)
___
### Script output
-`cmr "process ae users" [--input_flags] -j`
+`cmr "process ae users " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/process-mlperf-accuracy/README.md b/cm-mlops/script/process-mlperf-accuracy/README.md
index 23a8ff556b..ff6fe6e805 100644
--- a/cm-mlops/script/process-mlperf-accuracy/README.md
+++ b/cm-mlops/script/process-mlperf-accuracy/README.md
@@ -1,61 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **process-mlperf-accuracy**
-
+Category: **MLPerf benchmark support**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=process-mlperf-accuracy,6e809013816b42ea) ]*
+
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/process-mlperf-accuracy)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/process-mlperf-accuracy)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *run,mlperf,mlcommons,accuracy,mlc,process,process-accuracy*
+* All CM tags to find and reuse this script (see in above meta description): *run,mlperf,mlcommons,accuracy,mlc,process,process-accuracy*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "run mlperf mlcommons accuracy mlc process process-accuracy" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=run,mlperf,mlcommons,accuracy,mlc,process,process-accuracy`
-1. `cm run script --tags=run,mlperf,mlcommons,accuracy,mlc,process,process-accuracy[,variations] [--input_flags]`
+`cm run script --tags=run,mlperf,mlcommons,accuracy,mlc,process,process-accuracy[,variations] [--input_flags]`
-2. `cmr "run mlperf mlcommons accuracy mlc process process-accuracy[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "run mlperf mlcommons accuracy mlc process process-accuracy"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "run mlperf mlcommons accuracy mlc process process-accuracy [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -91,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=run,mlperf,mlcommons,a
#### Run this script via Docker (beta)
-`cm docker script "run mlperf mlcommons accuracy mlc process process-accuracy[ variations]" [--input_flags]`
+`cm docker script "run mlperf mlcommons accuracy mlc process process-accuracy[variations]" [--input_flags]`
___
### Customization
@@ -311,36 +305,28 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/process-mlperf-accuracy/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/process-mlperf-accuracy/_cm.json)***
* get,python3
* CM names: `--adr.['python3', 'python']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
* get,mlcommons,inference,src
* CM names: `--adr.['inference-src', 'accuracy-check-src']...`
- CM script: [get-mlperf-inference-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-src)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/process-mlperf-accuracy/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/process-mlperf-accuracy/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/process-mlperf-accuracy/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/process-mlperf-accuracy/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/process-mlperf-accuracy/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/process-mlperf-accuracy/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/process-mlperf-accuracy/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/process-mlperf-accuracy/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/process-mlperf-accuracy/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/process-mlperf-accuracy/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/process-mlperf-accuracy/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/process-mlperf-accuracy/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/process-mlperf-accuracy/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/process-mlperf-accuracy/_cm.json)
___
### Script output
-`cmr "run mlperf mlcommons accuracy mlc process process-accuracy[,variations]" [--input_flags] -j`
+`cmr "run mlperf mlcommons accuracy mlc process process-accuracy [,variations]" [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/prune-bert-models/README.md b/cm-mlops/script/prune-bert-models/README.md
index ae72d0a32c..51fb8572af 100644
--- a/cm-mlops/script/prune-bert-models/README.md
+++ b/cm-mlops/script/prune-bert-models/README.md
@@ -1,64 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **prune-bert-models**
-*Note that this README is automatically generated - don't edit!*
+Category: **AI/ML optimization**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=prune-bert-models,76182d4896414216) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *AI/ML optimization.*
-* 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/prune-bert-models)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prune-bert-models)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *prune,bert-models,bert-prune,prune-bert-models*
+* All CM tags to find and reuse this script (see in above meta description): *prune,bert-models,bert-prune,prune-bert-models*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "prune bert-models bert-prune prune-bert-models" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=prune,bert-models,bert-prune,prune-bert-models`
-1. `cm run script --tags=prune,bert-models,bert-prune,prune-bert-models[,variations] [--input_flags]`
+`cm run script --tags=prune,bert-models,bert-prune,prune-bert-models[,variations] [--input_flags]`
-2. `cmr "prune bert-models bert-prune prune-bert-models[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "prune bert-models bert-prune prune-bert-models"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "prune bert-models bert-prune prune-bert-models [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -94,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=prune,bert-models,bert
#### Run this script via Docker (beta)
-`cm docker script "prune bert-models bert-prune prune-bert-models[ variations]" [--input_flags]`
+`cm docker script "prune bert-models bert-prune prune-bert-models[variations]" [--input_flags]`
___
### Customization
@@ -153,12 +144,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prune-bert-models/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prune-bert-models/_cm.json)***
* get,python3
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
* get,generic-python-lib,_numpy
@@ -182,23 +171,17 @@ ___
* get,ml-model,model,zoo,model-zoo,huggingface,_prune
* CM names: `--adr.['get-model']...`
- CM script: [get-ml-model-huggingface-zoo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-huggingface-zoo)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prune-bert-models/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prune-bert-models/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prune-bert-models/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prune-bert-models/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prune-bert-models/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prune-bert-models/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prune-bert-models/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prune-bert-models/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prune-bert-models/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prune-bert-models/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prune-bert-models/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prune-bert-models/_cm.json)
___
### Script output
-`cmr "prune bert-models bert-prune prune-bert-models[,variations]" [--input_flags] -j`
+`cmr "prune bert-models bert-prune prune-bert-models [,variations]" [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/publish-results-to-dashboard/README.md b/cm-mlops/script/publish-results-to-dashboard/README.md
index aae665ec16..d291faab3e 100644
--- a/cm-mlops/script/publish-results-to-dashboard/README.md
+++ b/cm-mlops/script/publish-results-to-dashboard/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **publish-results-to-dashboard**
-
+Category: **Dashboard automation**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=publish-results-to-dashboard,4af3a2d09f14412b) ]*
+---
#### Summary
-* Category: *Dashboard automation.*
-* 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/publish-results-to-dashboard)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/publish-results-to-dashboard)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *publish-results,dashboard*
+* All CM tags to find and reuse this script (see in above meta description): *publish-results,dashboard*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "publish-results dashboard" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=publish-results,dashboard`
-#### Run this script from command line
+`cm run script --tags=publish-results,dashboard `
-1. `cm run script --tags=publish-results,dashboard `
+*or*
+
+`cmr "publish-results dashboard"`
+
+`cmr "publish-results dashboard " `
-2. `cmr "publish-results dashboard" `
#### Run this script from Python
@@ -101,35 +99,27 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/publish-results-to-dashboard/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/publish-results-to-dashboard/_cm.json)***
* get,python3
* CM names: `--adr.['python3', 'python']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
* get,generic-python-lib,_wandb
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/publish-results-to-dashboard/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/publish-results-to-dashboard/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/publish-results-to-dashboard/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/publish-results-to-dashboard/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/publish-results-to-dashboard/_cm.json)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/publish-results-to-dashboard/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/publish-results-to-dashboard/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/publish-results-to-dashboard/_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/publish-results-to-dashboard/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/publish-results-to-dashboard/_cm.json)
___
### Script output
-`cmr "publish-results dashboard" -j`
+`cmr "publish-results dashboard " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/pull-git-repo/README.md b/cm-mlops/script/pull-git-repo/README.md
index b975a74e51..a073a8c35e 100644
--- a/cm-mlops/script/pull-git-repo/README.md
+++ b/cm-mlops/script/pull-git-repo/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **pull-git-repo**
-
+Category: **DevOps automation**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=pull-git-repo,c23132ed65c4421d) ]*
+
+---
#### Summary
-* Category: *DevOps automation.*
-* 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/pull-git-repo)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/pull-git-repo)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *pull,git,repo,repository*
+* All CM tags to find and reuse this script (see in above meta description): *pull,git,repo,repository*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "pull git repo repository" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=pull,git,repo,repository`
-1. `cm run script --tags=pull,git,repo,repository [--input_flags]`
+`cm run script --tags=pull,git,repo,repository [--input_flags]`
-2. `cmr "pull git repo repository" [--input_flags]`
+*or*
+
+`cmr "pull git repo repository"`
+
+`cmr "pull git repo repository " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -119,31 +114,23 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/pull-git-repo/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/pull-git-repo/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/pull-git-repo/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/pull-git-repo/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/pull-git-repo/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/pull-git-repo/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/pull-git-repo/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/pull-git-repo/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/pull-git-repo/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/pull-git-repo/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/pull-git-repo/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/pull-git-repo/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/pull-git-repo/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/pull-git-repo/_cm.json)
___
### Script output
-`cmr "pull git repo repository" [--input_flags] -j`
+`cmr "pull git repo repository " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/push-csv-to-spreadsheet/README.md b/cm-mlops/script/push-csv-to-spreadsheet/README.md
index 5cf41b3b42..6f8cfcfa12 100644
--- a/cm-mlops/script/push-csv-to-spreadsheet/README.md
+++ b/cm-mlops/script/push-csv-to-spreadsheet/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **push-csv-to-spreadsheet**
-
+Category: **DevOps automation**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=push-csv-to-spreadsheet,5ec9e5fa7feb4fff) ]*
+
+---
#### Summary
-* Category: *DevOps automation.*
-* 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/push-csv-to-spreadsheet)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/push-csv-to-spreadsheet)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *push,google-spreadsheet,spreadsheet,push-to-google-spreadsheet*
+* All CM tags to find and reuse this script (see in above meta description): *push,google-spreadsheet,spreadsheet,push-to-google-spreadsheet*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "push google-spreadsheet spreadsheet push-to-google-spreadsheet" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=push,google-spreadsheet,spreadsheet,push-to-google-spreadsheet`
-1. `cm run script --tags=push,google-spreadsheet,spreadsheet,push-to-google-spreadsheet [--input_flags]`
+`cm run script --tags=push,google-spreadsheet,spreadsheet,push-to-google-spreadsheet [--input_flags]`
-2. `cmr "push google-spreadsheet spreadsheet push-to-google-spreadsheet" [--input_flags]`
+*or*
+
+`cmr "push google-spreadsheet spreadsheet push-to-google-spreadsheet"`
+
+`cmr "push google-spreadsheet spreadsheet push-to-google-spreadsheet " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -122,12 +117,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/push-csv-to-spreadsheet/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/push-csv-to-spreadsheet/_cm.json)***
* get,python3
* CM names: `--adr.['python3', 'python']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
@@ -135,23 +128,17 @@ ___
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
* get,generic-python-lib,_google-auth-oauthlib
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/push-csv-to-spreadsheet/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/push-csv-to-spreadsheet/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/push-csv-to-spreadsheet/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/push-csv-to-spreadsheet/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/push-csv-to-spreadsheet/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/push-csv-to-spreadsheet/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/push-csv-to-spreadsheet/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/push-csv-to-spreadsheet/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/push-csv-to-spreadsheet/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/push-csv-to-spreadsheet/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/push-csv-to-spreadsheet/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/push-csv-to-spreadsheet/_cm.json)
___
### Script output
-`cmr "push google-spreadsheet spreadsheet push-to-google-spreadsheet" [--input_flags] -j`
+`cmr "push google-spreadsheet spreadsheet push-to-google-spreadsheet " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/push-mlperf-inference-results-to-github/README.md b/cm-mlops/script/push-mlperf-inference-results-to-github/README.md
index eae46efd38..a7b565db92 100644
--- a/cm-mlops/script/push-mlperf-inference-results-to-github/README.md
+++ b/cm-mlops/script/push-mlperf-inference-results-to-github/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **push-mlperf-inference-results-to-github**
-
+Category: **MLPerf benchmark support**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=push-mlperf-inference-results-to-github,36c2ffd5df5d453a) ]*
+
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/push-mlperf-inference-results-to-github)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/push-mlperf-inference-results-to-github)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *push,mlperf,mlperf-inference-results,publish-results,inference,submission,github*
+* All CM tags to find and reuse this script (see in above meta description): *push,mlperf,mlperf-inference-results,publish-results,inference,submission,github*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "push mlperf mlperf-inference-results publish-results inference submission github" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=push,mlperf,mlperf-inference-results,publish-results,inference,submission,github`
-1. `cm run script --tags=push,mlperf,mlperf-inference-results,publish-results,inference,submission,github [--input_flags]`
+`cm run script --tags=push,mlperf,mlperf-inference-results,publish-results,inference,submission,github [--input_flags]`
-2. `cmr "push mlperf mlperf-inference-results publish-results inference submission github" [--input_flags]`
+*or*
+
+`cmr "push mlperf mlperf-inference-results publish-results inference submission github"`
+
+`cmr "push mlperf mlperf-inference-results publish-results inference submission github " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -124,12 +119,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/push-mlperf-inference-results-to-github/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/push-mlperf-inference-results-to-github/_cm.json)***
* get,python3
* CM names: `--adr.['python3', 'python']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
@@ -139,26 +132,20 @@ ___
* `if (CM_MLPERF_INFERENCE_SUBMISSION_DIR != on)`
* CM names: `--adr.['get-mlperf-submission-dir']...`
- CM script: [get-mlperf-inference-submission-dir](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-submission-dir)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/push-mlperf-inference-results-to-github/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/push-mlperf-inference-results-to-github/_cm.json)***
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/push-mlperf-inference-results-to-github/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/push-mlperf-inference-results-to-github/_cm.json)***
* get,git,repo
* CM names: `--adr.['get-git-repo']...`
- CM script: [get-git-repo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/push-mlperf-inference-results-to-github/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/push-mlperf-inference-results-to-github/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/push-mlperf-inference-results-to-github/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/push-mlperf-inference-results-to-github/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/push-mlperf-inference-results-to-github/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/push-mlperf-inference-results-to-github/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/push-mlperf-inference-results-to-github/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/push-mlperf-inference-results-to-github/_cm.json)
___
### Script output
-`cmr "push mlperf mlperf-inference-results publish-results inference submission github" [--input_flags] -j`
+`cmr "push mlperf mlperf-inference-results publish-results inference submission github " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/remote-run-commands/README.md b/cm-mlops/script/remote-run-commands/README.md
index d6b80d6237..95bd9c4e04 100644
--- a/cm-mlops/script/remote-run-commands/README.md
+++ b/cm-mlops/script/remote-run-commands/README.md
@@ -1,61 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **remote-run-commands**
-*Note that this README is automatically generated - don't edit!*
+Category: **Remote automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=remote-run-commands,b71e24b03c9d49cd) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Remote automation.*
-* 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/remote-run-commands)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/remote-run-commands)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *remote,run,cmds,remote-run,remote-run-cmds,ssh-run,ssh*
+* All CM tags to find and reuse this script (see in above meta description): *remote,run,cmds,remote-run,remote-run-cmds,ssh-run,ssh*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "remote run cmds remote-run remote-run-cmds ssh-run ssh" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=remote,run,cmds,remote-run,remote-run-cmds,ssh-run,ssh`
-1. `cm run script --tags=remote,run,cmds,remote-run,remote-run-cmds,ssh-run,ssh [--input_flags]`
+`cm run script --tags=remote,run,cmds,remote-run,remote-run-cmds,ssh-run,ssh [--input_flags]`
-2. `cmr "remote run cmds remote-run remote-run-cmds ssh-run ssh" [--input_flags]`
+*or*
+
+`cmr "remote run cmds remote-run remote-run-cmds ssh-run ssh"`
+
+`cmr "remote run cmds remote-run remote-run-cmds ssh-run ssh " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -134,30 +126,22 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/remote-run-commands/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/remote-run-commands/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/remote-run-commands/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/remote-run-commands/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/remote-run-commands/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/remote-run-commands/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/remote-run-commands/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/remote-run-commands/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/remote-run-commands/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/remote-run-commands/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/remote-run-commands/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/remote-run-commands/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/remote-run-commands/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/remote-run-commands/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/remote-run-commands/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/remote-run-commands/_cm.json)
___
### Script output
-`cmr "remote run cmds remote-run remote-run-cmds ssh-run ssh" [--input_flags] -j`
+`cmr "remote run cmds remote-run remote-run-cmds ssh-run ssh " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/reproduce-ipol-paper-2022-439/README.md b/cm-mlops/script/reproduce-ipol-paper-2022-439/README.md
index e8e0877aca..ab93456d97 100644
--- a/cm-mlops/script/reproduce-ipol-paper-2022-439/README.md
+++ b/cm-mlops/script/reproduce-ipol-paper-2022-439/README.md
@@ -1,61 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **reproduce-ipol-paper-2022-439**
-*Note that this README is automatically generated - don't edit!*
+Category: **Reproducibility and artifact evaluation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=reproduce-ipol-paper-2022-439,f9b9e5bd65e34e4f) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Reproducibility and artifact evaluation.*
-* 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/reproduce-ipol-paper-2022-439)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-ipol-paper-2022-439)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *app,python,reproduce,project,paper,ipol,journal,repro,reproducibility,pytorch,2022-439*
+* All CM tags to find and reuse this script (see in above meta description): *app,python,reproduce,project,paper,ipol,journal,repro,reproducibility,pytorch,2022-439*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "app python reproduce project paper ipol journal repro reproducibility pytorch 2022-439" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=app,python,reproduce,project,paper,ipol,journal,repro,reproducibility,pytorch,2022-439`
-1. `cm run script --tags=app,python,reproduce,project,paper,ipol,journal,repro,reproducibility,pytorch,2022-439 [--input_flags]`
+`cm run script --tags=app,python,reproduce,project,paper,ipol,journal,repro,reproducibility,pytorch,2022-439 [--input_flags]`
-2. `cmr "app python reproduce project paper ipol journal repro reproducibility pytorch 2022-439" [--input_flags]`
+*or*
+
+`cmr "app python reproduce project paper ipol journal repro reproducibility pytorch 2022-439"`
+
+`cmr "app python reproduce project paper ipol journal repro reproducibility pytorch 2022-439 " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -123,12 +115,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-ipol-paper-2022-439/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-ipol-paper-2022-439/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,python3
@@ -143,24 +133,18 @@ ___
* get,generic-python-lib,_torchvision
* CM names: `--adr.['torchvision']...`
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-ipol-paper-2022-439/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-ipol-paper-2022-439/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-ipol-paper-2022-439/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-ipol-paper-2022-439/_cm.yaml)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-ipol-paper-2022-439/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-ipol-paper-2022-439/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-ipol-paper-2022-439/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-ipol-paper-2022-439/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-ipol-paper-2022-439/_cm.yaml)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-ipol-paper-2022-439/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-ipol-paper-2022-439/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-ipol-paper-2022-439/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-ipol-paper-2022-439/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-ipol-paper-2022-439/_cm.yaml)
___
### Script output
-`cmr "app python reproduce project paper ipol journal repro reproducibility pytorch 2022-439" [--input_flags] -j`
+`cmr "app python reproduce project paper ipol journal repro reproducibility pytorch 2022-439 " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results/README.md b/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results/README.md
index dc502913e5..cafdc5affe 100644
--- a/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results/README.md
+++ b/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results/README.md
@@ -1,65 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ 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)
-
-
+Automatically generated README for this automation recipe: **reproduce-mlperf-octoml-tinyml-results**
-*Note that this README is automatically generated - don't edit!*
+Category: **Reproduce MLPerf benchmarks**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=reproduce-mlperf-octoml-tinyml-results,a63803a707d04332) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Reproduce MLPerf benchmarks.*
-* 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/reproduce-mlperf-octoml-tinyml-results)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *reproduce,tiny,results,mlperf,octoml,mlcommons*
+* All CM tags to find and reuse this script (see in above meta description): *reproduce,tiny,results,mlperf,octoml,mlcommons*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "reproduce tiny results mlperf octoml mlcommons" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=reproduce,tiny,results,mlperf,octoml,mlcommons`
-1. `cm run script --tags=reproduce,tiny,results,mlperf,octoml,mlcommons[,variations] [--input_flags]`
+`cm run script --tags=reproduce,tiny,results,mlperf,octoml,mlcommons[,variations] [--input_flags]`
-2. `cmr "reproduce tiny results mlperf octoml mlcommons[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "reproduce tiny results mlperf octoml mlcommons"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "reproduce tiny results mlperf octoml mlcommons [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -95,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=reproduce,tiny,results
#### Run this script via Docker (beta)
-`cm docker script "reproduce tiny results mlperf octoml mlcommons[ variations]" [--input_flags]`
+`cm docker script "reproduce tiny results mlperf octoml mlcommons[variations]" [--input_flags]`
___
### Customization
@@ -173,12 +163,10 @@ Default version: `r1.0`
* `r1.0`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -205,28 +193,23 @@ ___
- CM script: [get-cmake](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmake)
* get,gcc
- CM script: [get-gcc](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-gcc)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results/_cm.json)***
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results/_cm.json)***
* flash,tiny,mlperf
* `if (CM_FLASH_BOARD == True)`
- CM script: [flash-tinyml-binary](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/flash-tinyml-binary)
-
___
### Script output
-`cmr "reproduce tiny results mlperf octoml mlcommons[,variations]" [--input_flags] -j`
+`cmr "reproduce tiny results mlperf octoml mlcommons [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_TINY_*`
#### New environment keys auto-detected from customize
-* `CM_TINY_MODEL`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_TINY_MODEL`
\ No newline at end of file
diff --git a/cm-mlops/script/reproduce-mlperf-training-nvidia/README.md b/cm-mlops/script/reproduce-mlperf-training-nvidia/README.md
index 60c5e7d70f..0364e7f6b5 100644
--- a/cm-mlops/script/reproduce-mlperf-training-nvidia/README.md
+++ b/cm-mlops/script/reproduce-mlperf-training-nvidia/README.md
@@ -1,62 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ 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)
+Automatically generated README for this automation recipe: **reproduce-mlperf-training-nvidia**
-
+Category: **Reproduce MLPerf benchmarks**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=reproduce-mlperf-training-nvidia,f183628f292341e2) ]*
+
+---
#### Summary
-* Category: *Reproduce MLPerf benchmarks.*
-* 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/reproduce-mlperf-training-nvidia)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-mlperf-training-nvidia)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *reproduce,mlcommons,mlperf,train,training,nvidia-training,nvidia*
+* All CM tags to find and reuse this script (see in above meta description): *reproduce,mlcommons,mlperf,train,training,nvidia-training,nvidia*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "reproduce mlcommons mlperf train training nvidia-training nvidia" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=reproduce,mlcommons,mlperf,train,training,nvidia-training,nvidia`
-1. `cm run script --tags=reproduce,mlcommons,mlperf,train,training,nvidia-training,nvidia[,variations] [--input_flags]`
+`cm run script --tags=reproduce,mlcommons,mlperf,train,training,nvidia-training,nvidia[,variations] [--input_flags]`
-2. `cmr "reproduce mlcommons mlperf train training nvidia-training nvidia[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "reproduce mlcommons mlperf train training nvidia-training nvidia"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "reproduce mlcommons mlperf train training nvidia-training nvidia [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -92,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=reproduce,mlcommons,ml
#### Run this script via Docker (beta)
-`cm docker script "reproduce mlcommons mlperf train training nvidia-training nvidia[ variations]" [--input_flags]`
+`cm docker script "reproduce mlcommons mlperf train training nvidia-training nvidia[variations]" [--input_flags]`
___
### Customization
@@ -148,12 +141,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
* `r2.1`
* `r3.0`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-training-nvidia/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-mlperf-training-nvidia/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -163,24 +154,18 @@ ___
* get,cuda
* CM names: `--adr.['cuda']...`
- CM script: [get-cuda](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-training-nvidia/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-training-nvidia/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-mlperf-training-nvidia/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-mlperf-training-nvidia/_cm.yaml)
1. ***Run native script if exists***
- * [run-resnet.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-training-nvidia/run-resnet.sh)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-training-nvidia/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-training-nvidia/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-training-nvidia/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-training-nvidia/_cm.yaml)
-
+ * [run-resnet.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-mlperf-training-nvidia/run-resnet.sh)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-mlperf-training-nvidia/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-mlperf-training-nvidia/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-mlperf-training-nvidia/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-mlperf-training-nvidia/_cm.yaml)
___
### Script output
-`cmr "reproduce mlcommons mlperf train training nvidia-training nvidia[,variations]" [--input_flags] -j`
+`cmr "reproduce mlcommons mlperf train training nvidia-training nvidia [,variations]" [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/run-docker-container/README.md b/cm-mlops/script/run-docker-container/README.md
index 6adb2dd865..38f09df0c6 100644
--- a/cm-mlops/script/run-docker-container/README.md
+++ b/cm-mlops/script/run-docker-container/README.md
@@ -1,61 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **run-docker-container**
-*Note that this README is automatically generated - don't edit!*
+Category: **Docker automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=run-docker-container,1e0c884107514b46) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Docker automation.*
-* 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/run-docker-container)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-docker-container)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *run,docker,container*
+* All CM tags to find and reuse this script (see in above meta description): *run,docker,container*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "run docker container" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=run,docker,container`
-1. `cm run script --tags=run,docker,container [--input_flags]`
+`cm run script --tags=run,docker,container [--input_flags]`
-2. `cmr "run docker container" [--input_flags]`
+*or*
+
+`cmr "run docker container"`
+
+`cmr "run docker container " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -150,32 +142,24 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-docker-container/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-docker-container/customize.py)***
- 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-docker-container/_cm.json)***
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-docker-container/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-docker-container/customize.py)***
+ 1. ***Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-docker-container/_cm.json)***
* build,docker,image
* `if (CM_DOCKER_IMAGE_EXISTS != yes)`
* CM names: `--adr.['build-docker-image']...`
- CM script: [build-docker-image](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-docker-image)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-docker-container/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-docker-container/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-docker-container/_cm.json)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-docker-container/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-docker-container/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-docker-container/_cm.json)
___
### Script output
-`cmr "run docker container" [--input_flags] -j`
+`cmr "run docker container " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/run-mlperf-inference-app/README.md b/cm-mlops/script/run-mlperf-inference-app/README.md
index 9dd5da4168..0c5d2d83c1 100644
--- a/cm-mlops/script/run-mlperf-inference-app/README.md
+++ b/cm-mlops/script/run-mlperf-inference-app/README.md
@@ -1,67 +1,106 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Input description](#input-description)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ 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)
-
-
+Automatically generated README for this automation recipe: **run-mlperf-inference-app**
-*Note that this README is automatically generated - don't edit!*
+Category: **Modular MLPerf inference benchmark pipeline**
-### About
+License: **Apache 2.0**
+Developers: [Arjun Suresh](https://www.linkedin.com/in/arjunsuresh), [Grigori Fursin](https://cKnowledge.org/gfursin)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=run-mlperf-inference-app,4a5d5b13fd7e4ac8) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Modular MLPerf inference benchmark pipeline.*
-* 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/run-mlperf-inference-app)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-app)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *run-mlperf-inference*
+* All CM tags to find and reuse this script (see in above meta description): *run-mlperf,inference*
* Output cached? *False*
-___
-### 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)
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
-#### Pull CM repository with this automation
-```cm pull repo mlcommons@ck```
+---
+### Reuse this script in your project
+#### Install MLCommons CM automation meta-framework
-#### Run this script from command line
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-1. `cm run script --tags=run-mlperf-inference[,variations] [--input_flags]`
+#### Pull CM repository with this automation recipe (CM script)
-2. `cmr "run-mlperf-inference[ variations]" [--input_flags]`
+```cm pull repo mlcommons@ck```
-* `variations` can be seen [here](#variations)
+#### Print CM help from the command line
+
+````cmr "run-mlperf,inference" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=run-mlperf,inference`
+
+`cm run script --tags=run-mlperf,inference[,variations] [--input_flags]`
+
+*or*
+
+`cmr "run-mlperf,inference"`
+
+`cmr "run-mlperf,inference [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
+
+
+#### Input Flags
+
+* --**division**=MLPerf division {open,closed} (*open*)
+* --**category**=MLPerf category {edge,datacenter,network} (*edge*)
+* --**device**=MLPerf device {cpu,cuda,rocm,qaic} (*cpu*)
+* --**model**=MLPerf model {resnet50,retinanet,bert-99,bert-99.9,3d-unet-99,3d-unet-99.9,rnnt,dlrm-v2-99,dlrm-v2-99.9,gptj-99,gptj-99.9,sdxl,llama2-70b-99,llama2-70b-99.9,mobilenet,efficientnet} (*resnet50*)
+* --**precision**=MLPerf model precision {float32,float16,bfloat16,int8,uint8}
+* --**implementation**=MLPerf implementation {mlcommons-python,mlcommons-cpp,nvidia,intel,qualcomm,ctuning-cpp-tflite} (*mlcommons-python*)
+* --**backend**=MLPerf framework (backend) {onnxruntime,tf,pytorch,deepsparse,tensorrt,glow,tvm-onnx} (*onnxruntime*)
+* --**scenario**=MLPerf scenario {Offline,Server,SingleStream,MultiStream} (*Offline*)
+* --**mode**=MLPerf benchmark mode {,accuracy,performance}
+* --**execution_mode**=MLPerf execution mode {test,fast,valid} (*test*)
+* --**sut**=SUT configuration (if known)
+* --**submitter**=Submitter name (without space) (*CTuning*)
+* --**results_dir**=Folder path to store results (defaults to the current working directory)
+* --**submission_dir**=Folder path to store MLPerf submission tree
+* --**adr.compiler.tags**=Compiler for loadgen and any C/C++ part of implementation
+* --**adr.inference-src-loadgen.env.CM_GIT_URL**=Git URL for MLPerf inference sources to build LoadGen (to enable non-reference implementations)
+* --**adr.inference-src.env.CM_GIT_URL**=Git URL for MLPerf inference sources to run benchmarks (to enable non-reference implementations)
+* --**adr.mlperf-inference-implementation.max_batchsize**=Maximum batchsize to be used
+* --**adr.mlperf-inference-implementation.num_threads**=Number of threads (reference & C++ implementation only)
+* --**adr.python.name**=Python virtual environment name (optional)
+* --**adr.python.version**=Force Python version (must have all system deps)
+* --**adr.python.version_min**=Minimal Python version (*3.8*)
+* --**power**=Measure power {yes,no} (*no*)
+* --**adr.mlperf-power-client.power_server**=MLPerf Power server IP address (*192.168.0.15*)
+* --**adr.mlperf-power-client.port**=MLPerf Power server port (*4950*)
+* --**clean**=Clean run (*False*)
+* --**compliance**=Whether to run compliance tests (applicable only for closed division) {yes,no} (*no*)
+* --**dashboard_wb_project**=W&B dashboard project (*cm-mlperf-dse-testing*)
+* --**dashboard_wb_user**=W&B dashboard user (*cmind*)
+* --**hw_name**=MLPerf hardware name (for example "gcp.c3_standard_8", "nvidia_orin", "lenovo_p14s_gen_4_windows_11", "macbook_pro_m1_2", "thundercomm_rb6" ...)
+* --**multistream_target_latency**=Set MultiStream target latency
+* --**offline_target_qps**=Set LoadGen Offline target QPS
+* --**quiet**=Quiet run (select default values for all questions) (*True*)
+* --**server_target_qps**=Set Server target QPS
+* --**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 (*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*)
+* --**debug**=Debug this script (*False*)
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+**Above CLI flags can be used in the Python CM API as follows:**
+```python
+r=cm.access({... , "division":...}
+```
#### Run this script from Python
@@ -73,7 +112,7 @@ import cmind
r = cmind.access({'action':'run'
'automation':'script',
- 'tags':'run-mlperf-inference'
+ 'tags':'run-mlperf,inference'
'out':'con',
...
(other input keys for this script)
@@ -90,13 +129,13 @@ if r['return']>0:
#### Run this script via GUI
-```cmr "cm gui" --script="run-mlperf-inference"```
+```cmr "cm gui" --script="run-mlperf,inference"```
-Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=run-mlperf-inference) to generate CM CMD.
+Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=run-mlperf,inference) to generate CM CMD.
#### Run this script via Docker (beta)
-`cm docker script "run-mlperf-inference[ variations]" [--input_flags]`
+`cm docker script "run-mlperf,inference[variations]" [--input_flags]`
___
### Customization
@@ -143,7 +182,7 @@ ___
- *CM_MLPERF_INFERENCE_VERSION*: `3.1`
- *CM_RUN_MLPERF_INFERENCE_APP_DEFAULTS*: `r3.1_default`
- Workflow:
- * **`_r4.0`** (default)
+ * `_r4.0`
- Environment variables:
- *CM_MLPERF_INFERENCE_VERSION*: `4.0`
- *CM_RUN_MLPERF_INFERENCE_APP_DEFAULTS*: `r4.0_default`
@@ -230,56 +269,7 @@ ___
#### Default variations
-`_find-performance,_r4.0,_short`
-
-#### Input description
-
-* --**division** MLPerf division {open,closed} (*open*)
-* --**category** MLPerf category {edge,datacenter,network} (*edge*)
-* --**device** MLPerf device {cpu,cuda,rocm,qaic} (*cpu*)
-* --**model** MLPerf model {resnet50,retinanet,bert-99,bert-99.9,3d-unet-99,3d-unet-99.9,rnnt,dlrm-v2-99,dlrm-v2-99.9,gptj-99,gptj-99.9,sdxl,llama2-70b-99,llama2-70b-99.9,mobilenet,efficientnet} (*resnet50*)
-* --**precision** MLPerf model precision {float32,float16,bfloat16,int8,uint8}
-* --**implementation** MLPerf implementation {mlcommons-python,mlcommons-cpp,nvidia,intel,qualcomm,ctuning-cpp-tflite} (*mlcommons-python*)
-* --**backend** MLPerf framework (backend) {onnxruntime,tf,pytorch,deepsparse,tensorrt,glow,tvm-onnx} (*onnxruntime*)
-* --**scenario** MLPerf scenario {Offline,Server,SingleStream,MultiStream} (*Offline*)
-* --**mode** MLPerf benchmark mode {,accuracy,performance}
-* --**execution_mode** MLPerf execution mode {test,fast,valid} (*test*)
-* --**submitter** Submitter name (without space) (*CTuning*)
-* --**results_dir** Folder path to store results (defaults to the current working directory)
-* --**submission_dir** Folder path to store MLPerf submission tree
-* --**adr.compiler.tags** Compiler for loadgen and any C/C++ part of implementation
-* --**adr.inference-src-loadgen.env.CM_GIT_URL** Git URL for MLPerf inference sources to build LoadGen (to enable non-reference implementations)
-* --**adr.inference-src.env.CM_GIT_URL** Git URL for MLPerf inference sources to run benchmarks (to enable non-reference implementations)
-* --**adr.mlperf-inference-implementation.max_batchsize** Maximum batchsize to be used
-* --**adr.mlperf-inference-implementation.num_threads** Number of threads (reference & C++ implementation only)
-* --**adr.python.name** Python virtual environment name (optional)
-* --**adr.python.version** Force Python version (must have all system deps)
-* --**adr.python.version_min** Minimal Python version (*3.8*)
-* --**power** Measure power {yes,no} (*no*)
-* --**adr.mlperf-power-client.power_server** MLPerf Power server IP address (*192.168.0.15*)
-* --**adr.mlperf-power-client.port** MLPerf Power server port (*4950*)
-* --**clean** Clean run (*False*)
-* --**compliance** Whether to run compliance tests (applicable only for closed division) {yes,no} (*no*)
-* --**dashboard_wb_project** W&B dashboard project (*cm-mlperf-dse-testing*)
-* --**dashboard_wb_user** W&B dashboard user (*cmind*)
-* --**hw_name** MLPerf hardware name (for example "gcp.c3_standard_8", "nvidia_orin", "lenovo_p14s_gen_4_windows_11", "macbook_pro_m1_2", "thundercomm_rb6" ...)
-* --**multistream_target_latency** Set MultiStream target latency
-* --**offline_target_qps** Set LoadGen Offline target QPS
-* --**quiet** Quiet run (select default values for all questions) (*True*)
-* --**server_target_qps** Set Server target QPS
-* --**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 (*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*)
-* --**debug** Debug this script (*False*)
-
-**Above CLI flags can be used in the Python CM API as follows:**
-
-```python
-r=cm.access({... , "division":...}
-```
+`_find-performance,_short`
#### Script flags mapped to environment
@@ -334,6 +324,7 @@ r=cm.access({... , "division":...}
* `--skip_truncation=value` → `CM_SKIP_TRUNCATE_ACCURACY=value`
* `--submission_dir=value` → `CM_MLPERF_INFERENCE_SUBMISSION_DIR=value`
* `--submitter=value` → `CM_MLPERF_SUBMITTER=value`
+* `--sut=value` → `CM_MLPERF_INFERENCE_SUT_VARIATION=value`
* `--sut_servers=value` → `CM_NETWORK_LOADGEN_SUT_SERVERS=value`
* `--sw_notes_extra=value` → `CM_MLPERF_SUT_SW_NOTES_EXTRA=value`
* `--system_type=value` → `CM_MLPERF_SUBMISSION_SYSTEM_TYPE=value`
@@ -367,12 +358,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
* `master`
* `r2.1`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-app/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-app/_cm.yaml)***
* detect,os
* `if (CM_MLPERF_USE_DOCKER != True)`
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
@@ -396,22 +385,16 @@ ___
- CM script: [install-pip-package-for-cmind-python](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-pip-package-for-cmind-python)
* get,mlperf,inference,utils
- CM script: [get-mlperf-inference-utils](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-utils)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-app/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-app/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-app/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-app/_cm.yaml)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-app/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-app/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-app/_cm.yaml)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-app/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-app/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-app/_cm.yaml)
___
### Script output
-`cmr "run-mlperf-inference[,variations]" [--input_flags] -j`
+`cmr "run-mlperf,inference [,variations]" [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/run-mlperf-inference-app/_cm.yaml b/cm-mlops/script/run-mlperf-inference-app/_cm.yaml
index df538c9db4..17e689fe30 100644
--- a/cm-mlops/script/run-mlperf-inference-app/_cm.yaml
+++ b/cm-mlops/script/run-mlperf-inference-app/_cm.yaml
@@ -6,6 +6,8 @@ automation_uid: 5b4e0237da074764
category: Modular MLPerf inference benchmark pipeline
+developers: "[Arjun Suresh](https://www.linkedin.com/in/arjunsuresh), [Grigori Fursin](https://cKnowledge.org/gfursin)"
+
gui:
title: CM GUI to run MLPerf inference benchmarks and prepare submissions
diff --git a/cm-mlops/script/run-mlperf-inference-mobilenet-models/README.md b/cm-mlops/script/run-mlperf-inference-mobilenet-models/README.md
index 8a58c213ca..7469465e79 100644
--- a/cm-mlops/script/run-mlperf-inference-mobilenet-models/README.md
+++ b/cm-mlops/script/run-mlperf-inference-mobilenet-models/README.md
@@ -1,30 +1,15 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **run-mlperf-inference-mobilenet-models**
-
+Category: **MLPerf benchmark support**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=run-mlperf-inference-mobilenet-models,f21cc993a8b14a58) ]*
+
+---
## Set up
@@ -134,36 +119,48 @@ cmr "run mobilenet-models _tflite _armnn _opencl _accuracy-only" \
`results_dir` and `submission_dir` can be the same as before as results will be going to different subfolders.
+
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/run-mlperf-inference-mobilenet-models)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-mobilenet-models)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *run,mobilenet,models,image-classification,mobilenet-models,mlperf,inference*
+* All CM tags to find and reuse this script (see in above meta description): *run,mobilenet,models,image-classification,mobilenet-models,mlperf,inference*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "run mobilenet models image-classification mobilenet-models mlperf inference" --help````
-#### Run this script from command line
+#### Customize and run this script from the command line with different variations and flags
-1. `cm run script --tags=run,mobilenet,models,image-classification,mobilenet-models,mlperf,inference[,variations] [--input_flags]`
+`cm run script --tags=run,mobilenet,models,image-classification,mobilenet-models,mlperf,inference`
-2. `cmr "run mobilenet models image-classification mobilenet-models mlperf inference[ variations]" [--input_flags]`
+`cm run script --tags=run,mobilenet,models,image-classification,mobilenet-models,mlperf,inference[,variations] [--input_flags]`
-* `variations` can be seen [here](#variations)
+*or*
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "run mobilenet models image-classification mobilenet-models mlperf inference"`
+
+`cmr "run mobilenet models image-classification mobilenet-models mlperf inference [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -199,7 +196,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=run,mobilenet,models,i
#### Run this script via Docker (beta)
-`cm docker script "run mobilenet models image-classification mobilenet-models mlperf inference[ variations]" [--input_flags]`
+`cm docker script "run mobilenet models image-classification mobilenet-models mlperf inference[variations]" [--input_flags]`
___
### Customization
@@ -366,31 +363,23 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-mobilenet-models/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-mobilenet-models/_cm.json)***
* get,sys-utils-cm
- CM script: [get-sys-utils-cm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-mobilenet-models/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-mobilenet-models/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-mobilenet-models/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-mobilenet-models/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-mobilenet-models/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-mobilenet-models/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-mobilenet-models/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-mobilenet-models/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-mobilenet-models/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-mobilenet-models/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-mobilenet-models/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-mobilenet-models/_cm.json)
___
### Script output
-`cmr "run mobilenet models image-classification mobilenet-models mlperf inference[,variations]" [--input_flags] -j`
+`cmr "run mobilenet models image-classification mobilenet-models mlperf inference [,variations]" [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/run-mlperf-inference-submission-checker/README.md b/cm-mlops/script/run-mlperf-inference-submission-checker/README.md
index 7e97e891c6..aeb69793d7 100644
--- a/cm-mlops/script/run-mlperf-inference-submission-checker/README.md
+++ b/cm-mlops/script/run-mlperf-inference-submission-checker/README.md
@@ -1,65 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ 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)
-
-
+Automatically generated README for this automation recipe: **run-mlperf-inference-submission-checker**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=run-mlperf-inference-submission-checker,15d03ec2c1af4297) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/run-mlperf-inference-submission-checker)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-submission-checker)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *run,mlc,mlcommons,mlperf,inference,mlperf-inference,submission,checker,submission-checker,mlc-submission-checker*
+* All CM tags to find and reuse this script (see in above meta description): *run,mlc,mlcommons,mlperf,inference,mlperf-inference,submission,checker,submission-checker,mlc-submission-checker*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "run mlc mlcommons mlperf inference mlperf-inference submission checker submission-checker mlc-submission-checker" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=run,mlc,mlcommons,mlperf,inference,mlperf-inference,submission,checker,submission-checker,mlc-submission-checker`
-1. `cm run script --tags=run,mlc,mlcommons,mlperf,inference,mlperf-inference,submission,checker,submission-checker,mlc-submission-checker[,variations] [--input_flags]`
+`cm run script --tags=run,mlc,mlcommons,mlperf,inference,mlperf-inference,submission,checker,submission-checker,mlc-submission-checker[,variations] [--input_flags]`
-2. `cmr "run mlc mlcommons mlperf inference mlperf-inference submission checker submission-checker mlc-submission-checker[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "run mlc mlcommons mlperf inference mlperf-inference submission checker submission-checker mlc-submission-checker"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "run mlc mlcommons mlperf inference mlperf-inference submission checker submission-checker mlc-submission-checker [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -95,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=run,mlc,mlcommons,mlpe
#### Run this script via Docker (beta)
-`cm docker script "run mlc mlcommons mlperf inference mlperf-inference submission checker submission-checker mlc-submission-checker[ variations]" [--input_flags]`
+`cm docker script "run mlc mlcommons mlperf inference mlperf-inference submission checker submission-checker mlc-submission-checker[variations]" [--input_flags]`
___
### Customization
@@ -158,12 +148,10 @@ Default version: `master`
* `r3.1`
* `r4.0`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-submission-checker/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-submission-checker/_cm.json)***
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
@@ -182,14 +170,14 @@ ___
* `if (CM_MLPERF_INFERENCE_SUBMISSION_DIR != on)`
* CM names: `--adr.['get-mlperf-submission-dir']...`
- CM script: [get-mlperf-inference-submission-dir](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-submission-dir)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-submission-checker/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-submission-checker/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-submission-checker/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-submission-checker/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-submission-checker/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-submission-checker/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-submission-checker/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-submission-checker/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-submission-checker/_cm.json)***
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-submission-checker/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-submission-checker/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-submission-checker/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-submission-checker/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-submission-checker/_cm.json)***
* publish-results,dashboard
* `if (CM_MLPERF_DASHBOARD == on)`
- CM script: [publish-results-to-dashboard](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/publish-results-to-dashboard)
@@ -200,16 +188,10 @@ ___
* run,tar
* `if (CM_TAR_SUBMISSION_DIR == yes)`
- CM script: [tar-my-folder](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/tar-my-folder)
-
___
### Script output
-`cmr "run mlc mlcommons mlperf inference mlperf-inference submission checker submission-checker mlc-submission-checker[,variations]" [--input_flags] -j`
+`cmr "run mlc mlcommons mlperf inference mlperf-inference submission checker submission-checker mlc-submission-checker [,variations]" [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/run-mlperf-power-client/README.md b/cm-mlops/script/run-mlperf-power-client/README.md
index 421ecac269..f2de841c56 100644
--- a/cm-mlops/script/run-mlperf-power-client/README.md
+++ b/cm-mlops/script/run-mlperf-power-client/README.md
@@ -1,61 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **run-mlperf-power-client**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=run-mlperf-power-client,bf6a6d0cc97b48ae) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/run-mlperf-power-client)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-power-client)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *run,mlc,mlcommons,mlperf,power,client,power-client*
+* All CM tags to find and reuse this script (see in above meta description): *run,mlc,mlcommons,mlperf,power,client,power-client*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "run mlc mlcommons mlperf power client power-client" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=run,mlc,mlcommons,mlperf,power,client,power-client`
-1. `cm run script --tags=run,mlc,mlcommons,mlperf,power,client,power-client [--input_flags]`
+`cm run script --tags=run,mlc,mlcommons,mlperf,power,client,power-client [--input_flags]`
-2. `cmr "run mlc mlcommons mlperf power client power-client" [--input_flags]`
+*or*
+
+`cmr "run mlc mlcommons mlperf power client power-client"`
+
+`cmr "run mlc mlcommons mlperf power client power-client " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -136,12 +128,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-power-client/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-power-client/_cm.json)***
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
@@ -150,23 +140,17 @@ ___
- CM script: [get-mlperf-power-dev](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-power-dev)
* get,generic-sys-util,_ntpdate
- CM script: [get-generic-sys-util](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-sys-util)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-power-client/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-power-client/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-power-client/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-power-client/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-power-client/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-power-client/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-power-client/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-power-client/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-power-client/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-power-client/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-power-client/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-power-client/_cm.json)
___
### Script output
-`cmr "run mlc mlcommons mlperf power client power-client" [--input_flags] -j`
+`cmr "run mlc mlcommons mlperf power client power-client " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/run-mlperf-power-server/README.md b/cm-mlops/script/run-mlperf-power-server/README.md
index bea3cc1387..d4da088627 100644
--- a/cm-mlops/script/run-mlperf-power-server/README.md
+++ b/cm-mlops/script/run-mlperf-power-server/README.md
@@ -1,61 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **run-mlperf-power-server**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=run-mlperf-power-server,5bc68aaf389a40bd) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/run-mlperf-power-server)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-power-server)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *run,mlc,mlcommons,mlperf,power,server,power-server*
+* All CM tags to find and reuse this script (see in above meta description): *run,mlc,mlcommons,mlperf,power,server,power-server*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "run mlc mlcommons mlperf power server power-server" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=run,mlc,mlcommons,mlperf,power,server,power-server`
-1. `cm run script --tags=run,mlc,mlcommons,mlperf,power,server,power-server [--input_flags]`
+`cm run script --tags=run,mlc,mlcommons,mlperf,power,server,power-server [--input_flags]`
-2. `cmr "run mlc mlcommons mlperf power server power-server" [--input_flags]`
+*or*
+
+`cmr "run mlc mlcommons mlperf power server power-server"`
+
+`cmr "run mlc mlcommons mlperf power server power-server " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -133,12 +125,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-power-server/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-power-server/_cm.json)***
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
@@ -158,24 +148,18 @@ ___
* `if (CM_HOST_OS_TYPE in windows)`
* CM names: `--adr.['win32']...`
- CM script: [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-power-server/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-power-server/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-power-server/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-power-server/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-power-server/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-power-server/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-power-server/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-power-server/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-power-server/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-power-server/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-power-server/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-power-server/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-power-server/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-power-server/_cm.json)
___
### Script output
-`cmr "run mlc mlcommons mlperf power server power-server" [--input_flags] -j`
+`cmr "run mlc mlcommons mlperf power server power-server " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/run-mlperf-training-submission-checker/README.md b/cm-mlops/script/run-mlperf-training-submission-checker/README.md
index 5e1f968928..65d7fca513 100644
--- a/cm-mlops/script/run-mlperf-training-submission-checker/README.md
+++ b/cm-mlops/script/run-mlperf-training-submission-checker/README.md
@@ -1,62 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ 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)
+Automatically generated README for this automation recipe: **run-mlperf-training-submission-checker**
-
+Category: **MLPerf benchmark support**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=run-mlperf-training-submission-checker,cb5cb60ac9a74d09) ]*
+
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/run-mlperf-training-submission-checker)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-training-submission-checker)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *run,mlc,mlcommons,mlperf,training,train,mlperf-training,submission,checker,submission-checker,mlc-submission-checker*
+* All CM tags to find and reuse this script (see in above meta description): *run,mlc,mlcommons,mlperf,training,train,mlperf-training,submission,checker,submission-checker,mlc-submission-checker*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "run mlc mlcommons mlperf training train mlperf-training submission checker submission-checker mlc-submission-checker" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=run,mlc,mlcommons,mlperf,training,train,mlperf-training,submission,checker,submission-checker,mlc-submission-checker`
-1. `cm run script --tags=run,mlc,mlcommons,mlperf,training,train,mlperf-training,submission,checker,submission-checker,mlc-submission-checker[,variations] [--input_flags]`
+`cm run script --tags=run,mlc,mlcommons,mlperf,training,train,mlperf-training,submission,checker,submission-checker,mlc-submission-checker[,variations] [--input_flags]`
-2. `cmr "run mlc mlcommons mlperf training train mlperf-training submission checker submission-checker mlc-submission-checker[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "run mlc mlcommons mlperf training train mlperf-training submission checker submission-checker mlc-submission-checker"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "run mlc mlcommons mlperf training train mlperf-training submission checker submission-checker mlc-submission-checker [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -92,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=run,mlc,mlcommons,mlpe
#### Run this script via Docker (beta)
-`cm docker script "run mlc mlcommons mlperf training train mlperf-training submission checker submission-checker mlc-submission-checker[ variations]" [--input_flags]`
+`cm docker script "run mlc mlcommons mlperf training train mlperf-training submission checker submission-checker mlc-submission-checker[variations]" [--input_flags]`
___
### Customization
@@ -153,12 +146,10 @@ Default version: `master`
* `r3.0`
* `r3.1`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-training-submission-checker/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-training-submission-checker/_cm.json)***
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
@@ -167,13 +158,13 @@ ___
- CM script: [get-mlperf-inference-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-src)
* install,mlperf,logging,from.src
- CM script: [install-mlperf-logging-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-mlperf-logging-from-src)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-training-submission-checker/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-training-submission-checker/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-training-submission-checker/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-training-submission-checker/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-training-submission-checker/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-training-submission-checker/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-training-submission-checker/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-training-submission-checker/_cm.json)***
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-training-submission-checker/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-training-submission-checker/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-training-submission-checker/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-training-submission-checker/_cm.json)***
* publish-results,github
* `if (CM_MLPERF_RESULT_PUSH_TO_GITHUB == on)`
* CM names: `--adr.['push-to-github']...`
@@ -181,16 +172,10 @@ ___
* run,tar
* `if (CM_TAR_SUBMISSION_DIR == yes)`
- CM script: [tar-my-folder](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/tar-my-folder)
-
___
### Script output
-`cmr "run mlc mlcommons mlperf training train mlperf-training submission checker submission-checker mlc-submission-checker[,variations]" [--input_flags] -j`
+`cmr "run mlc mlcommons mlperf training train mlperf-training submission checker submission-checker mlc-submission-checker [,variations]" [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/run-python/README.md b/cm-mlops/script/run-python/README.md
index 9011f2f744..54bf6a7446 100644
--- a/cm-mlops/script/run-python/README.md
+++ b/cm-mlops/script/run-python/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **run-python**
-
+Category: **Tests**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=run-python,75a46d84ee6f49b0) ]*
+
+---
#### Summary
-* Category: *Tests.*
-* 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/run-python)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-python)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *run,python*
+* All CM tags to find and reuse this script (see in above meta description): *run,python*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "run python" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=run,python`
-1. `cm run script --tags=run,python [--input_flags]`
+`cm run script --tags=run,python [--input_flags]`
-2. `cmr "run python" [--input_flags]`
+*or*
+
+`cmr "run python"`
+
+`cmr "run python " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -119,35 +114,27 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-python/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-python/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-python/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-python/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-python/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-python/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-python/_cm.json)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-python/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-python/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-python/_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/run-python/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-python/_cm.json)
___
### Script output
-`cmr "run python" [--input_flags] -j`
+`cmr "run python " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/run-terraform/README.md b/cm-mlops/script/run-terraform/README.md
index 44e99b8633..10e880a2db 100644
--- a/cm-mlops/script/run-terraform/README.md
+++ b/cm-mlops/script/run-terraform/README.md
@@ -1,30 +1,15 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **run-terraform**
-
+Category: **Cloud automation**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=run-terraform,ec344bd44af144d7) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+
+---
## Setup for Google Cloud Instances
```
@@ -40,38 +25,47 @@ cm run script --tags=run,terraform,_gcp,_gcp_project.mlperf-inference-tests --cm
Here, `mlperf-inference-tests` is the name of the google project as created in [Google cloud console](https://console.cloud.google.com/apis/dashboard)
-See extra [notes](README-extra.md) from the authors and contributors.
-
+---
#### Summary
-* Category: *Cloud automation.*
-* 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/run-terraform)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-terraform)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *run,terraform*
+* All CM tags to find and reuse this script (see in above meta description): *run,terraform*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "run terraform" --help````
-#### Run this script from command line
+#### Customize and run this script from the command line with different variations and flags
-1. `cm run script --tags=run,terraform[,variations] [--input_flags]`
+`cm run script --tags=run,terraform`
-2. `cmr "run terraform[ variations]" [--input_flags]`
+`cm run script --tags=run,terraform[,variations] [--input_flags]`
-* `variations` can be seen [here](#variations)
+*or*
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "run terraform"`
+
+`cmr "run terraform [variations]" [--input_flags]`
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -107,7 +101,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=run,terraform) to gene
#### Run this script via Docker (beta)
-`cm docker script "run terraform[ variations]" [--input_flags]`
+`cm docker script "run terraform[variations]" [--input_flags]`
___
### Customization
@@ -457,30 +451,27 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-terraform/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-terraform/_cm.json)***
* get,terraform
- CM script: [get-terraform](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-terraform)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-terraform/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-terraform/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-terraform/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-terraform/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-terraform/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-terraform/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-terraform/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-terraform/_cm.json)***
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-terraform/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-terraform/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-terraform/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-terraform/_cm.json)***
* destroy,terraform
* `if (CM_DESTROY_TERRAFORM == on)`
* CM names: `--adr.['destroy-cmd']...`
- CM script: [destroy-terraform](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/destroy-terraform)
-
___
### Script output
-`cmr "run terraform[,variations]" [--input_flags] -j`
+`cmr "run terraform [,variations]" [--input_flags] -j`
#### New environment keys (filter)
* `CM_TERRAFORM_CONFIG_DIR`
@@ -488,8 +479,4 @@ ___
#### New environment keys auto-detected from customize
* `CM_TERRAFORM_CONFIG_DIR`
-* `CM_TERRAFORM_RUN_DIR`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_TERRAFORM_RUN_DIR`
\ No newline at end of file
diff --git a/cm-mlops/script/save-mlperf-inference-implementation-state/README.md b/cm-mlops/script/save-mlperf-inference-implementation-state/README.md
index 011c5ba613..7ce73ffe7c 100644
--- a/cm-mlops/script/save-mlperf-inference-implementation-state/README.md
+++ b/cm-mlops/script/save-mlperf-inference-implementation-state/README.md
@@ -1,54 +1,51 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **save-mlperf-inference-implementation-state**
-
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=save-mlperf-inference-implementation-state,b14b813229c444f8) ]*
+---
#### Summary
-* 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/save-mlperf-inference-implementation-state)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/save-mlperf-inference-implementation-state)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *save,mlperf,inference,implementation,state*
+* All CM tags to find and reuse this script (see in above meta description): *save,mlperf,inference,implementation,state*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "save mlperf inference implementation state" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=save,mlperf,inference,implementation,state`
-#### Run this script from command line
+`cm run script --tags=save,mlperf,inference,implementation,state `
-1. `cm run script --tags=save,mlperf,inference,implementation,state `
+*or*
+
+`cmr "save mlperf inference implementation state"`
+
+`cmr "save mlperf inference implementation state " `
-2. `cmr "save mlperf inference implementation state" `
#### Run this script from Python
@@ -100,28 +97,20 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/save-mlperf-inference-implementation-state/_cm.yaml)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/save-mlperf-inference-implementation-state/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/save-mlperf-inference-implementation-state/_cm.yaml)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/save-mlperf-inference-implementation-state/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/save-mlperf-inference-implementation-state/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/save-mlperf-inference-implementation-state/_cm.yaml)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/save-mlperf-inference-implementation-state/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/save-mlperf-inference-implementation-state/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/save-mlperf-inference-implementation-state/_cm.yaml)
-
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/save-mlperf-inference-implementation-state/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/save-mlperf-inference-implementation-state/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/save-mlperf-inference-implementation-state/_cm.yaml)
___
### Script output
-`cmr "save mlperf inference implementation state" -j`
+`cmr "save mlperf inference implementation state " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/set-device-settings-qaic/README.md b/cm-mlops/script/set-device-settings-qaic/README.md
index f1f020216d..896b147c93 100644
--- a/cm-mlops/script/set-device-settings-qaic/README.md
+++ b/cm-mlops/script/set-device-settings-qaic/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **set-device-settings-qaic**
-
+Category: **DevOps automation**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=set-device-settings-qaic,408a1a1563b44780) ]*
+---
#### Summary
-* Category: *DevOps automation.*
-* 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/set-device-settings-qaic)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-device-settings-qaic)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *set,device,qaic,ai100,cloud,performance,power,setting,mode,vc,ecc*
+* All CM tags to find and reuse this script (see in above meta description): *set,device,qaic,ai100,cloud,performance,power,setting,mode,vc,ecc*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "set device qaic ai100 cloud performance power setting mode vc ecc" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=set,device,qaic,ai100,cloud,performance,power,setting,mode,vc,ecc`
-#### Run this script from command line
+`cm run script --tags=set,device,qaic,ai100,cloud,performance,power,setting,mode,vc,ecc[,variations] `
-1. `cm run script --tags=set,device,qaic,ai100,cloud,performance,power,setting,mode,vc,ecc[,variations] `
+*or*
-2. `cmr "set device qaic ai100 cloud performance power setting mode vc ecc[ variations]" `
+`cmr "set device qaic ai100 cloud performance power setting mode vc ecc"`
-* `variations` can be seen [here](#variations)
+`cmr "set device qaic ai100 cloud performance power setting mode vc ecc [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=set,device,qaic,ai100,
#### Run this script via Docker (beta)
-`cm docker script "set device qaic ai100 cloud performance power setting mode vc ecc[ variations]" `
+`cm docker script "set device qaic ai100 cloud performance power setting mode vc ecc[variations]" `
___
### Customization
@@ -123,34 +120,26 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-device-settings-qaic/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-device-settings-qaic/_cm.json)***
* detect-os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,qaic,platform,sdk
- CM script: [get-qaic-platform-sdk](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-platform-sdk)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-device-settings-qaic/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-device-settings-qaic/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-device-settings-qaic/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-device-settings-qaic/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-device-settings-qaic/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-device-settings-qaic/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-device-settings-qaic/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-device-settings-qaic/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-device-settings-qaic/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-device-settings-qaic/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-device-settings-qaic/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-device-settings-qaic/_cm.json)
___
### Script output
-`cmr "set device qaic ai100 cloud performance power setting mode vc ecc[,variations]" -j`
+`cmr "set device qaic ai100 cloud performance power setting mode vc ecc [,variations]" -j`
#### New environment keys (filter)
* `CM_QAIC_DEVICE_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/set-echo-off-win/README.md b/cm-mlops/script/set-echo-off-win/README.md
index 8465a74fea..8dd46f53e2 100644
--- a/cm-mlops/script/set-echo-off-win/README.md
+++ b/cm-mlops/script/set-echo-off-win/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **set-echo-off-win**
-
+Category: **DevOps automation**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=set-echo-off-win,49d94b57524f4fcf) ]*
+---
#### Summary
-* Category: *DevOps automation.*
-* 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/set-echo-off-win)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-echo-off-win)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *set,echo,off,win,echo-off-win,echo-off*
+* All CM tags to find and reuse this script (see in above meta description): *set,echo,off,win,echo-off-win,echo-off*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "set echo off win echo-off-win echo-off" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=set,echo,off,win,echo-off-win,echo-off`
-#### Run this script from command line
+`cm run script --tags=set,echo,off,win,echo-off-win,echo-off `
-1. `cm run script --tags=set,echo,off,win,echo-off-win,echo-off `
+*or*
+
+`cmr "set echo off win echo-off-win echo-off"`
+
+`cmr "set echo off win echo-off-win echo-off " `
-2. `cmr "set echo off win echo-off-win echo-off" `
#### Run this script from Python
@@ -101,28 +99,20 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-echo-off-win/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-echo-off-win/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-echo-off-win/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-echo-off-win/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-echo-off-win/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-echo-off-win/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-echo-off-win/_cm.json)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-echo-off-win/_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/set-echo-off-win/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-echo-off-win/_cm.json)
___
### Script output
-`cmr "set echo off win echo-off-win echo-off" -j`
+`cmr "set echo off win echo-off-win echo-off " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/set-performance-mode/README.md b/cm-mlops/script/set-performance-mode/README.md
index edbb1e4cd4..f4a36920a6 100644
--- a/cm-mlops/script/set-performance-mode/README.md
+++ b/cm-mlops/script/set-performance-mode/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **set-performance-mode**
-
+Category: **DevOps automation**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=set-performance-mode,2c0ab7b64692443d) ]*
+---
#### Summary
-* Category: *DevOps automation.*
-* 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/set-performance-mode)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-performance-mode)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *set,system,performance,power,mode*
+* All CM tags to find and reuse this script (see in above meta description): *set,system,performance,power,mode*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "set system performance power mode" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=set,system,performance,power,mode`
-#### Run this script from command line
+`cm run script --tags=set,system,performance,power,mode[,variations] `
-1. `cm run script --tags=set,system,performance,power,mode[,variations] `
+*or*
-2. `cmr "set system performance power mode[ variations]" `
+`cmr "set system performance power mode"`
-* `variations` can be seen [here](#variations)
+`cmr "set system performance power mode [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=set,system,performance
#### Run this script via Docker (beta)
-`cm docker script "set system performance power mode[ variations]" `
+`cm docker script "set system performance power mode[variations]" `
___
### Customization
@@ -158,36 +155,28 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-performance-mode/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-performance-mode/_cm.json)***
* detect-os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect-cpu
- CM script: [detect-cpu](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-performance-mode/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-performance-mode/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-performance-mode/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-performance-mode/_cm.json)
1. ***Run native script if exists***
- * [run-ubuntu.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-performance-mode/run-ubuntu.sh)
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-performance-mode/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-performance-mode/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-performance-mode/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-performance-mode/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-performance-mode/_cm.json)
-
+ * [run-ubuntu.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-performance-mode/run-ubuntu.sh)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-performance-mode/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-performance-mode/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-performance-mode/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-performance-mode/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-performance-mode/_cm.json)
___
### Script output
-`cmr "set system performance power mode[,variations]" -j`
+`cmr "set system performance power mode [,variations]" -j`
#### New environment keys (filter)
* `OMP_*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/set-sqlite-dir/README.md b/cm-mlops/script/set-sqlite-dir/README.md
index 6fd376523d..547125bb8b 100644
--- a/cm-mlops/script/set-sqlite-dir/README.md
+++ b/cm-mlops/script/set-sqlite-dir/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **set-sqlite-dir**
-
+Category: **DevOps automation**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=set-sqlite-dir,05904966355a43ac) ]*
+
+---
#### Summary
-* Category: *DevOps automation.*
-* 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/set-sqlite-dir)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-sqlite-dir)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *set,sqlite,dir,sqlite-dir*
+* All CM tags to find and reuse this script (see in above meta description): *set,sqlite,dir,sqlite-dir*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "set sqlite dir sqlite-dir" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=set,sqlite,dir,sqlite-dir`
-1. `cm run script --tags=set,sqlite,dir,sqlite-dir [--input_flags]`
+`cm run script --tags=set,sqlite,dir,sqlite-dir [--input_flags]`
-2. `cmr "set sqlite dir sqlite-dir" [--input_flags]`
+*or*
+
+`cmr "set sqlite dir sqlite-dir"`
+
+`cmr "set sqlite dir sqlite-dir " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -119,37 +114,30 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-sqlite-dir/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-sqlite-dir/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-sqlite-dir/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-sqlite-dir/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-sqlite-dir/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-sqlite-dir/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-sqlite-dir/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-sqlite-dir/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-sqlite-dir/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-sqlite-dir/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-sqlite-dir/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-sqlite-dir/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-sqlite-dir/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-sqlite-dir/_cm.json)
___
### Script output
-`cmr "set sqlite dir sqlite-dir" [--input_flags] -j`
+`cmr "set sqlite dir sqlite-dir " [--input_flags] -j`
#### New environment keys (filter)
* `CM_SQLITE_PATH`
#### New environment keys auto-detected from customize
-* `CM_SQLITE_PATH`
-___
-### Maintainers
-
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
\ No newline at end of file
+* `CM_SQLITE_PATH`
\ No newline at end of file
diff --git a/cm-mlops/script/tar-my-folder/README.md b/cm-mlops/script/tar-my-folder/README.md
index 2f71f4a7af..b54099b916 100644
--- a/cm-mlops/script/tar-my-folder/README.md
+++ b/cm-mlops/script/tar-my-folder/README.md
@@ -1,61 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **tar-my-folder**
-*Note that this README is automatically generated - don't edit!*
+Category: **DevOps automation**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=tar-my-folder,3784212e986c456b) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *DevOps automation.*
-* 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/tar-my-folder)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/tar-my-folder)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *run,tar*
+* All CM tags to find and reuse this script (see in above meta description): *run,tar*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "run tar" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=run,tar`
-1. `cm run script --tags=run,tar [--input_flags]`
+`cm run script --tags=run,tar [--input_flags]`
-2. `cmr "run tar" [--input_flags]`
+*or*
+
+`cmr "run tar"`
+
+`cmr "run tar " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -124,28 +116,20 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/tar-my-folder/_cm.json)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/tar-my-folder/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/tar-my-folder/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/tar-my-folder/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/tar-my-folder/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/tar-my-folder/_cm.json)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/tar-my-folder/_cm.json)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/tar-my-folder/_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/tar-my-folder/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/tar-my-folder/_cm.json)
___
### Script output
-`cmr "run tar" [--input_flags] -j`
+`cmr "run tar " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/test-abtf-ssd-pytorch/README.md b/cm-mlops/script/test-abtf-ssd-pytorch/README.md
index 9e978bb97e..cadb4c229a 100644
--- a/cm-mlops/script/test-abtf-ssd-pytorch/README.md
+++ b/cm-mlops/script/test-abtf-ssd-pytorch/README.md
@@ -1,63 +1,68 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Input description](#input-description)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **test-abtf-ssd-pytorch**
-
+Category: **Tests**
-*Note that this README is automatically generated - don't edit!*
+License: **Apache 2.0**
-### About
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=test-abtf-ssd-pytorch,91bfc4333b054c21) ]*
+
+---
#### Summary
-* Category: *Tests.*
-* 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/test-abtf-ssd-pytorch)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-abtf-ssd-pytorch)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *test,abtf,ssd,pytorch,ssd-pytorch*
+* All CM tags to find and reuse this script (see in above meta description): *test,abtf,ssd,pytorch,ssd-pytorch*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "test abtf ssd pytorch ssd-pytorch" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=test,abtf,ssd,pytorch,ssd-pytorch`
-1. `cm run script --tags=test,abtf,ssd,pytorch,ssd-pytorch[,variations] [--input_flags]`
+`cm run script --tags=test,abtf,ssd,pytorch,ssd-pytorch[,variations] [--input_flags]`
-2. `cmr "test abtf ssd pytorch ssd-pytorch[ variations]" [--input_flags]`
+*or*
-* `variations` can be seen [here](#variations)
+`cmr "test abtf ssd pytorch ssd-pytorch"`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
+`cmr "test abtf ssd pytorch ssd-pytorch [variations]" [--input_flags]`
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
+
+
+#### Input Flags
+
+* --**input**=input image (png)
+* --**output**=output image (png)
+* --**export_model**=ONNX model name to be exported from PyTorch
+
+**Above CLI flags can be used in the Python CM API as follows:**
+
+```python
+r=cm.access({... , "input":...}
+```
#### Run this script from Python
@@ -92,7 +97,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=test,abtf,ssd,pytorch,
#### Run this script via Docker (beta)
-`cm docker script "test abtf ssd pytorch ssd-pytorch[ variations]" [--input_flags]`
+`cm docker script "test abtf ssd pytorch ssd-pytorch[variations]" [--input_flags]`
___
### Customization
@@ -139,18 +144,6 @@ ___
`_coco,_cpu`
-#### Input description
-
-* --**input** input image (png)
-* --**output** output image (png)
-* --**export_model** ONNX model name to be exported from PyTorch
-
-**Above CLI flags can be used in the Python CM API as follows:**
-
-```python
-r=cm.access({... , "input":...}
-```
-
#### Script flags mapped to environment
Click here to expand this section.
@@ -178,12 +171,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-abtf-ssd-pytorch/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-abtf-ssd-pytorch/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,python3
@@ -208,26 +199,20 @@ ___
* get,git,repo,_repo.https://github.com/mlcommons/abtf-ssd-pytorch
* CM names: `--adr.['abtf-ssd-pytorch-git-repo']...`
- 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/test-abtf-ssd-pytorch/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-abtf-ssd-pytorch/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-abtf-ssd-pytorch/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-abtf-ssd-pytorch/_cm.yaml)
1. ***Run native script if exists***
- * [run-coco.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-abtf-ssd-pytorch/run-coco.bat)
- * [run-coco.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-abtf-ssd-pytorch/run-coco.sh)
- * [run-cognata.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-abtf-ssd-pytorch/run-cognata.bat)
- * [run-cognata.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-abtf-ssd-pytorch/run-cognata.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-abtf-ssd-pytorch/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-abtf-ssd-pytorch/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-abtf-ssd-pytorch/_cm.yaml)
-
+ * [run-coco.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-abtf-ssd-pytorch/run-coco.bat)
+ * [run-coco.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-abtf-ssd-pytorch/run-coco.sh)
+ * [run-cognata.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-abtf-ssd-pytorch/run-cognata.bat)
+ * [run-cognata.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-abtf-ssd-pytorch/run-cognata.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-abtf-ssd-pytorch/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-abtf-ssd-pytorch/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-abtf-ssd-pytorch/_cm.yaml)
___
### Script output
-`cmr "test abtf ssd pytorch ssd-pytorch[,variations]" [--input_flags] -j`
+`cmr "test abtf ssd pytorch ssd-pytorch [,variations]" [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/test-download-and-extract-artifacts/README.md b/cm-mlops/script/test-download-and-extract-artifacts/README.md
index 7cda28f395..385a728f27 100644
--- a/cm-mlops/script/test-download-and-extract-artifacts/README.md
+++ b/cm-mlops/script/test-download-and-extract-artifacts/README.md
@@ -1,58 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
-
-
+Automatically generated README for this automation recipe: **test-download-and-extract-artifacts**
-*Note that this README is automatically generated - don't edit!*
+Category: **Tests**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=test-download-and-extract-artifacts,51dde7580b404b27) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Tests.*
-* 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/test-download-and-extract-artifacts)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-download-and-extract-artifacts)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *test,download-and-extract-artifacts*
+* All CM tags to find and reuse this script (see in above meta description): *test,download-and-extract-artifacts*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "test download-and-extract-artifacts" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=test,download-and-extract-artifacts`
-#### Run this script from command line
+`cm run script --tags=test,download-and-extract-artifacts `
-1. `cm run script --tags=test,download-and-extract-artifacts `
+*or*
+
+`cmr "test download-and-extract-artifacts"`
+
+`cmr "test download-and-extract-artifacts " `
-2. `cmr "test download-and-extract-artifacts" `
#### Run this script from Python
@@ -104,35 +99,27 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-download-and-extract-artifacts/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-download-and-extract-artifacts/_cm.yaml)***
* download,file,_url.https://zenodo.org/record/4735647/files/resnet50_v1.onnx
- CM script: [download-file](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-file)
* download-and-extract,_extract,_url.https://zenodo.org/record/5597155/files/3dunet_kits19_128x128x128.tf.zip?download=1
- CM script: [download-and-extract](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-and-extract)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-download-and-extract-artifacts/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-download-and-extract-artifacts/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-download-and-extract-artifacts/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-download-and-extract-artifacts/_cm.yaml)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-download-and-extract-artifacts/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-download-and-extract-artifacts/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-download-and-extract-artifacts/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-download-and-extract-artifacts/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-download-and-extract-artifacts/_cm.yaml)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-download-and-extract-artifacts/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-download-and-extract-artifacts/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-download-and-extract-artifacts/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-download-and-extract-artifacts/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-download-and-extract-artifacts/_cm.yaml)
___
### Script output
-`cmr "test download-and-extract-artifacts" -j`
+`cmr "test download-and-extract-artifacts " -j`
#### New environment keys (filter)
* `CM_REPRODUCE_PAPER_XYZ*`
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/test-mlperf-inference-retinanet/README.md b/cm-mlops/script/test-mlperf-inference-retinanet/README.md
index 393849ea98..5e5e22731c 100644
--- a/cm-mlops/script/test-mlperf-inference-retinanet/README.md
+++ b/cm-mlops/script/test-mlperf-inference-retinanet/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **test-mlperf-inference-retinanet**
-
+Category: **CM interface prototyping**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=test-mlperf-inference-retinanet,1cedbc3b642a403a) ]*
+---
#### Summary
-* Category: *CM interface prototyping.*
-* 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/test-mlperf-inference-retinanet)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-mlperf-inference-retinanet)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *test,mlperf-inference-win,retinanet,windows*
+* All CM tags to find and reuse this script (see in above meta description): *test,mlperf-inference-win,retinanet,windows*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "test mlperf-inference-win retinanet windows" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=test,mlperf-inference-win,retinanet,windows`
-#### Run this script from command line
+`cm run script --tags=test,mlperf-inference-win,retinanet,windows `
-1. `cm run script --tags=test,mlperf-inference-win,retinanet,windows `
+*or*
+
+`cmr "test mlperf-inference-win retinanet windows"`
+
+`cmr "test mlperf-inference-win retinanet windows " `
-2. `cmr "test mlperf-inference-win retinanet windows" `
#### Run this script from Python
@@ -101,12 +99,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-mlperf-inference-retinanet/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-mlperf-inference-retinanet/_cm.json)***
* get,sys-utils-cm
- CM script: [get-sys-utils-cm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm)
* get,python3
@@ -124,24 +120,18 @@ ___
- CM script: [get-dataset-openimages](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages)
* get,raw,ml-model,retinanet
- CM script: [get-ml-model-retinanet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-retinanet)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-mlperf-inference-retinanet/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-mlperf-inference-retinanet/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-mlperf-inference-retinanet/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-mlperf-inference-retinanet/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-mlperf-inference-retinanet/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-mlperf-inference-retinanet/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-mlperf-inference-retinanet/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-mlperf-inference-retinanet/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-mlperf-inference-retinanet/_cm.json)
-
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-mlperf-inference-retinanet/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-mlperf-inference-retinanet/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-mlperf-inference-retinanet/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-mlperf-inference-retinanet/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-mlperf-inference-retinanet/_cm.json)
___
### Script output
-`cmr "test mlperf-inference-win retinanet windows" -j`
+`cmr "test mlperf-inference-win retinanet windows " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/test-onnxruntime-cpp/README.md b/cm-mlops/script/test-onnxruntime-cpp/README.md
index aeaca5754d..493768fb53 100644
--- a/cm-mlops/script/test-onnxruntime-cpp/README.md
+++ b/cm-mlops/script/test-onnxruntime-cpp/README.md
@@ -1,58 +1,55 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Variations](#variations)
- * [ Default environment](#default-environment)
-* [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)
+Automatically generated README for this automation recipe: **test-onnxruntime-cpp**
-
+Category: **Testing libraries and tools**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=test-onnxruntime-cpp,c7cb91ff52fc4798) ]*
+---
#### Summary
-* Category: *Testing libraries and tools.*
-* 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/test-onnxruntime-cpp)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-onnxruntime-cpp)*
* CM meta description for this script: *[_cm.yaml](_cm.yaml)*
-* CM "database" tags to find this script: *test,onnxruntime,cpp*
+* All CM tags to find and reuse this script (see in above meta description): *test,onnxruntime,cpp*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "test onnxruntime cpp" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=test,onnxruntime,cpp`
-#### Run this script from command line
+`cm run script --tags=test,onnxruntime,cpp[,variations] `
-1. `cm run script --tags=test,onnxruntime,cpp[,variations] `
+*or*
-2. `cmr "test onnxruntime cpp[ variations]" `
+`cmr "test onnxruntime cpp"`
-* `variations` can be seen [here](#variations)
+`cmr "test onnxruntime cpp [variations]" `
+
+
+* *See the list of `variations` [here](#variations) and check the [Gettings Started Guide](https://github.com/mlcommons/ck/blob/dev/docs/getting-started.md) for more details.*
#### Run this script from Python
@@ -88,7 +85,7 @@ Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=test,onnxruntime,cpp)
#### Run this script via Docker (beta)
-`cm docker script "test onnxruntime cpp[ variations]" `
+`cm docker script "test onnxruntime cpp[variations]" `
___
### Customization
@@ -150,12 +147,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-onnxruntime-cpp/_cm.yaml)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-onnxruntime-cpp/_cm.yaml)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* detect,cpu
@@ -175,12 +170,12 @@ ___
* get,ml-model,raw,resnet50,_onnx
* `if (CM_MODEL == resnet50)`
- CM script: [get-ml-model-resnet50](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-resnet50)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-onnxruntime-cpp/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-onnxruntime-cpp/_cm.yaml)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-onnxruntime-cpp/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-onnxruntime-cpp/_cm.yaml)
1. ***Run native script if exists***
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-onnxruntime-cpp/_cm.yaml)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-onnxruntime-cpp/customize.py)***
- 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-onnxruntime-cpp/_cm.yaml)***
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-onnxruntime-cpp/_cm.yaml)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-onnxruntime-cpp/customize.py)***
+ 1. ***Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-onnxruntime-cpp/_cm.yaml)***
* compile,cpp-program
* `if (CM_SKIP_COMPILE != True)`
* CM names: `--adr.['compile-program']...`
@@ -189,16 +184,10 @@ ___
* `if (CM_SKIP_RUN != True)`
* CM names: `--adr.['benchmark-program']...`
- CM script: [benchmark-program](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program)
-
___
### Script output
-`cmr "test onnxruntime cpp[,variations]" -j`
+`cmr "test onnxruntime cpp [,variations]" -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/test-set-sys-user-cm/README.md b/cm-mlops/script/test-set-sys-user-cm/README.md
index cf320df31c..b532a02e02 100644
--- a/cm-mlops/script/test-set-sys-user-cm/README.md
+++ b/cm-mlops/script/test-set-sys-user-cm/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **test-set-sys-user-cm**
-
+Category: **Tests**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=test-set-sys-user-cm,25fdfcf0fe434af2) ]*
+---
#### Summary
-* Category: *Tests.*
-* 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/test-set-sys-user-cm)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-set-sys-user-cm)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *demo,set,sys-user,cm,sys-user-cm*
+* All CM tags to find and reuse this script (see in above meta description): *demo,set,sys-user,cm,sys-user-cm*
* Output cached? *True*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "demo set sys-user cm sys-user-cm" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=demo,set,sys-user,cm,sys-user-cm`
-#### Run this script from command line
+`cm run script --tags=demo,set,sys-user,cm,sys-user-cm `
-1. `cm run script --tags=demo,set,sys-user,cm,sys-user-cm `
+*or*
+
+`cmr "demo set sys-user cm sys-user-cm"`
+
+`cmr "demo set sys-user cm sys-user-cm " `
-2. `cmr "demo set sys-user cm sys-user-cm" `
#### Run this script from Python
@@ -102,29 +100,21 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-set-sys-user-cm/_cm.json)
+ 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-set-sys-user-cm/_cm.json)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-set-sys-user-cm/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-set-sys-user-cm/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-set-sys-user-cm/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-set-sys-user-cm/_cm.json)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-set-sys-user-cm/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-set-sys-user-cm/_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/test-set-sys-user-cm/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-set-sys-user-cm/_cm.json)
___
### Script output
-`cmr "demo set sys-user cm sys-user-cm" -j`
+`cmr "demo set sys-user cm sys-user-cm " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/truncate-mlperf-inference-accuracy-log/README.md b/cm-mlops/script/truncate-mlperf-inference-accuracy-log/README.md
index 657cf2e32b..a0bd449670 100644
--- a/cm-mlops/script/truncate-mlperf-inference-accuracy-log/README.md
+++ b/cm-mlops/script/truncate-mlperf-inference-accuracy-log/README.md
@@ -1,61 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ Default environment](#default-environment)
-* [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)
-
-
+Automatically generated README for this automation recipe: **truncate-mlperf-inference-accuracy-log**
-*Note that this README is automatically generated - don't edit!*
+Category: **MLPerf benchmark support**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=truncate-mlperf-inference-accuracy-log,9d5ec20434084d14) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *MLPerf benchmark support.*
-* 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/truncate-mlperf-inference-accuracy-log)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/truncate-mlperf-inference-accuracy-log)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *run,mlc,mlcommons,mlperf,inference,mlperf-inference,truncation,truncator,truncate,accuracy,accuracy-log,accuracy-log-trancation,accuracy-log-truncator,mlc-accuracy-log-trancation,mlc-accuracy-log-truncator*
+* All CM tags to find and reuse this script (see in above meta description): *run,mlc,mlcommons,mlperf,inference,mlperf-inference,truncation,truncator,truncate,accuracy,accuracy-log,accuracy-log-trancation,accuracy-log-truncator,mlc-accuracy-log-trancation,mlc-accuracy-log-truncator*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "run mlc mlcommons mlperf inference mlperf-inference truncation truncator truncate accuracy accuracy-log accuracy-log-trancation accuracy-log-truncator mlc-accuracy-log-trancation mlc-accuracy-log-truncator" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=run,mlc,mlcommons,mlperf,inference,mlperf-inference,truncation,truncator,truncate,accuracy,accuracy-log,accuracy-log-trancation,accuracy-log-truncator,mlc-accuracy-log-trancation,mlc-accuracy-log-truncator`
-1. `cm run script --tags=run,mlc,mlcommons,mlperf,inference,mlperf-inference,truncation,truncator,truncate,accuracy,accuracy-log,accuracy-log-trancation,accuracy-log-truncator,mlc-accuracy-log-trancation,mlc-accuracy-log-truncator [--input_flags]`
+`cm run script --tags=run,mlc,mlcommons,mlperf,inference,mlperf-inference,truncation,truncator,truncate,accuracy,accuracy-log,accuracy-log-trancation,accuracy-log-truncator,mlc-accuracy-log-trancation,mlc-accuracy-log-truncator [--input_flags]`
-2. `cmr "run mlc mlcommons mlperf inference mlperf-inference truncation truncator truncate accuracy accuracy-log accuracy-log-trancation accuracy-log-truncator mlc-accuracy-log-trancation mlc-accuracy-log-truncator" [--input_flags]`
+*or*
+
+`cmr "run mlc mlcommons mlperf inference mlperf-inference truncation truncator truncate accuracy accuracy-log accuracy-log-trancation accuracy-log-truncator mlc-accuracy-log-trancation mlc-accuracy-log-truncator"`
+
+`cmr "run mlc mlcommons mlperf inference mlperf-inference truncation truncator truncate accuracy accuracy-log accuracy-log-trancation accuracy-log-truncator mlc-accuracy-log-trancation mlc-accuracy-log-truncator " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -124,12 +116,10 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/truncate-mlperf-inference-accuracy-log/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/truncate-mlperf-inference-accuracy-log/_cm.json)***
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
@@ -140,23 +130,17 @@ ___
* `if (CM_MLPERF_INFERENCE_SUBMISSION_DIR != on)`
* CM names: `--adr.['get-mlperf-submission-dir']...`
- CM script: [get-mlperf-inference-submission-dir](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-submission-dir)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/truncate-mlperf-inference-accuracy-log/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/truncate-mlperf-inference-accuracy-log/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/truncate-mlperf-inference-accuracy-log/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/truncate-mlperf-inference-accuracy-log/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/truncate-mlperf-inference-accuracy-log/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/truncate-mlperf-inference-accuracy-log/_cm.json)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/truncate-mlperf-inference-accuracy-log/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/truncate-mlperf-inference-accuracy-log/_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/truncate-mlperf-inference-accuracy-log/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/truncate-mlperf-inference-accuracy-log/_cm.json)
___
### Script output
-`cmr "run mlc mlcommons mlperf inference mlperf-inference truncation truncator truncate accuracy accuracy-log accuracy-log-trancation accuracy-log-truncator mlc-accuracy-log-trancation mlc-accuracy-log-truncator" [--input_flags] -j`
+`cmr "run mlc mlcommons mlperf inference mlperf-inference truncation truncator truncate accuracy accuracy-log accuracy-log-trancation accuracy-log-truncator mlc-accuracy-log-trancation mlc-accuracy-log-truncator " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/upgrade-python-pip/README.md b/cm-mlops/script/upgrade-python-pip/README.md
index 2f9067a69d..fe8a8d8abf 100644
--- a/cm-mlops/script/upgrade-python-pip/README.md
+++ b/cm-mlops/script/upgrade-python-pip/README.md
@@ -1,55 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
-* [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)
+Automatically generated README for this automation recipe: **upgrade-python-pip**
-
+Category: **Tests**
+
+License: **Apache 2.0**
-*Note that this README is automatically generated - don't edit!*
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-### About
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=upgrade-python-pip,4343ed2d9a974923) ]*
+---
#### Summary
-* Category: *Tests.*
-* 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/upgrade-python-pip)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/upgrade-python-pip)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *upgrade,python,pip,python-pip*
+* All CM tags to find and reuse this script (see in above meta description): *upgrade,python,pip,python-pip*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "upgrade python pip python-pip" --help````
+
+#### Customize and run this script from the command line with different variations and flags
+
+`cm run script --tags=upgrade,python,pip,python-pip`
-#### Run this script from command line
+`cm run script --tags=upgrade,python,pip,python-pip `
-1. `cm run script --tags=upgrade,python,pip,python-pip `
+*or*
+
+`cmr "upgrade python pip python-pip"`
+
+`cmr "upgrade python pip python-pip " `
-2. `cmr "upgrade python pip python-pip" `
#### Run this script from Python
@@ -101,35 +99,27 @@ These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.j
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/upgrade-python-pip/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/upgrade-python-pip/_cm.json)***
* detect,os
- CM script: [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
1. Run "preprocess" function from customize.py
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/upgrade-python-pip/_cm.json)
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/upgrade-python-pip/_cm.json)
1. ***Run native script if exists***
- * [run.bat](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/upgrade-python-pip/run.bat)
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/upgrade-python-pip/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/upgrade-python-pip/_cm.json)
+ * [run.bat](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/upgrade-python-pip/run.bat)
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/upgrade-python-pip/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/upgrade-python-pip/_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/upgrade-python-pip/_cm.json)
-
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/upgrade-python-pip/_cm.json)
___
### Script output
-`cmr "upgrade python pip python-pip" -j`
+`cmr "upgrade python pip python-pip " -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission/README.md b/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission/README.md
index 278bae6841..1ed1c42ed4 100644
--- a/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission/README.md
+++ b/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission/README.md
@@ -1,62 +1,53 @@
-
-Click here to see the table of contents.
-
-* [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)
- * [ Script flags mapped to environment](#script-flags-mapped-to-environment)
- * [ 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)
-
-
+Automatically generated README for this automation recipe: **wrapper-reproduce-octoml-tinyml-submission**
-*Note that this README is automatically generated - don't edit!*
+Category: **Reproduce MLPerf benchmarks**
-### About
+License: **Apache 2.0**
+Maintainers: [Public MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
-See extra [notes](README-extra.md) from the authors and contributors.
+---
+*[ [Online info and GUI to run this CM script](https://access.cknowledge.org/playground/?action=scripts&name=wrapper-reproduce-octoml-tinyml-submission,b946001e289c4480) ] [ [Notes from the authors, contributors and users](README-extra.md) ]*
+---
#### Summary
-* Category: *Reproduce MLPerf benchmarks.*
-* 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/wrapper-reproduce-octoml-tinyml-submission)*
+* CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops)*
+* GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission)*
* CM meta description for this script: *[_cm.json](_cm.json)*
-* CM "database" tags to find this script: *run,generate-tiny,generate,submission,tiny,generate-tiny-submission,results,mlcommons,mlperf,octoml*
+* All CM tags to find and reuse this script (see in above meta description): *run,generate-tiny,generate,submission,tiny,generate-tiny-submission,results,mlcommons,mlperf,octoml*
* Output cached? *False*
-___
+* See [pipeline of dependencies](#dependencies-on-other-cm-scripts) on other CM scripts
+
+
+---
### Reuse this script in your project
-#### Install CM automation language
+#### Install MLCommons CM automation meta-framework
-* [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md)
-* [CM intro](https://doi.org/10.5281/zenodo.8105339)
+* [Install CM](https://access.cknowledge.org/playground/?action=install)
+* [CM Getting Started Guide](https://github.com/mlcommons/ck/blob/master/docs/getting-started.md)
-#### Pull CM repository with this automation
+#### Pull CM repository with this automation recipe (CM script)
```cm pull repo mlcommons@ck```
+#### Print CM help from the command line
+
+````cmr "run generate-tiny generate submission tiny generate-tiny-submission results mlcommons mlperf octoml" --help````
+
+#### Customize and run this script from the command line with different variations and flags
-#### Run this script from command line
+`cm run script --tags=run,generate-tiny,generate,submission,tiny,generate-tiny-submission,results,mlcommons,mlperf,octoml`
-1. `cm run script --tags=run,generate-tiny,generate,submission,tiny,generate-tiny-submission,results,mlcommons,mlperf,octoml [--input_flags]`
+`cm run script --tags=run,generate-tiny,generate,submission,tiny,generate-tiny-submission,results,mlcommons,mlperf,octoml [--input_flags]`
-2. `cmr "run generate-tiny generate submission tiny generate-tiny-submission results mlcommons mlperf octoml" [--input_flags]`
+*or*
+
+`cmr "run generate-tiny generate submission tiny generate-tiny-submission results mlcommons mlperf octoml"`
+
+`cmr "run generate-tiny generate submission tiny generate-tiny-submission results mlcommons mlperf octoml " [--input_flags]`
-* `input_flags` can be seen [here](#script-flags-mapped-to-environment)
#### Run this script from Python
@@ -128,32 +119,24 @@ Default version: `r1.0`
* `r1.0`
___
-### Script workflow, dependencies and native scripts
+### Dependencies on other CM scripts
-
-Click here to expand this section.
- 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission/_cm.json)***
+ 1. ***Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission/_cm.json)***
* get,python3
* CM names: `--adr.['python', 'python3']...`
- CM script: [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
- 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission/customize.py)***
- 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission/_cm.json)
+ 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission/customize.py)***
+ 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission/_cm.json)
1. ***Run native script if exists***
- * [run.sh](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission/run.sh)
- 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission/_cm.json)
- 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission/customize.py)***
- 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission/_cm.json)
-
+ * [run.sh](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission/run.sh)
+ 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission/_cm.json)
+ 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission/customize.py)***
+ 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission/_cm.json)
___
### Script output
-`cmr "run generate-tiny generate submission tiny generate-tiny-submission results mlcommons mlperf octoml" [--input_flags] -j`
+`cmr "run generate-tiny generate submission tiny generate-tiny-submission results mlcommons mlperf octoml " [--input_flags] -j`
#### New environment keys (filter)
#### 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)
\ No newline at end of file
diff --git a/cm/CHANGES.md b/cm/CHANGES.md
index 653699ced1..f5de335cbb 100644
--- a/cm/CHANGES.md
+++ b/cm/CHANGES.md
@@ -1,5 +1,7 @@
## V2.0.3.1
- added skip of delayed help to simplify output of `cmr [tags] --help`
+ - revisited automatically generated READMEs for CM scripts (automation recipes)
+ based on user feedback: https://github.com/mlcommons/ck/issues/1169
## V2.0.3
- added support to handle broken CM repositories: https://github.com/mlcommons/ck/issues/1177
diff --git a/cm/CONTRIBUTING.md b/cm/CONTRIBUTING.md
index 3fd2f12d64..e03384b1d3 100644
--- a/cm/CONTRIBUTING.md
+++ b/cm/CONTRIBUTING.md
@@ -1,68 +1 @@
-## Contributing to the MLCommons
-
-The best way to contribute to the MLCommons is to get involved with one of our many project communities.
-You find more information about getting involved with MLCommons [here](https://mlcommons.org/en/get-involved/#getting-started).
-
-Generally we encourage people to become a MLCommons member if they wish to contribute to MLCommons projects,
-but outside pull requests are very welcome too.
-
-Regardless of if you are a member, your organization needs to sign the MLCommons CLA.
-Please fill out this [CLA sign up form](https://forms.gle/Ew1KkBVpyeJDuRw67) form to get started.
-
-MLCommons project work is tracked with issue trackers and pull requests.
-Modify the project in your own fork and issue a pull request once you want other developers
-to take a look at what you have done and discuss the proposed changes.
-Ensure that cla-bot and other checks pass for your Pull requests.
-
-## Contributing to MLCommons Collective Mind
-
-Please check this [Getting Started Guide](docs/getting-started.md)
-and join our [Discord server](https://discord.gg/JjWNWXKxwT).
-Thank you for your support and looking forward to collaborating with you!
-
-## Authors and project coordinators
-
-* [Grigori Fursin](https://cKnowledge.org/gfursin)
-* [Arjun Suresh](https://www.linkedin.com/in/arjunsuresh)
-
-## Contributors to Collective Mind in alphabetical order
-
-* Resmi Arjun
-* Ethan Cheng (Nvidia)
-* Jiahao Chen (MIT)
-* Ray DeMoss (One Stop Systems)
-* Himanshu Dutta (Indian Institute of Technology)
-* Justin Faust (One Stop Systems)
-* Leonid Fursin (United Silicon Carbide)
-* Michael Goin (Neural Magic)
-* Jose Armando Hernandez (Paris Saclay University)
-* Mehrdad Hessar (OctoML)
-* Miro Hodak (AMD)
-* Nino Jacob
-* David Kanter (MLCommons)
-* Jason Knight (OctoML)
-* Ilya Kozulin (Deelvin)
-* @makaveli10 (Collabora)
-* Peter Mattson (Google, MLCommons)
-* Kasper Mecklenburg (Arm)
-* Thierry Moreau (OctoML)
-* Sachin Mudaliyar
-* Stanley Mwangi (Microsoft)
-* Ashwin Nanjappa (Nvidia)
-* Nandeeka Nayak (UIUC)
-* Datta Nimmaturi (Nutanix)
-* Lakshman Patel
-* Vijay Janapa Reddi (Harvard University)
-* Andrew Reusch (OctoML)
-* Anandhu S (Kerala Technical University)
-* Warren Schultz (Principled Technologies)
-* Amrutha Sheleenderan (Kerala Technical University)
-* Byoungjun Seo (TTA)
-* Aditya Kumar Shaw (Indian Institute of Science)
-* Ilya Slavutin (Deelvin)
-* David Taufur (MLCommons)
-* Chloe Tessier
-* Gaurav Verma (Stony Brook University)
-* Haoyang Zhang (UIUC)
-* Bojian Zheng (University of Toronto)
-* Thomas Zhu (Oxford University)
+See https://github.com/mlcommons/ck/blob/master/CONTRIBUTING.md
diff --git a/cm/COPYRIGHT.txt b/cm/COPYRIGHT.txt
index d90090a760..ecc5280543 100644
--- a/cm/COPYRIGHT.txt
+++ b/cm/COPYRIGHT.txt
@@ -1 +1 @@
-Copyright (c) 2022-2023 MLCommons
+Copyright (c) 2022-2024 MLCommons
diff --git a/cm/README.md b/cm/README.md
index 9abde04632..3d9021e37a 100644
--- a/cm/README.md
+++ b/cm/README.md
@@ -52,6 +52,9 @@ pip install cmind -U
cm pull repo mlcommons@ck
+cm checkout repo mlcommons@ck --branch=dev
+cm checkout repo mlcommons@ck --branch=master
+
cm rm cache -f
cm run script "get mlcommons inference src"
diff --git a/docs/_generator/list_scripts_test.cmd b/docs/_generator/list_scripts_test.cmd
new file mode 100644
index 0000000000..af6012a0be
--- /dev/null
+++ b/docs/_generator/list_scripts_test.cmd
@@ -0,0 +1 @@
+cm doc script app-loadgen-generic-python --output_dir=..
\ No newline at end of file
diff --git a/docs/installation.md b/docs/installation.md
index a16e7b08f3..e4c7263384 100644
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -229,10 +229,23 @@ for portable MLOps and DevOps from MLCommons directly by installing the followin
cm pull repo mlcommons@ck
```
+You can switch to a development branch of this or any other CM repository as follows:
+
+```bash
+cm checkout repo mlcommons@ck --branch=dev
+```
+
+You can switch back to master branch as follows:
+
+```bash
+cm checkout repo mlcommons@ck --branch=master
+```
+
If you plan to participate in our [reproducibility and optimization challenges](https://access.cknowledge.org/playground/?action=challenges),
we suggest you to create a fork of [github.com/mlcommons/ck](https://github.com/mlcommons/ck) and use it.
In such case, you will be able to create PRs with your updates to the main repository.
If you already installed above repo, you will need delete it and install your fork as follows:
+
```bash
cm rm repo mlcommons@ck --all
cm pull repo --url={URL of the fork of github.com/mlcommons/ck}
@@ -240,6 +253,7 @@ cm pull repo --url={URL of the fork of github.com/mlcommons/ck}
If you want to use stable CM snapshots of reusable automation recipes (CM scripts),
you can download a stable repository from Zenodo (~5MB):
+
```bash
cm rm repo mlcommons@ck --all
cm pull repo --url=https://zenodo.org/records/10787459/files/cm-mlops-repo-20240306.zip
diff --git a/docs/list_of_automations.md b/docs/list_of_automations.md
index a751a199bf..7b0425af08 100644
--- a/docs/list_of_automations.md
+++ b/docs/list_of_automations.md
@@ -11,6 +11,7 @@ This file is generated automatically - don't edit!
* [cache](#cache) *(Caching cross-platform CM scripts)*
* [utils](#utils) *(Accessing various CM utils)*
* [core](#core) *(Accessing some core CM functions)*
+* [cfg](#cfg)
* [challenge](#challenge)
* [contributor](#contributor)
* [docker](#docker) *(Managing modular docker containers (under development))*
@@ -31,18 +32,21 @@ This file is generated automatically - don't edit!
* CM automation code and meta: *[GitHub](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo)*
* CM automation actions:
* cm **pull** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L15) )*
- * cm **search** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L98) )*
- * cm **where** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L184) )*
- * cm **update** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L207) )*
- * cm **delete** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L244) )*
- * cm **init** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L301) )*
- * cm **add** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L426) )*
- * cm **pack** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L434) )*
- * cm **unpack** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L504) )*
- * cm **import_ck_to_cm** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L611) )*
- * cm **convert_ck_to_cm** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L662) )*
- * cm **detect** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L716) )*
- * cm **reindex** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L899) )*
+ * cm **checkout** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L161) )*
+ * cm **show** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L181) )*
+ * cm **search** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L198) )*
+ * cm **where** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L332) )*
+ * cm **update** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L355) )*
+ * cm **delete** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L392) )*
+ * cm **ximport** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L449) )*
+ * cm **init** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L457) )*
+ * cm **add** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L582) )*
+ * cm **pack** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L590) )*
+ * cm **unpack** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L660) )*
+ * cm **import_ck_to_cm** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L767) )*
+ * cm **convert_ck_to_cm** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L818) )*
+ * cm **detect** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L872) )*
+ * cm **reindex** repo *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/repo/module.py#L1055) )*
## script
@@ -54,25 +58,27 @@ This file is generated automatically - don't edit!
* GitHub repository with CM automations: *cm pull [mlcommons@ck](https://github.com/mlcommons/ck/tree/master/cm-mlops)*
* CM automation code and meta: *[GitHub](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script)*
* CM automation actions:
- * cm **run** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L72) )*
- * cm **version** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L1749) )*
- * cm **search** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L1777) )*
- * cm **test** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L1887) )*
- * cm **native_run** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L1953) )*
- * cm **add** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2026) )*
- * cm **run_native_script** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2624) )*
- * cm **find_file_in_paths** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2665) )*
- * cm **detect_version_using_script** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2879) )*
- * cm **find_artifact** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2952) )*
- * cm **find_file_deep** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3110) )*
- * cm **find_file_back** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3168) )*
- * cm **parse_version** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3209) )*
- * cm **update_deps** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3263) )*
- * cm **get_default_path_list** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3282) )*
- * cm **doc** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3293) )*
- * cm **dockerfile** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3322) )*
- * cm **docker** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3350) )*
- * cm **prepare** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3403) )*
+ * cm **run** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L77) )*
+ * cm **version** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2041) )*
+ * cm **search** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2069) )*
+ * cm **test** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2188) )*
+ * cm **native_run** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2254) )*
+ * cm **add** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2327) )*
+ * cm **run_native_script** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2955) )*
+ * cm **find_file_in_paths** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L2996) )*
+ * cm **detect_version_using_script** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3215) )*
+ * cm **find_artifact** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3288) )*
+ * cm **find_file_deep** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3446) )*
+ * cm **find_file_back** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3504) )*
+ * cm **parse_version** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3545) )*
+ * cm **update_deps** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3599) )*
+ * cm **get_default_path_list** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3619) )*
+ * cm **doc** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3630) )*
+ * cm **gui** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3658) )*
+ * cm **dockerfile** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3695) )*
+ * cm **docker** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3723) )*
+ * cm **prepare** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3777) )*
+ * cm **clean_some_tmp_files** script *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/script/module.py#L3788) )*
## cache
@@ -87,6 +93,7 @@ This file is generated automatically - don't edit!
* cm **test** cache *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/cache/module.py#L15) )*
* cm **show** cache *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/cache/module.py#L54) )*
* cm **search** cache *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/cache/module.py#L153) )*
+ * cm **copy_to_remote** cache *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/cache/module.py#L186) )*
## utils
@@ -101,16 +108,22 @@ This file is generated automatically - don't edit!
* cm **test** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L15) )*
* cm **get_host_os_info** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L54) )*
* cm **download_file** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L156) )*
- * cm **unzip_file** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L256) )*
- * cm **compare_versions** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L334) )*
- * cm **json2yaml** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L382) )*
- * cm **yaml2json** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L420) )*
- * cm **sort_json** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L458) )*
- * cm **dos2unix** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L495) )*
- * cm **replace_string_in_file** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L532) )*
- * cm **create_toc_from_md** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L582) )*
- * cm **copy_to_clipboard** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L650) )*
- * cm **list_files_recursively** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L728) )*
+ * cm **unzip_file** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L265) )*
+ * cm **compare_versions** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L343) )*
+ * cm **json2yaml** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L391) )*
+ * cm **yaml2json** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L429) )*
+ * cm **sort_json** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L467) )*
+ * cm **dos2unix** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L504) )*
+ * cm **replace_string_in_file** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L541) )*
+ * cm **create_toc_from_md** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L591) )*
+ * cm **copy_to_clipboard** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L659) )*
+ * cm **list_files_recursively** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L737) )*
+ * cm **generate_secret** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L770) )*
+ * cm **detect_tags_in_artifact** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L793) )*
+ * cm **prune_input** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L822) )*
+ * cm **uid** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L864) )*
+ * cm **system** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L891) )*
+ * cm **load_cfg** utils *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/utils/module.py#L969) )*
## core
@@ -125,6 +138,15 @@ This file is generated automatically - don't edit!
* cm **uid** core *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm/cmind/repo/automation/core/module.py#L22) )*
+## cfg
+
+
+* GitHub repository with CM automations: *cm pull [mlcommons@ck](https://github.com/mlcommons/ck/tree/master/cm-mlops)*
+* CM automation code and meta: *[GitHub](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/cfg)*
+* CM automation actions:
+ * cm **test** cfg *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/cfg/module.py#L15) )*
+
+
## challenge
@@ -167,8 +189,8 @@ This file is generated automatically - don't edit!
* CM automation actions:
* cm **test** experiment *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L22) )*
* cm **run** experiment *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L64) )*
- * cm **rerun** experiment *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L417) )*
- * cm **replay** experiment *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L440) )*
+ * cm **rerun** experiment *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L428) )*
+ * cm **replay** experiment *( [See CM API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L451) )*
## project
diff --git a/docs/list_of_scripts.md b/docs/list_of_scripts.md
index f91b789d27..c73f3c5eab 100644
--- a/docs/list_of_scripts.md
+++ b/docs/list_of_scripts.md
@@ -44,7 +44,6 @@ for a given task and platform [using simple JSON or YAML](https://github.com/mlc
* [AI/ML frameworks](#aiml-frameworks)
* [AI/ML models](#aiml-models)
* [AI/ML optimization](#aiml-optimization)
-* [Benchmark object detection (loadgen, python, ONNX)](#benchmark-object-detection-(loadgen,-python,-onnx))
* [CM interface prototyping](#cm-interface-prototyping)
* [CUDA automation](#cuda-automation)
* [Cloud automation](#cloud-automation)
@@ -75,597 +74,599 @@ for a given task and platform [using simple JSON or YAML](https://github.com/mlc
### AI/ML datasets
-* [get-dataset-cifar10](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cifar10)
-* [get-dataset-cnndm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cnndm)
-* [get-dataset-coco](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco)
-* [get-dataset-coco2014](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco2014)
-* [get-dataset-cognata](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cognata)
-* [get-dataset-criteo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-criteo)
-* [get-dataset-imagenet-aux](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-aux)
-* [get-dataset-imagenet-calibration](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-calibration)
-* [get-dataset-imagenet-helper](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-helper)
-* [get-dataset-imagenet-train](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-train)
-* [get-dataset-imagenet-val](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-val)
-* [get-dataset-kits19](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-kits19)
-* [get-dataset-librispeech](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-librispeech)
-* [get-dataset-openimages](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages)
-* [get-dataset-openimages-annotations](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages-annotations)
-* [get-dataset-openimages-calibration](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages-calibration)
-* [get-dataset-openorca](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openorca)
-* [get-dataset-squad](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-squad)
-* [get-dataset-squad-vocab](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-squad-vocab)
-* [get-mlcommons-croissant](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlcommons-croissant)
-* [get-preprocessed-dataset-criteo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-criteo)
-* [get-preprocessed-dataset-imagenet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-imagenet)
-* [get-preprocessed-dataset-kits19](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-kits19)
-* [get-preprocessed-dataset-librispeech](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-librispeech)
-* [get-preprocessed-dataset-openimages](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-openimages)
-* [get-preprocessed-dataset-openorca](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-openorca)
-* [get-preprocessed-dataset-squad](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-squad)
-* [get-preprocesser-script-generic](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocesser-script-generic)
+* [get-croissant](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-croissant)
+* [get-dataset-cifar10](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cifar10)
+* [get-dataset-cnndm](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cnndm)
+* [get-dataset-coco](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-coco)
+* [get-dataset-coco2014](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-coco2014)
+* [get-dataset-cognata](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cognata)
+* [get-dataset-criteo](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-criteo)
+* [get-dataset-imagenet-aux](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-aux)
+* [get-dataset-imagenet-calibration](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-calibration)
+* [get-dataset-imagenet-helper](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-helper)
+* [get-dataset-imagenet-train](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-train)
+* [get-dataset-imagenet-val](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-val)
+* [get-dataset-kits19](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-kits19)
+* [get-dataset-librispeech](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-librispeech)
+* [get-dataset-openimages](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages)
+* [get-dataset-openimages-annotations](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages-annotations)
+* [get-dataset-openimages-calibration](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages-calibration)
+* [get-dataset-openorca](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openorca)
+* [get-dataset-squad](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-squad)
+* [get-dataset-squad-vocab](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-squad-vocab)
+* [get-preprocessed-dataset-criteo](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-criteo)
+* [get-preprocessed-dataset-imagenet](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-imagenet)
+* [get-preprocessed-dataset-kits19](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-kits19)
+* [get-preprocessed-dataset-librispeech](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-librispeech)
+* [get-preprocessed-dataset-openimages](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-openimages)
+* [get-preprocessed-dataset-openorca](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-openorca)
+* [get-preprocessed-dataset-squad](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-squad)
+* [get-preprocesser-script-generic](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocesser-script-generic)
### AI/ML frameworks
-* [get-onnxruntime-prebuilt](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-onnxruntime-prebuilt)
-* [get-qaic-apps-sdk](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-apps-sdk)
-* [get-qaic-platform-sdk](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-platform-sdk)
-* [get-qaic-software-kit](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-software-kit)
-* [get-rocm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-rocm)
-* [get-tvm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tvm)
-* [install-qaic-compute-sdk-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-qaic-compute-sdk-from-src)
-* [install-rocm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-rocm)
-* [install-tensorflow-for-c](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tensorflow-for-c)
-* [install-tensorflow-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tensorflow-from-src)
-* [install-tflite-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tflite-from-src)
+* [get-google-saxml](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-google-saxml)
+* [get-onnxruntime-prebuilt](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-onnxruntime-prebuilt)
+* [get-qaic-apps-sdk](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-apps-sdk)
+* [get-qaic-platform-sdk](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-platform-sdk)
+* [get-qaic-software-kit](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-software-kit)
+* [get-rocm](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-rocm)
+* [get-tvm](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tvm)
+* [install-qaic-compute-sdk-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-qaic-compute-sdk-from-src)
+* [install-rocm](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-rocm)
+* [install-tensorflow-for-c](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tensorflow-for-c)
+* [install-tensorflow-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tensorflow-from-src)
+* [install-tflite-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tflite-from-src)
### AI/ML models
-* [convert-ml-model-huggingface-to-onnx](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/convert-ml-model-huggingface-to-onnx)
-* [get-bert-squad-vocab](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-bert-squad-vocab)
-* [get-dlrm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dlrm)
-* [get-ml-model-3d-unet-kits19](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-3d-unet-kits19)
-* [get-ml-model-abtf-ssd-pytorch](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-abtf-ssd-pytorch)
-* [get-ml-model-bert-base-squad](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-bert-base-squad)
-* [get-ml-model-bert-large-squad](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-bert-large-squad)
-* [get-ml-model-dlrm-terabyte](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-dlrm-terabyte)
-* [get-ml-model-efficientnet-lite](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-efficientnet-lite)
-* [get-ml-model-gptj](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-gptj)
-* [get-ml-model-huggingface-zoo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-huggingface-zoo)
-* [get-ml-model-llama2](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-llama2)
-* [get-ml-model-mobilenet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-mobilenet)
-* [get-ml-model-neuralmagic-zoo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-neuralmagic-zoo)
-* [get-ml-model-resnet50](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-resnet50)
-* [get-ml-model-retinanet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-retinanet)
-* [get-ml-model-retinanet-nvidia](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-retinanet-nvidia)
-* [get-ml-model-rnnt](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-rnnt)
-* [get-ml-model-stable-diffusion](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-stable-diffusion)
-* [get-ml-model-tiny-resnet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-tiny-resnet)
-* [get-ml-model-using-imagenet-from-model-zoo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo)
-* [get-tvm-model](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tvm-model)
+* [convert-ml-model-huggingface-to-onnx](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/convert-ml-model-huggingface-to-onnx)
+* [get-bert-squad-vocab](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-bert-squad-vocab)
+* [get-dlrm](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dlrm)
+* [get-ml-model-3d-unet-kits19](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-3d-unet-kits19)
+* [get-ml-model-abtf-ssd-pytorch](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-abtf-ssd-pytorch)
+* [get-ml-model-bert-base-squad](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-bert-base-squad)
+* [get-ml-model-bert-large-squad](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-bert-large-squad)
+* [get-ml-model-dlrm-terabyte](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-dlrm-terabyte)
+* [get-ml-model-efficientnet-lite](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-efficientnet-lite)
+* [get-ml-model-gptj](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-gptj)
+* [get-ml-model-huggingface-zoo](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-huggingface-zoo)
+* [get-ml-model-llama2](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-llama2)
+* [get-ml-model-mobilenet](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-mobilenet)
+* [get-ml-model-neuralmagic-zoo](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-neuralmagic-zoo)
+* [get-ml-model-resnet50](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-resnet50)
+* [get-ml-model-retinanet](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-retinanet)
+* [get-ml-model-retinanet-nvidia](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-retinanet-nvidia)
+* [get-ml-model-rnnt](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-rnnt)
+* [get-ml-model-stable-diffusion](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-stable-diffusion)
+* [get-ml-model-tiny-resnet](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-tiny-resnet)
+* [get-ml-model-using-imagenet-from-model-zoo](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo)
+* [get-tvm-model](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tvm-model)
### AI/ML optimization
-* [calibrate-model-for.qaic](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/calibrate-model-for.qaic)
-* [compile-model-for.qaic](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/compile-model-for.qaic)
-* [prune-bert-models](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prune-bert-models)
-
-### Benchmark object detection (loadgen, python, ONNX)
-
-* [benchmark-object-detection-loadgen](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-object-detection-loadgen)
+* [calibrate-model-for.qaic](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/calibrate-model-for.qaic)
+* [compile-model-for.qaic](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/compile-model-for.qaic)
+* [prune-bert-models](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prune-bert-models)
### CM interface prototyping
-* [test-mlperf-inference-retinanet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-mlperf-inference-retinanet)
+* [test-mlperf-inference-retinanet](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-mlperf-inference-retinanet)
### CUDA automation
-* [get-cuda](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda)
-* [get-cuda-devices](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda-devices)
-* [get-cudnn](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cudnn)
-* [get-tensorrt](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tensorrt)
-* [install-cuda-package-manager](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cuda-package-manager)
-* [install-cuda-prebuilt](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cuda-prebuilt)
+* [get-cuda](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cuda)
+* [get-cuda-devices](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cuda-devices)
+* [get-cudnn](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cudnn)
+* [get-tensorrt](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tensorrt)
+* [install-cuda-package-manager](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cuda-package-manager)
+* [install-cuda-prebuilt](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cuda-prebuilt)
### Cloud automation
-* [destroy-terraform](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/destroy-terraform)
-* [get-aws-cli](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-aws-cli)
-* [get-rclone](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-rclone)
-* [get-terraform](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-terraform)
-* [install-aws-cli](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-aws-cli)
-* [install-terraform-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-terraform-from-src)
-* [run-terraform](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-terraform)
+* [destroy-terraform](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/destroy-terraform)
+* [get-aws-cli](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-aws-cli)
+* [get-terraform](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-terraform)
+* [install-aws-cli](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-aws-cli)
+* [install-terraform-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-terraform-from-src)
+* [run-terraform](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-terraform)
### Collective benchmarking
-* [launch-benchmark](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/launch-benchmark)
+* [launch-benchmark](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/launch-benchmark)
### Compiler automation
-* [get-aocl](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-aocl)
-* [get-cl](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cl) *(Detect or install Microsoft C compiler)*
-* [get-compiler-flags](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-compiler-flags)
-* [get-compiler-rust](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-compiler-rust)
-* [get-gcc](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-gcc) *(Detect or install GCC compiler)*
-* [get-go](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-go)
-* [get-llvm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-llvm) *(Detect or install LLVM compiler)*
-* [install-gcc-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-gcc-src)
-* [install-ipex-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-ipex-from-src) *(Build IPEX from sources)*
-* [install-llvm-prebuilt](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-llvm-prebuilt) *(Install prebuilt LLVM compiler)*
-* [install-llvm-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-llvm-src) *(Build LLVM compiler from sources (can take >30 min))*
-* [install-onednn-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-onednn-from-src) *(Build oneDNN from sources)*
-* [install-onnxruntime-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-onnxruntime-from-src) *(Build onnxruntime from sources)*
-* [install-pytorch-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-pytorch-from-src) *(Build pytorch from sources)*
-* [install-pytorch-kineto-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-pytorch-kineto-from-src) *(Build pytorch kineto from sources)*
-* [install-transformers-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-transformers-from-src) *(Build transformers from sources)*
+* [get-aocl](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-aocl)
+* [get-cl](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cl) *(Detect or install Microsoft C compiler)*
+* [get-compiler-flags](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-compiler-flags)
+* [get-compiler-rust](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-compiler-rust)
+* [get-gcc](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-gcc) *(Detect or install GCC compiler)*
+* [get-go](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-go)
+* [get-llvm](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-llvm) *(Detect or install LLVM compiler)*
+* [install-gcc-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-gcc-src)
+* [install-ipex-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-ipex-from-src) *(Build IPEX from sources)*
+* [install-llvm-prebuilt](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-llvm-prebuilt) *(Install prebuilt LLVM compiler)*
+* [install-llvm-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-llvm-src) *(Build LLVM compiler from sources (can take >30 min))*
+* [install-onednn-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-onednn-from-src) *(Build oneDNN from sources)*
+* [install-onnxruntime-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-onnxruntime-from-src) *(Build onnxruntime from sources)*
+* [install-pytorch-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pytorch-from-src) *(Build pytorch from sources)*
+* [install-pytorch-kineto-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pytorch-kineto-from-src) *(Build pytorch kineto from sources)*
+* [install-torchvision-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-torchvision-from-src) *(Build pytorchvision from sources)*
+* [install-tpp-pytorch-extension](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tpp-pytorch-extension) *(Build TPP-PEX from sources)*
+* [install-transformers-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-transformers-from-src) *(Build transformers from sources)*
### Dashboard automation
-* [publish-results-to-dashboard](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/publish-results-to-dashboard)
+* [publish-results-to-dashboard](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/publish-results-to-dashboard)
### Detection or installation of tools and artifacts
-* [get-android-sdk](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-android-sdk)
-* [get-bazel](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-bazel)
-* [get-blis](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-blis)
-* [get-brew](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-brew)
-* [get-cmake](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmake)
-* [get-cmsis_5](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmsis_5)
-* [get-docker](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-docker)
-* [get-generic-sys-util](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-sys-util)
-* [get-google-test](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-google-test)
-* [get-java](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-java)
-* [get-javac](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-javac)
-* [get-lib-armnn](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-armnn)
-* [get-lib-dnnl](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-dnnl)
-* [get-lib-protobuf](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-protobuf)
-* [get-lib-qaic-api](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-qaic-api)
-* [get-nvidia-docker](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-nvidia-docker)
-* [get-openssl](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-openssl)
-* [get-sys-utils-cm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm)
-* [get-sys-utils-min](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-min)
-* [get-xilinx-sdk](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-xilinx-sdk)
-* [get-zendnn](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zendnn)
-* [install-bazel](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-bazel)
-* [install-cmake-prebuilt](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cmake-prebuilt)
-* [install-gflags](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-gflags)
-* [install-github-cli](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-github-cli)
-* [install-openssl](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-openssl)
+* [get-android-sdk](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-android-sdk)
+* [get-bazel](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-bazel)
+* [get-blis](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-blis)
+* [get-brew](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-brew)
+* [get-cmake](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cmake)
+* [get-cmsis_5](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cmsis_5)
+* [get-docker](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-docker)
+* [get-generic-sys-util](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-generic-sys-util)
+* [get-google-test](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-google-test)
+* [get-java](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-java)
+* [get-javac](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-javac)
+* [get-lib-armnn](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-armnn)
+* [get-lib-dnnl](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-dnnl)
+* [get-lib-protobuf](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-protobuf)
+* [get-lib-qaic-api](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-qaic-api)
+* [get-nvidia-docker](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-nvidia-docker)
+* [get-openssl](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-openssl)
+* [get-rclone](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-rclone)
+* [get-sys-utils-cm](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-cm)
+* [get-sys-utils-min](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-min)
+* [get-xilinx-sdk](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-xilinx-sdk)
+* [get-zendnn](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zendnn)
+* [install-bazel](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-bazel)
+* [install-cmake-prebuilt](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cmake-prebuilt)
+* [install-gflags](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-gflags)
+* [install-github-cli](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-github-cli)
+* [install-numactl-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-numactl-from-src) *(Build numactl from sources)*
+* [install-openssl](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-openssl)
### DevOps automation
-* [benchmark-program](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program)
-* [compile-program](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/compile-program)
-* [convert-csv-to-md](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/convert-csv-to-md)
-* [copy-to-clipboard](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/copy-to-clipboard)
-* [create-conda-env](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-conda-env)
-* [create-patch](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-patch)
-* [detect-sudo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-sudo)
-* [download-and-extract](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-and-extract)
-* [download-file](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-file)
-* [download-torrent](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-torrent)
-* [extract-file](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/extract-file)
-* [fail](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/fail)
-* [get-conda](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-conda)
-* [get-git-repo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo)
-* [get-github-cli](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-github-cli)
-* [pull-git-repo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/pull-git-repo)
-* [push-csv-to-spreadsheet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/push-csv-to-spreadsheet)
-* [set-device-settings-qaic](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-device-settings-qaic)
-* [set-echo-off-win](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-echo-off-win)
-* [set-performance-mode](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-performance-mode)
-* [set-sqlite-dir](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-sqlite-dir)
-* [tar-my-folder](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/tar-my-folder)
+* [benchmark-program](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-program)
+* [compile-program](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/compile-program)
+* [convert-csv-to-md](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/convert-csv-to-md)
+* [copy-to-clipboard](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/copy-to-clipboard)
+* [create-conda-env](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-conda-env)
+* [create-patch](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-patch)
+* [detect-sudo](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-sudo)
+* [download-and-extract](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-and-extract)
+* [download-file](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-file)
+* [download-torrent](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-torrent)
+* [extract-file](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/extract-file)
+* [fail](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/fail)
+* [get-conda](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-conda)
+* [get-git-repo](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-git-repo)
+* [get-github-cli](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-github-cli)
+* [pull-git-repo](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/pull-git-repo)
+* [push-csv-to-spreadsheet](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/push-csv-to-spreadsheet)
+* [set-device-settings-qaic](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-device-settings-qaic)
+* [set-echo-off-win](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-echo-off-win)
+* [set-performance-mode](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-performance-mode)
+* [set-sqlite-dir](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-sqlite-dir)
+* [tar-my-folder](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/tar-my-folder)
### Docker automation
-* [build-docker-image](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-docker-image)
-* [build-dockerfile](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-dockerfile)
-* [run-docker-container](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-docker-container)
+* [build-docker-image](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-docker-image)
+* [build-dockerfile](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-dockerfile)
+* [run-docker-container](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-docker-container)
### GUI
-* [gui](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/gui)
+* [gui](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/gui)
### Hardware automation
-* [get-target-device](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-target-device)
+* [get-target-device](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-target-device)
### Legacy CK support
-* [get-ck](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ck)
-* [get-ck-repo-mlops](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ck-repo-mlops)
+* [get-ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ck)
+* [get-ck-repo-mlops](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ck-repo-mlops)
### MLPerf benchmark support
-* [add-custom-nvidia-system](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/add-custom-nvidia-system)
-* [benchmark-any-mlperf-inference-implementation](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-any-mlperf-inference-implementation)
-* [build-mlperf-inference-server-nvidia](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-mlperf-inference-server-nvidia)
-* [generate-mlperf-inference-submission](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-inference-submission)
-* [generate-mlperf-inference-user-conf](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-inference-user-conf)
-* [generate-mlperf-tiny-report](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-tiny-report)
-* [generate-mlperf-tiny-submission](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-tiny-submission)
-* [generate-nvidia-engine](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-nvidia-engine)
-* [get-mlperf-inference-intel-scratch-space](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-intel-scratch-space)
-* [get-mlperf-inference-loadgen](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-loadgen)
-* [get-mlperf-inference-nvidia-common-code](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-common-code)
-* [get-mlperf-inference-nvidia-scratch-space](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space)
-* [get-mlperf-inference-results](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-results)
-* [get-mlperf-inference-results-dir](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-results-dir)
-* [get-mlperf-inference-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-src)
-* [get-mlperf-inference-submission-dir](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-submission-dir)
-* [get-mlperf-inference-sut-configs](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-sut-configs)
-* [get-mlperf-inference-sut-description](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-sut-description)
-* [get-mlperf-logging](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-logging)
-* [get-mlperf-power-dev](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-power-dev)
-* [get-mlperf-tiny-eembc-energy-runner-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src)
-* [get-mlperf-tiny-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-tiny-src)
-* [get-mlperf-training-nvidia-code](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-training-nvidia-code)
-* [get-mlperf-training-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-training-src)
-* [get-nvidia-mitten](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-nvidia-mitten)
-* [get-spec-ptd](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-spec-ptd)
-* [import-mlperf-inference-to-experiment](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/import-mlperf-inference-to-experiment)
-* [import-mlperf-tiny-to-experiment](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/import-mlperf-tiny-to-experiment)
-* [import-mlperf-training-to-experiment](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/import-mlperf-training-to-experiment)
-* [install-mlperf-logging-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-mlperf-logging-from-src)
-* [prepare-training-data-bert](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-bert)
-* [prepare-training-data-resnet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-resnet)
-* [preprocess-mlperf-inference-submission](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/preprocess-mlperf-inference-submission)
-* [process-mlperf-accuracy](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/process-mlperf-accuracy)
-* [push-mlperf-inference-results-to-github](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/push-mlperf-inference-results-to-github)
-* [run-mlperf-inference-mobilenet-models](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-mobilenet-models)
-* [run-mlperf-inference-submission-checker](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-submission-checker)
-* [run-mlperf-power-client](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-power-client)
-* [run-mlperf-power-server](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-power-server)
-* [run-mlperf-training-submission-checker](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-training-submission-checker)
-* [truncate-mlperf-inference-accuracy-log](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/truncate-mlperf-inference-accuracy-log)
+* [add-custom-nvidia-system](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/add-custom-nvidia-system)
+* [benchmark-any-mlperf-inference-implementation](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-any-mlperf-inference-implementation)
+* [build-mlperf-inference-server-nvidia](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-mlperf-inference-server-nvidia)
+* [generate-mlperf-inference-submission](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-inference-submission)
+* [generate-mlperf-inference-user-conf](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-inference-user-conf)
+* [generate-mlperf-tiny-report](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-tiny-report)
+* [generate-mlperf-tiny-submission](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-tiny-submission)
+* [generate-nvidia-engine](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-nvidia-engine)
+* [get-mlperf-inference-intel-scratch-space](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-intel-scratch-space)
+* [get-mlperf-inference-loadgen](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-loadgen)
+* [get-mlperf-inference-nvidia-common-code](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-nvidia-common-code)
+* [get-mlperf-inference-nvidia-scratch-space](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space)
+* [get-mlperf-inference-results](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-results)
+* [get-mlperf-inference-results-dir](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-results-dir)
+* [get-mlperf-inference-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-src)
+* [get-mlperf-inference-submission-dir](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-submission-dir)
+* [get-mlperf-inference-sut-configs](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-sut-configs)
+* [get-mlperf-inference-sut-description](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-sut-description)
+* [get-mlperf-logging](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-logging)
+* [get-mlperf-power-dev](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-power-dev)
+* [get-mlperf-tiny-eembc-energy-runner-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src)
+* [get-mlperf-tiny-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-src)
+* [get-mlperf-training-nvidia-code](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-training-nvidia-code)
+* [get-mlperf-training-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-training-src)
+* [get-nvidia-mitten](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-nvidia-mitten)
+* [get-spec-ptd](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-spec-ptd)
+* [import-mlperf-inference-to-experiment](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-inference-to-experiment)
+* [import-mlperf-tiny-to-experiment](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-tiny-to-experiment)
+* [import-mlperf-training-to-experiment](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-training-to-experiment)
+* [install-mlperf-logging-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-mlperf-logging-from-src)
+* [prepare-training-data-bert](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-bert)
+* [prepare-training-data-resnet](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-resnet)
+* [preprocess-mlperf-inference-submission](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/preprocess-mlperf-inference-submission)
+* [process-mlperf-accuracy](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/process-mlperf-accuracy)
+* [push-mlperf-inference-results-to-github](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/push-mlperf-inference-results-to-github)
+* [run-mlperf-inference-mobilenet-models](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-mobilenet-models)
+* [run-mlperf-inference-submission-checker](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-submission-checker)
+* [run-mlperf-power-client](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-power-client)
+* [run-mlperf-power-server](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-power-server)
+* [run-mlperf-training-submission-checker](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-training-submission-checker)
+* [truncate-mlperf-inference-accuracy-log](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/truncate-mlperf-inference-accuracy-log)
### Modular AI/ML application pipeline
-* [app-image-classification-onnx-py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-onnx-py)
-* [app-image-classification-tf-onnx-cpp](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-tf-onnx-cpp)
-* [app-image-classification-torch-py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-torch-py)
-* [app-image-classification-tvm-onnx-py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-tvm-onnx-py)
-* [app-stable-diffusion-onnx-py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-stable-diffusion-onnx-py)
+* [app-image-classification-onnx-py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-onnx-py)
+* [app-image-classification-tf-onnx-cpp](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-tf-onnx-cpp)
+* [app-image-classification-torch-py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-torch-py)
+* [app-image-classification-tvm-onnx-py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-tvm-onnx-py)
+* [app-stable-diffusion-onnx-py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-stable-diffusion-onnx-py)
### Modular MLPerf benchmarks
-* [reproduce-mlperf-inference-intel](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-inference-intel)
-* [reproduce-mlperf-inference-qualcomm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-inference-qualcomm)
+* [app-mlperf-inference-dummy](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-dummy)
+* [app-mlperf-inference-intel](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-intel)
+* [app-mlperf-inference-qualcomm](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-qualcomm)
### Modular MLPerf inference benchmark pipeline
-* [app-loadgen-generic-python](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-loadgen-generic-python)
-* [app-mlperf-inference](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference)
-* [app-mlperf-inference-cpp](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-cpp)
-* [app-mlperf-inference-nvidia](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-nvidia)
-* [app-mlperf-inference-reference](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-reference)
-* [app-mlperf-inference-tflite-cpp](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-tflite-cpp)
-* [benchmark-program-mlperf](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program-mlperf)
-* [run-mlperf-inference-app](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-app)
+* [app-loadgen-generic-python](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-loadgen-generic-python)
+* [app-mlperf-inference](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference)
+* [app-mlperf-inference-ctuning-cpp-tflite](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-ctuning-cpp-tflite)
+* [app-mlperf-inference-mlcommons-cpp](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-mlcommons-cpp)
+* [app-mlperf-inference-mlcommons-python](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-mlcommons-python)
+* [benchmark-program-mlperf](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-program-mlperf)
+* [run-mlperf-inference-app](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-app)
### Modular MLPerf training benchmark pipeline
-* [app-mlperf-training-nvidia](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-nvidia)
-* [app-mlperf-training-reference](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-reference)
+* [app-mlperf-training-nvidia](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-nvidia)
+* [app-mlperf-training-reference](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-reference)
### Modular application pipeline
-* [app-image-corner-detection](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-corner-detection)
+* [app-image-corner-detection](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-corner-detection)
### Platform information
-* [detect-cpu](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
-* [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
+* [detect-cpu](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-cpu)
+* [detect-os](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-os)
### Python automation
-* [activate-python-venv](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/activate-python-venv) *(Activate virtual Python environment)*
-* [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
-* [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
-* [install-generic-conda-package](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-generic-conda-package)
-* [install-python-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-src)
-* [install-python-venv](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-venv)
+* [activate-python-venv](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/activate-python-venv) *(Activate virtual Python environment)*
+* [get-generic-python-lib](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-generic-python-lib)
+* [get-python3](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-python3)
+* [install-generic-conda-package](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-generic-conda-package)
+* [install-python-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-python-src)
+* [install-python-venv](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-python-venv)
### Remote automation
-* [remote-run-commands](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/remote-run-commands)
+* [remote-run-commands](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/remote-run-commands)
### Reproduce MLPerf benchmarks
-* [reproduce-mlperf-inference-nvidia](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-inference-nvidia)
-* [reproduce-mlperf-octoml-tinyml-results](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results)
-* [reproduce-mlperf-training-nvidia](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-training-nvidia)
-* [wrapper-reproduce-octoml-tinyml-submission](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission)
+* [app-mlperf-inference-nvidia](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-nvidia)
+* [reproduce-mlperf-octoml-tinyml-results](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results)
+* [reproduce-mlperf-training-nvidia](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-mlperf-training-nvidia)
+* [wrapper-reproduce-octoml-tinyml-submission](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission)
### Reproducibility and artifact evaluation
-* [get-ipol-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ipol-src)
-* [process-ae-users](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/process-ae-users)
-* [reproduce-ipol-paper-2022-439](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-ipol-paper-2022-439)
-* [reproduce-micro-paper-2023-victima](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-micro-paper-2023-victima)
+* [get-ipol-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ipol-src)
+* [process-ae-users](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/process-ae-users)
+* [reproduce-ipol-paper-2022-439](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-ipol-paper-2022-439)
### Testing libraries and tools
-* [test-onnxruntime-cpp](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-onnxruntime-cpp)
+* [test-onnxruntime-cpp](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-onnxruntime-cpp)
### Tests
-* [print-hello-world](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world)
-* [print-hello-world-java](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-java)
-* [print-hello-world-javac](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-javac)
-* [print-hello-world-py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-py)
-* [print-python-version](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-python-version)
-* [run-python](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-python)
-* [test-abtf-ssd-pytorch](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-abtf-ssd-pytorch)
-* [test-download-and-extract-artifacts](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-download-and-extract-artifacts)
-* [test-set-sys-user-cm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-set-sys-user-cm)
-* [upgrade-python-pip](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/upgrade-python-pip)
+* [print-croissant-desc](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-croissant-desc)
+* [print-hello-world](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world)
+* [print-hello-world-java](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-java)
+* [print-hello-world-javac](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-javac)
+* [print-hello-world-py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-py)
+* [print-python-version](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-python-version)
+* [run-python](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-python)
+* [test-abtf-ssd-pytorch](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-abtf-ssd-pytorch)
+* [test-download-and-extract-artifacts](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-download-and-extract-artifacts)
+* [test-set-sys-user-cm](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-set-sys-user-cm)
+* [upgrade-python-pip](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/upgrade-python-pip)
### TinyML automation
-* [create-fpgaconvnet-app-tinyml](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-fpgaconvnet-app-tinyml)
-* [create-fpgaconvnet-config-tinyml](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-fpgaconvnet-config-tinyml)
-* [flash-tinyml-binary](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/flash-tinyml-binary)
-* [get-microtvm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-microtvm)
-* [get-zephyr](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zephyr)
-* [get-zephyr-sdk](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zephyr-sdk)
+* [create-fpgaconvnet-app-tinyml](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-fpgaconvnet-app-tinyml)
+* [create-fpgaconvnet-config-tinyml](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-fpgaconvnet-config-tinyml)
+* [flash-tinyml-binary](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/flash-tinyml-binary)
+* [get-microtvm](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-microtvm)
+* [get-zephyr](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zephyr)
+* [get-zephyr-sdk](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zephyr-sdk)
# List of all sorted CM scripts
-* [activate-python-venv](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/activate-python-venv) *(Activate virtual Python environment)*
-* [add-custom-nvidia-system](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/add-custom-nvidia-system)
-* [app-image-classification-onnx-py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-onnx-py)
-* [app-image-classification-tf-onnx-cpp](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-tf-onnx-cpp)
-* [app-image-classification-torch-py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-torch-py)
-* [app-image-classification-tvm-onnx-py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-classification-tvm-onnx-py)
-* [app-image-corner-detection](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-corner-detection)
-* [app-loadgen-generic-python](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-loadgen-generic-python)
-* [app-mlperf-inference](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference)
-* [app-mlperf-inference-cpp](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-cpp)
-* [app-mlperf-inference-nvidia](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-nvidia)
-* [app-mlperf-inference-reference](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-reference)
-* [app-mlperf-inference-tflite-cpp](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-inference-tflite-cpp)
-* [app-mlperf-training-nvidia](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-nvidia)
-* [app-mlperf-training-reference](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-mlperf-training-reference)
-* [app-stable-diffusion-onnx-py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-stable-diffusion-onnx-py)
-* [benchmark-any-mlperf-inference-implementation](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-any-mlperf-inference-implementation)
-* [benchmark-object-detection-loadgen](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-object-detection-loadgen)
-* [benchmark-program](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program)
-* [benchmark-program-mlperf](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/benchmark-program-mlperf)
-* [build-docker-image](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-docker-image)
-* [build-dockerfile](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-dockerfile)
-* [build-mlperf-inference-server-nvidia](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/build-mlperf-inference-server-nvidia)
-* [calibrate-model-for.qaic](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/calibrate-model-for.qaic)
-* [compile-model-for.qaic](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/compile-model-for.qaic)
-* [compile-program](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/compile-program)
-* [convert-csv-to-md](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/convert-csv-to-md)
-* [convert-ml-model-huggingface-to-onnx](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/convert-ml-model-huggingface-to-onnx)
-* [copy-to-clipboard](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/copy-to-clipboard)
-* [create-conda-env](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-conda-env)
-* [create-fpgaconvnet-app-tinyml](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-fpgaconvnet-app-tinyml)
-* [create-fpgaconvnet-config-tinyml](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-fpgaconvnet-config-tinyml)
-* [create-patch](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-patch)
-* [destroy-terraform](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/destroy-terraform)
-* [detect-cpu](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
-* [detect-os](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
-* [detect-sudo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-sudo)
-* [download-and-extract](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-and-extract)
-* [download-file](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-file)
-* [download-torrent](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/download-torrent)
-* [dump-pip-freeze](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/dump-pip-freeze)
-* [extract-file](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/extract-file)
-* [fail](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/fail)
-* [flash-tinyml-binary](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/flash-tinyml-binary)
-* [generate-mlperf-inference-submission](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-inference-submission)
-* [generate-mlperf-inference-user-conf](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-inference-user-conf)
-* [generate-mlperf-tiny-report](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-tiny-report)
-* [generate-mlperf-tiny-submission](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-mlperf-tiny-submission)
-* [generate-nvidia-engine](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/generate-nvidia-engine)
-* [get-android-sdk](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-android-sdk)
-* [get-aocl](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-aocl)
-* [get-aws-cli](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-aws-cli)
-* [get-bazel](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-bazel)
-* [get-bert-squad-vocab](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-bert-squad-vocab)
-* [get-blis](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-blis)
-* [get-brew](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-brew)
-* [get-ck](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ck)
-* [get-ck-repo-mlops](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ck-repo-mlops)
-* [get-cl](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cl) *(Detect or install Microsoft C compiler)*
-* [get-cmake](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmake)
-* [get-cmsis_5](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cmsis_5)
-* [get-compiler-flags](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-compiler-flags)
-* [get-compiler-rust](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-compiler-rust)
-* [get-conda](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-conda)
-* [get-cuda](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda)
-* [get-cuda-devices](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cuda-devices)
-* [get-cudnn](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-cudnn)
-* [get-dataset-cifar10](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cifar10)
-* [get-dataset-cnndm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cnndm)
-* [get-dataset-coco](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco)
-* [get-dataset-coco2014](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco2014)
-* [get-dataset-cognata](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-cognata)
-* [get-dataset-criteo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-criteo)
-* [get-dataset-imagenet-aux](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-aux)
-* [get-dataset-imagenet-calibration](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-calibration)
-* [get-dataset-imagenet-helper](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-helper)
-* [get-dataset-imagenet-train](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-train)
-* [get-dataset-imagenet-val](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-imagenet-val)
-* [get-dataset-kits19](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-kits19)
-* [get-dataset-librispeech](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-librispeech)
-* [get-dataset-openimages](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages)
-* [get-dataset-openimages-annotations](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages-annotations)
-* [get-dataset-openimages-calibration](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openimages-calibration)
-* [get-dataset-openorca](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-openorca)
-* [get-dataset-squad](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-squad)
-* [get-dataset-squad-vocab](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-squad-vocab)
-* [get-dlrm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dlrm)
-* [get-dlrm-data-mlperf-inference](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dlrm-data-mlperf-inference)
-* [get-docker](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-docker)
-* [get-gcc](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-gcc) *(Detect or install GCC compiler)*
-* [get-generic-python-lib](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-python-lib)
-* [get-generic-sys-util](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-generic-sys-util)
-* [get-git-repo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-git-repo)
-* [get-github-cli](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-github-cli)
-* [get-go](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-go)
-* [get-google-test](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-google-test)
-* [get-ipol-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ipol-src)
-* [get-java](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-java)
-* [get-javac](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-javac)
-* [get-kilt](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-kilt)
-* [get-lib-armnn](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-armnn)
-* [get-lib-dnnl](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-dnnl)
-* [get-lib-protobuf](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-protobuf)
-* [get-lib-qaic-api](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-lib-qaic-api)
-* [get-llvm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-llvm) *(Detect or install LLVM compiler)*
-* [get-microtvm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-microtvm)
-* [get-ml-model-3d-unet-kits19](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-3d-unet-kits19)
-* [get-ml-model-abtf-ssd-pytorch](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-abtf-ssd-pytorch)
-* [get-ml-model-bert-base-squad](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-bert-base-squad)
-* [get-ml-model-bert-large-squad](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-bert-large-squad)
-* [get-ml-model-dlrm-terabyte](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-dlrm-terabyte)
-* [get-ml-model-efficientnet-lite](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-efficientnet-lite)
-* [get-ml-model-gptj](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-gptj)
-* [get-ml-model-huggingface-zoo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-huggingface-zoo)
-* [get-ml-model-llama2](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-llama2)
-* [get-ml-model-mobilenet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-mobilenet)
-* [get-ml-model-neuralmagic-zoo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-neuralmagic-zoo)
-* [get-ml-model-resnet50](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-resnet50)
-* [get-ml-model-retinanet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-retinanet)
-* [get-ml-model-retinanet-nvidia](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-retinanet-nvidia)
-* [get-ml-model-rnnt](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-rnnt)
-* [get-ml-model-stable-diffusion](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-stable-diffusion)
-* [get-ml-model-tiny-resnet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-tiny-resnet)
-* [get-ml-model-using-imagenet-from-model-zoo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo)
-* [get-mlcommons-croissant](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlcommons-croissant)
-* [get-mlperf-inference-intel-scratch-space](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-intel-scratch-space)
-* [get-mlperf-inference-loadgen](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-loadgen)
-* [get-mlperf-inference-nvidia-common-code](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-common-code)
-* [get-mlperf-inference-nvidia-scratch-space](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space)
-* [get-mlperf-inference-results](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-results)
-* [get-mlperf-inference-results-dir](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-results-dir)
-* [get-mlperf-inference-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-src)
-* [get-mlperf-inference-submission-dir](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-submission-dir)
-* [get-mlperf-inference-sut-configs](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-sut-configs)
-* [get-mlperf-inference-sut-description](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-sut-description)
-* [get-mlperf-inference-utils](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-inference-utils)
-* [get-mlperf-logging](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-logging)
-* [get-mlperf-power-dev](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-power-dev)
-* [get-mlperf-tiny-eembc-energy-runner-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src)
-* [get-mlperf-tiny-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-tiny-src)
-* [get-mlperf-training-nvidia-code](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-training-nvidia-code)
-* [get-mlperf-training-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-mlperf-training-src)
-* [get-nvidia-docker](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-nvidia-docker)
-* [get-nvidia-mitten](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-nvidia-mitten)
-* [get-onnxruntime-prebuilt](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-onnxruntime-prebuilt)
-* [get-openssl](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-openssl)
-* [get-preprocessed-dataset-criteo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-criteo)
-* [get-preprocessed-dataset-imagenet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-imagenet)
-* [get-preprocessed-dataset-kits19](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-kits19)
-* [get-preprocessed-dataset-librispeech](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-librispeech)
-* [get-preprocessed-dataset-openimages](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-openimages)
-* [get-preprocessed-dataset-openorca](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-openorca)
-* [get-preprocessed-dataset-squad](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocessed-dataset-squad)
-* [get-preprocesser-script-generic](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-preprocesser-script-generic)
-* [get-python3](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
-* [get-qaic-apps-sdk](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-apps-sdk)
-* [get-qaic-platform-sdk](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-platform-sdk)
-* [get-qaic-software-kit](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-qaic-software-kit)
-* [get-rclone](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-rclone)
-* [get-rocm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-rocm)
-* [get-spec-ptd](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-spec-ptd)
-* [get-sys-utils-cm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm)
-* [get-sys-utils-min](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-min)
-* [get-target-device](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-target-device)
-* [get-tensorrt](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tensorrt)
-* [get-terraform](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-terraform)
-* [get-tvm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tvm)
-* [get-tvm-model](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-tvm-model)
-* [get-xilinx-sdk](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-xilinx-sdk)
-* [get-zendnn](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zendnn)
-* [get-zephyr](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zephyr)
-* [get-zephyr-sdk](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-zephyr-sdk)
-* [gui](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/gui)
-* [import-mlperf-inference-to-experiment](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/import-mlperf-inference-to-experiment)
-* [import-mlperf-tiny-to-experiment](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/import-mlperf-tiny-to-experiment)
-* [import-mlperf-training-to-experiment](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/import-mlperf-training-to-experiment)
-* [install-aws-cli](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-aws-cli)
-* [install-bazel](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-bazel)
-* [install-cmake-prebuilt](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cmake-prebuilt)
-* [install-cuda-package-manager](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cuda-package-manager)
-* [install-cuda-prebuilt](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-cuda-prebuilt)
-* [install-gcc-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-gcc-src)
-* [install-generic-conda-package](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-generic-conda-package)
-* [install-gflags](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-gflags)
-* [install-github-cli](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-github-cli)
-* [install-ipex-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-ipex-from-src) *(Build IPEX from sources)*
-* [install-llvm-prebuilt](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-llvm-prebuilt) *(Install prebuilt LLVM compiler)*
-* [install-llvm-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-llvm-src) *(Build LLVM compiler from sources (can take >30 min))*
-* [install-mlperf-logging-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-mlperf-logging-from-src)
-* [install-nccl-libs](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-nccl-libs)
-* [install-onednn-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-onednn-from-src) *(Build oneDNN from sources)*
-* [install-onnxruntime-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-onnxruntime-from-src) *(Build onnxruntime from sources)*
-* [install-openssl](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-openssl)
-* [install-pip-package-for-cmind-python](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-pip-package-for-cmind-python)
-* [install-python-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-src)
-* [install-python-venv](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-venv)
-* [install-pytorch-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-pytorch-from-src) *(Build pytorch from sources)*
-* [install-pytorch-kineto-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-pytorch-kineto-from-src) *(Build pytorch kineto from sources)*
-* [install-qaic-compute-sdk-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-qaic-compute-sdk-from-src)
-* [install-rocm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-rocm)
-* [install-tensorflow-for-c](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tensorflow-for-c)
-* [install-tensorflow-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tensorflow-from-src)
-* [install-terraform-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-terraform-from-src)
-* [install-tflite-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-tflite-from-src)
-* [install-transformers-from-src](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-transformers-from-src) *(Build transformers from sources)*
-* [launch-benchmark](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/launch-benchmark)
-* [prepare-training-data-bert](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-bert)
-* [prepare-training-data-resnet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prepare-training-data-resnet)
-* [preprocess-mlperf-inference-submission](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/preprocess-mlperf-inference-submission)
-* [print-hello-world](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world)
-* [print-hello-world-java](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-java)
-* [print-hello-world-javac](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-javac)
-* [print-hello-world-py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-hello-world-py)
-* [print-python-version](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/print-python-version)
-* [process-ae-users](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/process-ae-users)
-* [process-mlperf-accuracy](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/process-mlperf-accuracy)
-* [prune-bert-models](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/prune-bert-models)
-* [publish-results-to-dashboard](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/publish-results-to-dashboard)
-* [pull-git-repo](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/pull-git-repo)
-* [push-csv-to-spreadsheet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/push-csv-to-spreadsheet)
-* [push-mlperf-inference-results-to-github](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/push-mlperf-inference-results-to-github)
-* [remote-run-commands](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/remote-run-commands)
-* [reproduce-ipol-paper-2022-439](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-ipol-paper-2022-439)
-* [reproduce-micro-paper-2023-victima](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-micro-paper-2023-victima)
-* [reproduce-mlperf-inference-intel](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-inference-intel)
-* [reproduce-mlperf-inference-nvidia](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-inference-nvidia)
-* [reproduce-mlperf-inference-qualcomm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-inference-qualcomm)
-* [reproduce-mlperf-octoml-tinyml-results](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results)
-* [reproduce-mlperf-training-nvidia](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/reproduce-mlperf-training-nvidia)
-* [run-docker-container](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-docker-container)
-* [run-mlperf-inference-app](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-app)
-* [run-mlperf-inference-mobilenet-models](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-mobilenet-models)
-* [run-mlperf-inference-submission-checker](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-inference-submission-checker)
-* [run-mlperf-power-client](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-power-client)
-* [run-mlperf-power-server](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-power-server)
-* [run-mlperf-training-submission-checker](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-mlperf-training-submission-checker)
-* [run-python](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-python)
-* [run-terraform](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/run-terraform)
-* [save-mlperf-inference-implementation-state](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/save-mlperf-inference-implementation-state)
-* [set-device-settings-qaic](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-device-settings-qaic)
-* [set-echo-off-win](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-echo-off-win)
-* [set-performance-mode](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-performance-mode)
-* [set-sqlite-dir](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/set-sqlite-dir)
-* [tar-my-folder](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/tar-my-folder)
-* [test-abtf-ssd-pytorch](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-abtf-ssd-pytorch)
-* [test-download-and-extract-artifacts](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-download-and-extract-artifacts)
-* [test-mlperf-inference-retinanet](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-mlperf-inference-retinanet)
-* [test-onnxruntime-cpp](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-onnxruntime-cpp)
-* [test-set-sys-user-cm](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/test-set-sys-user-cm)
-* [truncate-mlperf-inference-accuracy-log](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/truncate-mlperf-inference-accuracy-log)
-* [upgrade-python-pip](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/upgrade-python-pip)
-* [wrapper-reproduce-octoml-tinyml-submission](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission)
+* [activate-python-venv](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/activate-python-venv) *(Activate virtual Python environment.)*
+* [add-custom-nvidia-system](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/add-custom-nvidia-system)
+* [app-image-classification-onnx-py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-onnx-py)
+* [app-image-classification-tf-onnx-cpp](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-tf-onnx-cpp)
+* [app-image-classification-torch-py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-torch-py)
+* [app-image-classification-tvm-onnx-py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-classification-tvm-onnx-py)
+* [app-image-corner-detection](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-image-corner-detection)
+* [app-loadgen-generic-python](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-loadgen-generic-python)
+* [app-mlperf-inference](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference)
+* [app-mlperf-inference-ctuning-cpp-tflite](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-ctuning-cpp-tflite)
+* [app-mlperf-inference-dummy](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-dummy)
+* [app-mlperf-inference-intel](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-intel)
+* [app-mlperf-inference-mlcommons-cpp](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-mlcommons-cpp)
+* [app-mlperf-inference-mlcommons-python](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-mlcommons-python)
+* [app-mlperf-inference-nvidia](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-nvidia)
+* [app-mlperf-inference-qualcomm](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-inference-qualcomm)
+* [app-mlperf-training-nvidia](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-nvidia)
+* [app-mlperf-training-reference](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-mlperf-training-reference)
+* [app-stable-diffusion-onnx-py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/app-stable-diffusion-onnx-py)
+* [benchmark-any-mlperf-inference-implementation](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-any-mlperf-inference-implementation)
+* [benchmark-program](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-program)
+* [benchmark-program-mlperf](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/benchmark-program-mlperf)
+* [build-docker-image](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-docker-image)
+* [build-dockerfile](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-dockerfile)
+* [build-mlperf-inference-server-nvidia](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/build-mlperf-inference-server-nvidia)
+* [calibrate-model-for.qaic](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/calibrate-model-for.qaic)
+* [compile-model-for.qaic](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/compile-model-for.qaic)
+* [compile-program](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/compile-program)
+* [convert-csv-to-md](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/convert-csv-to-md)
+* [convert-ml-model-huggingface-to-onnx](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/convert-ml-model-huggingface-to-onnx)
+* [copy-to-clipboard](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/copy-to-clipboard)
+* [create-conda-env](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-conda-env)
+* [create-fpgaconvnet-app-tinyml](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-fpgaconvnet-app-tinyml)
+* [create-fpgaconvnet-config-tinyml](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-fpgaconvnet-config-tinyml)
+* [create-patch](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/create-patch)
+* [destroy-terraform](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/destroy-terraform)
+* [detect-cpu](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-cpu)
+* [detect-os](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-os)
+* [detect-sudo](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/detect-sudo)
+* [download-and-extract](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-and-extract)
+* [download-file](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-file)
+* [download-torrent](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/download-torrent)
+* [dump-pip-freeze](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/dump-pip-freeze)
+* [extract-file](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/extract-file)
+* [fail](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/fail)
+* [flash-tinyml-binary](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/flash-tinyml-binary)
+* [generate-mlperf-inference-submission](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-inference-submission)
+* [generate-mlperf-inference-user-conf](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-inference-user-conf)
+* [generate-mlperf-tiny-report](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-tiny-report)
+* [generate-mlperf-tiny-submission](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-mlperf-tiny-submission)
+* [generate-nvidia-engine](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/generate-nvidia-engine)
+* [get-android-sdk](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-android-sdk)
+* [get-aocl](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-aocl)
+* [get-aws-cli](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-aws-cli)
+* [get-bazel](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-bazel)
+* [get-bert-squad-vocab](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-bert-squad-vocab)
+* [get-blis](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-blis)
+* [get-brew](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-brew)
+* [get-ck](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ck)
+* [get-ck-repo-mlops](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ck-repo-mlops)
+* [get-cl](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cl) *(Detect or install Microsoft C compiler.)*
+* [get-cmake](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cmake)
+* [get-cmsis_5](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cmsis_5)
+* [get-compiler-flags](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-compiler-flags)
+* [get-compiler-rust](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-compiler-rust)
+* [get-conda](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-conda)
+* [get-croissant](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-croissant)
+* [get-cuda](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cuda)
+* [get-cuda-devices](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cuda-devices)
+* [get-cudnn](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-cudnn)
+* [get-dataset-cifar10](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cifar10)
+* [get-dataset-cnndm](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cnndm)
+* [get-dataset-coco](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-coco)
+* [get-dataset-coco2014](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-coco2014)
+* [get-dataset-cognata](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-cognata)
+* [get-dataset-criteo](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-criteo)
+* [get-dataset-imagenet-aux](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-aux)
+* [get-dataset-imagenet-calibration](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-calibration)
+* [get-dataset-imagenet-helper](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-helper)
+* [get-dataset-imagenet-train](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-train)
+* [get-dataset-imagenet-val](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-imagenet-val)
+* [get-dataset-kits19](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-kits19)
+* [get-dataset-librispeech](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-librispeech)
+* [get-dataset-openimages](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages)
+* [get-dataset-openimages-annotations](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages-annotations)
+* [get-dataset-openimages-calibration](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openimages-calibration)
+* [get-dataset-openorca](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-openorca)
+* [get-dataset-squad](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-squad)
+* [get-dataset-squad-vocab](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dataset-squad-vocab)
+* [get-dlrm](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dlrm)
+* [get-dlrm-data-mlperf-inference](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-dlrm-data-mlperf-inference)
+* [get-docker](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-docker)
+* [get-gcc](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-gcc) *(Detect or install GCC compiler.)*
+* [get-generic-python-lib](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-generic-python-lib)
+* [get-generic-sys-util](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-generic-sys-util)
+* [get-git-repo](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-git-repo)
+* [get-github-cli](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-github-cli)
+* [get-go](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-go)
+* [get-google-saxml](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-google-saxml)
+* [get-google-test](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-google-test)
+* [get-ipol-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ipol-src)
+* [get-java](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-java)
+* [get-javac](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-javac)
+* [get-lib-armnn](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-armnn)
+* [get-lib-dnnl](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-dnnl)
+* [get-lib-protobuf](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-protobuf)
+* [get-lib-qaic-api](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-lib-qaic-api)
+* [get-llvm](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-llvm) *(Detect or install LLVM compiler.)*
+* [get-microtvm](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-microtvm)
+* [get-ml-model-3d-unet-kits19](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-3d-unet-kits19)
+* [get-ml-model-abtf-ssd-pytorch](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-abtf-ssd-pytorch)
+* [get-ml-model-bert-base-squad](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-bert-base-squad)
+* [get-ml-model-bert-large-squad](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-bert-large-squad)
+* [get-ml-model-dlrm-terabyte](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-dlrm-terabyte)
+* [get-ml-model-efficientnet-lite](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-efficientnet-lite)
+* [get-ml-model-gptj](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-gptj)
+* [get-ml-model-huggingface-zoo](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-huggingface-zoo)
+* [get-ml-model-llama2](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-llama2)
+* [get-ml-model-mobilenet](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-mobilenet)
+* [get-ml-model-neuralmagic-zoo](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-neuralmagic-zoo)
+* [get-ml-model-resnet50](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-resnet50)
+* [get-ml-model-retinanet](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-retinanet)
+* [get-ml-model-retinanet-nvidia](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-retinanet-nvidia)
+* [get-ml-model-rnnt](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-rnnt)
+* [get-ml-model-stable-diffusion](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-stable-diffusion)
+* [get-ml-model-tiny-resnet](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-tiny-resnet)
+* [get-ml-model-using-imagenet-from-model-zoo](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-ml-model-using-imagenet-from-model-zoo)
+* [get-mlperf-inference-intel-scratch-space](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-intel-scratch-space)
+* [get-mlperf-inference-loadgen](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-loadgen)
+* [get-mlperf-inference-nvidia-common-code](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-nvidia-common-code)
+* [get-mlperf-inference-nvidia-scratch-space](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-nvidia-scratch-space)
+* [get-mlperf-inference-results](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-results)
+* [get-mlperf-inference-results-dir](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-results-dir)
+* [get-mlperf-inference-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-src)
+* [get-mlperf-inference-submission-dir](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-submission-dir)
+* [get-mlperf-inference-sut-configs](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-sut-configs)
+* [get-mlperf-inference-sut-description](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-sut-description)
+* [get-mlperf-inference-utils](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-inference-utils)
+* [get-mlperf-logging](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-logging)
+* [get-mlperf-power-dev](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-power-dev)
+* [get-mlperf-tiny-eembc-energy-runner-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-eembc-energy-runner-src)
+* [get-mlperf-tiny-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-tiny-src)
+* [get-mlperf-training-nvidia-code](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-training-nvidia-code)
+* [get-mlperf-training-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-mlperf-training-src)
+* [get-nvidia-docker](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-nvidia-docker)
+* [get-nvidia-mitten](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-nvidia-mitten)
+* [get-onnxruntime-prebuilt](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-onnxruntime-prebuilt)
+* [get-openssl](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-openssl)
+* [get-preprocessed-dataset-criteo](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-criteo)
+* [get-preprocessed-dataset-imagenet](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-imagenet)
+* [get-preprocessed-dataset-kits19](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-kits19)
+* [get-preprocessed-dataset-librispeech](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-librispeech)
+* [get-preprocessed-dataset-openimages](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-openimages)
+* [get-preprocessed-dataset-openorca](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-openorca)
+* [get-preprocessed-dataset-squad](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocessed-dataset-squad)
+* [get-preprocesser-script-generic](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-preprocesser-script-generic)
+* [get-python3](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-python3)
+* [get-qaic-apps-sdk](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-apps-sdk)
+* [get-qaic-platform-sdk](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-platform-sdk)
+* [get-qaic-software-kit](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-qaic-software-kit)
+* [get-rclone](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-rclone)
+* [get-rocm](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-rocm)
+* [get-spec-ptd](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-spec-ptd)
+* [get-sys-utils-cm](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-cm)
+* [get-sys-utils-min](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-sys-utils-min)
+* [get-target-device](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-target-device)
+* [get-tensorrt](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tensorrt)
+* [get-terraform](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-terraform)
+* [get-tvm](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tvm)
+* [get-tvm-model](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-tvm-model)
+* [get-xilinx-sdk](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-xilinx-sdk)
+* [get-zendnn](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zendnn)
+* [get-zephyr](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zephyr)
+* [get-zephyr-sdk](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/get-zephyr-sdk)
+* [gui](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/gui)
+* [import-mlperf-inference-to-experiment](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-inference-to-experiment)
+* [import-mlperf-tiny-to-experiment](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-tiny-to-experiment)
+* [import-mlperf-training-to-experiment](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/import-mlperf-training-to-experiment)
+* [install-aws-cli](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-aws-cli)
+* [install-bazel](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-bazel)
+* [install-cmake-prebuilt](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cmake-prebuilt)
+* [install-cuda-package-manager](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cuda-package-manager)
+* [install-cuda-prebuilt](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-cuda-prebuilt)
+* [install-gcc-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-gcc-src)
+* [install-generic-conda-package](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-generic-conda-package)
+* [install-gflags](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-gflags)
+* [install-github-cli](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-github-cli)
+* [install-ipex-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-ipex-from-src) *(Build IPEX from sources.)*
+* [install-llvm-prebuilt](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-llvm-prebuilt) *(Install prebuilt LLVM compiler.)*
+* [install-llvm-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-llvm-src) *(Build LLVM compiler from sources (can take >30 min).)*
+* [install-mlperf-logging-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-mlperf-logging-from-src)
+* [install-nccl-libs](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-nccl-libs)
+* [install-numactl-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-numactl-from-src) *(Build numactl from sources.)*
+* [install-onednn-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-onednn-from-src) *(Build oneDNN from sources.)*
+* [install-onnxruntime-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-onnxruntime-from-src) *(Build onnxruntime from sources.)*
+* [install-openssl](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-openssl)
+* [install-pip-package-for-cmind-python](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pip-package-for-cmind-python)
+* [install-python-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-python-src)
+* [install-python-venv](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-python-venv)
+* [install-pytorch-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pytorch-from-src) *(Build pytorch from sources.)*
+* [install-pytorch-kineto-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-pytorch-kineto-from-src) *(Build pytorch kineto from sources.)*
+* [install-qaic-compute-sdk-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-qaic-compute-sdk-from-src)
+* [install-rocm](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-rocm)
+* [install-tensorflow-for-c](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tensorflow-for-c)
+* [install-tensorflow-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tensorflow-from-src)
+* [install-terraform-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-terraform-from-src)
+* [install-tflite-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tflite-from-src)
+* [install-torchvision-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-torchvision-from-src) *(Build pytorchvision from sources.)*
+* [install-tpp-pytorch-extension](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-tpp-pytorch-extension) *(Build TPP-PEX from sources.)*
+* [install-transformers-from-src](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/install-transformers-from-src) *(Build transformers from sources.)*
+* [launch-benchmark](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/launch-benchmark)
+* [prepare-training-data-bert](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-bert)
+* [prepare-training-data-resnet](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prepare-training-data-resnet)
+* [preprocess-mlperf-inference-submission](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/preprocess-mlperf-inference-submission)
+* [print-croissant-desc](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-croissant-desc)
+* [print-hello-world](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world)
+* [print-hello-world-java](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-java)
+* [print-hello-world-javac](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-javac)
+* [print-hello-world-py](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-hello-world-py)
+* [print-python-version](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/print-python-version)
+* [process-ae-users](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/process-ae-users)
+* [process-mlperf-accuracy](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/process-mlperf-accuracy)
+* [prune-bert-models](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/prune-bert-models)
+* [publish-results-to-dashboard](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/publish-results-to-dashboard)
+* [pull-git-repo](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/pull-git-repo)
+* [push-csv-to-spreadsheet](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/push-csv-to-spreadsheet)
+* [push-mlperf-inference-results-to-github](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/push-mlperf-inference-results-to-github)
+* [remote-run-commands](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/remote-run-commands)
+* [reproduce-ipol-paper-2022-439](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-ipol-paper-2022-439)
+* [reproduce-mlperf-octoml-tinyml-results](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-mlperf-octoml-tinyml-results)
+* [reproduce-mlperf-training-nvidia](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/reproduce-mlperf-training-nvidia)
+* [run-docker-container](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-docker-container)
+* [run-mlperf-inference-app](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-app)
+* [run-mlperf-inference-mobilenet-models](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-mobilenet-models)
+* [run-mlperf-inference-submission-checker](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-inference-submission-checker)
+* [run-mlperf-power-client](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-power-client)
+* [run-mlperf-power-server](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-power-server)
+* [run-mlperf-training-submission-checker](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-mlperf-training-submission-checker)
+* [run-python](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-python)
+* [run-terraform](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/run-terraform)
+* [save-mlperf-inference-implementation-state](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/save-mlperf-inference-implementation-state)
+* [set-device-settings-qaic](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-device-settings-qaic)
+* [set-echo-off-win](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-echo-off-win)
+* [set-performance-mode](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-performance-mode)
+* [set-sqlite-dir](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/set-sqlite-dir)
+* [tar-my-folder](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/tar-my-folder)
+* [test-abtf-ssd-pytorch](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-abtf-ssd-pytorch)
+* [test-download-and-extract-artifacts](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-download-and-extract-artifacts)
+* [test-mlperf-inference-retinanet](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-mlperf-inference-retinanet)
+* [test-onnxruntime-cpp](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-onnxruntime-cpp)
+* [test-set-sys-user-cm](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/test-set-sys-user-cm)
+* [truncate-mlperf-inference-accuracy-log](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/truncate-mlperf-inference-accuracy-log)
+* [upgrade-python-pip](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/upgrade-python-pip)
+* [wrapper-reproduce-octoml-tinyml-submission](https://github.com/mlcommons/ck/tree/dev/cm-mlops/script/wrapper-reproduce-octoml-tinyml-submission)
diff --git a/docs/taskforce.md b/docs/taskforce.md
index 72de0fc047..38cf31a163 100644
--- a/docs/taskforce.md
+++ b/docs/taskforce.md
@@ -2,8 +2,8 @@
# MLCommons Task force on Automation and Reproducibility
-***Announcement: we are peparing new tasks for Q2-Q3 2024 with MLCommons and looking for volunteers and another co-chair.
- [Get in touch](mailto:gfursin@cknowledge.org) for more details!***
+***Announcement: we are peparing new tasks for Q2-Q3 2024 with MLCommons and looking for volunteers and an extra co-chair.
+ Please get in touch via [email](mailto:gfursin@cknowledge.org) or [Discord](https://discord.gg/JjWNWXKxwT) for more details!***
## Mission