Updating auto-generated CM scripts READMEs based on user feedback

COPYRIGHT.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2021-2023 MLCommons
+Copyright (c) 2021-2024 MLCommons
 
 cTuning foundation and OctoML donated this project to MLCommons to benefit everyone.
 

LICENSE.md

@@ -174,3 +174,4 @@
       of your accepting any such warranty or additional liability.
 
    END OF TERMS AND CONDITIONS
+

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"
 

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)

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)

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: