improved script docs, faq, python venv and added ACM/NISO terminology…

… for Repeatability, Reproducibility and Replicability

README.md

@@ -39,7 +39,7 @@ It consists of the following sub-projects:
 * [Collective Knowledge platform (MLCommons CK playground)](platform) 
   aggregates [reproducible experiments](https://access.cknowledge.org/playground/?action=experiments) 
   in the CM format, connects academia and industry to 
-  [organize reproducibility and optimization challenges]( https://github.com/mlcommons/ck/tree/master/cm-mlops/challenge ),
+  [organize reproducibility, replicability and optimization challenges]( https://github.com/mlcommons/ck/tree/master/cm-mlops/challenge ),
   and help developers and users select Pareto-optimal end-to-end applications and systems based on their requirements and constraints
   (cost, performance, power consumption, accuracy, etc).
 

cm-mlops/automation/cache/README.md

@@ -1,4 +1,4 @@
-*This README is automatically generated - don't edit! Use `README-extra.md` for extra notes!*
+*This README is automatically generated - don't edit! See [extra README](README-extra.md) for extra notes!*
 
 ### Automation actions
 
@@ -44,4 +44,4 @@
 
 ### Maintainers
 
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/mlperf-education-workgroup.md)
+* [Open MLCommons taskforce on automation and reproducibility](https://cKnowledge.org/mlcommons-taskforce)

cm-mlops/automation/challenge/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 challenge``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/challenge/module.py#L15))
+  * CM CLI with UID: ```cm test challenge,3d84abd768f34e08``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/challenge/module.py#L15))
+  * CM Python API:
+    ```python
+    import cmind
+
+    r=cm.access({
+                 'action':'test'
+                 'automation':'challenge,3d84abd768f34e08'
+                 'out':'con'
+    ```
+    [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/challenge/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/contributor/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 contributor``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/contributor/module.py#L15))
+  * CM CLI with UID: ```cm test contributor,68eae17b590d4f8f``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/contributor/module.py#L15))
+  * CM Python API:
+    ```python
+    import cmind
+
+    r=cm.access({
+                 'action':'test'
+                 'automation':'contributor,68eae17b590d4f8f'
+                 'out':'con'
+    ```
+    [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/contributor/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/docker/README.md

@@ -24,4 +24,4 @@
 
 ### Maintainers
 
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/mlperf-education-workgroup.md)
+* [Open MLCommons taskforce on automation and reproducibility](https://cKnowledge.org/mlcommons-taskforce)

cm-mlops/automation/experiment/README.md

@@ -64,4 +64,4 @@
 
 ### Maintainers
 
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/mlperf-education-workgroup.md)
+* [Open MLCommons taskforce on automation and reproducibility](https://cKnowledge.org/mlcommons-taskforce)

cm-mlops/automation/project/README.md

@@ -24,4 +24,4 @@
 
 ### Maintainers
 
-* [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/mlperf-education-workgroup.md)
+* [Open MLCommons taskforce on automation and reproducibility](https://cKnowledge.org/mlcommons-taskforce)

cm-mlops/automation/report/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 report``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/report/module.py#L15))
+  * CM CLI with UID: ```cm test report,6462ecdba2054467``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/report/module.py#L15))
+  * CM Python API:
+    ```python
+    import cmind
+
+    r=cm.access({
+                 'action':'test'
+                 'automation':'report,6462ecdba2054467'
+                 'out':'con'
+    ```
+    [add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/report/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/script/README-extra.md

@@ -511,7 +511,7 @@ to [detect or install/build Python interpreter](https://github.com/mlcommons/ck/
 This script exposes a number of environment variables for a detected Python
 in the [`postprocess` function](https://github.com/mlcommons/ck/blob/master/cm-mlops/script/get-python3/customize.py#L60):
 
-* `CM_PYTHON_BIN` - python3.10 or python.exe or any other name of a Python interpreteur on a given system
+* `CM_PYTHON_BIN` - python3.10 or python.exe or any other name of a Python interpreter on a given system
 * `CM_PYTHON_BIN_PATH` - path to a detected or installed python
 * `CM_PYTHON_BIN_WITH_PATH` - full path to a detected or installed python
 * `LD_LIBRARY_PATH` - updated LD_LIBRARY_PATH to python
@@ -573,7 +573,7 @@ You can see the cached files as follows:
 ls `cm find cache --tags=get,python`
 ```
 
-* _cm.json - CM meta description of this "cache" artifact with its uniqie ID, tags and other meta information
+* _cm.json - CM meta description of this "cache" artifact with its unique ID, tags and other meta information
 * cm-cached-state.json - dictionary with the new environment variables and the new state dictionary
 * tmp-env-all.sh - all environment variables used during CM script execution
 * tmp-env.sh - only new environment variables produced after CM script execution (it can be used directly by external tools)
@@ -609,7 +609,7 @@ as shown in the next example.
 
 ### Assembling pipeline to compile and run image corner detection
 
-We can use automatically detected compiler from CM script to create simple and technology-netural compilation and execution pipelines
+We can use automatically detected compiler from CM script to create simple and technology-neutral compilation and execution pipelines
 in CM scripts. 
 
 For example, we have implemented a simple [image corner detection CM script]( https://github.com/mlcommons/ck/tree/master/cm-mlops/script/app-image-corner-detection )
@@ -652,7 +652,7 @@ Note that this directory also contains the compiled tool "image-corner" that can
 ### Customizing sub-dependencies in a pipeline
 
 When running a CM script with many sub-dependencies similar to above example, 
-we may want to specify some version constaints on sub-dependencies such as LLVM.
+we may want to specify some version constraints on sub-dependencies such as LLVM.
 
 One can use the key `"names"` in the "deps" list of any CM script meta description
 to specify multiple names for a given dependency. 
@@ -687,7 +687,7 @@ cm run script "install python-venv" --name={some name}
 ```
 
 CM will create a virtual environment using default Python and save it in CM cache. 
-It is possible to create a python virutal environment with any version on Linux and MacOS as follows:
+It is possible to create a python virtual environment with any version on Linux and MacOS as follows:
 
 ```bash
 cm run script "install python-venv" --version=3.10.8 --name=mlperf
@@ -861,7 +861,7 @@ that's why we called our project "Collective Knowledge".
 
 ### Detecting, installing and caching system dependencies
 
-Many projects require installation of some system dependencies. Unfortuantely, the procedure
+Many projects require installation of some system dependencies. Unfortunately, the procedure
 is different across different systems. 
 
 That's why we have developed two other CM script to unify and automate this process on any system.