- added automatic CM repo alias from mlcommons@ck to mlcommons@cm4mlops

     unless branch and checkout are used!
- improved CM python package API generation and uploaded to https://cknowledge.org/docs/cm
     (should move to MLCommons when ready)

cm/CHANGES.md

@@ -1,4 +1,8 @@
-## V2.2.0.1
+## V2.3.0
+   - added automatic CM repo alias from mlcommons@ck to mlcommons@cm4mlops 
+     unless branch and checkout are used!
+   - improved CM python package API generation and uploaded to https://cknowledge.org/docs/cm 
+     (should move to MLCommons when ready)
    - added timezone to utils.get_current_date_time to correctly time stamp various experiments!
 
 ## V2.2.0

cm/cmind/__init__.py

@@ -2,7 +2,7 @@
 #
 # Written by Grigori Fursin
 
-__version__ = "2.2.0.1"
+__version__ = "2.3.0"
 
 from cmind.core import access
 from cmind.core import error

docs/README.md

@@ -1,19 +1,20 @@
 # CM documentation
 
-**We plan to rewrite and simplify the CM documentation and tutorials based on user feedback in Q2 2024 - please stay tuned for more details**.
+**We plan to rewrite and simplify the CM documentation and tutorials based on user feedback in Q3 2024 - please stay tuned for more details**.
 
 Collective Mind (CM) is a lightweight, non-intrusive and technology-agnostic workflow automation framework 
 being developed by the [MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
 based on the feedback from the [the community, MLCommons members and individual contributors](CONTRIBUTING.md).
 
-The goal is to provide a common, simple and human-readable interface to manage, run, reproduce 
-and customize diverse AI/ML apps, benchmarks and research projects across continuously changing
-models, datasets, software and hardware from different vendors in a unified and automated way.
+The goal is to provide a common, simple and human-readable interface to help users encode their knowledge
+about how to build, run and customize diverse AI/ML apps, benchmarks and research projects across 
+continuously changing models, datasets, software and hardware from different vendors in a unified and automated way.
 
 * [Getting Started Guide and FAQ](getting-started.md)
 * [Introduction](introduction-cm.md)
 * [CM installation and customization](installation.md)
 * [Unified CLI and Python API](interface.md)
+  * [CM framework core API](https://cknowledge.org/docs/cm)
   * [CM "script" automation](https://github.com/mlcommons/ck/blob/master/cm-mlops/automation/script/README-extra.md)
   * [CM "cache" automation](https://github.com/mlcommons/ck/blob/master/cm-mlops/automation/cache/README-extra.md)
   * [CM "experiment" automation](https://github.com/mlcommons/ck/blob/master/cm-mlops/automation/experiment/README-extra.md)

docs/_generator/api/conf.py

@@ -23,8 +23,8 @@
 
 # -- Project information -----------------------------------------------------
 
-project = u'Collective Mind'
-copyright = u'2022 MLCommons'
+project = u'Collective Mind (CM)'
+copyright = u'2022-2024 MLCommons'
 author = u'Grigori Fursin'
 
 version=''
@@ -101,7 +101,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+# language = 
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -244,4 +244,5 @@
 autoclass_content = 'both'
 
 def setup(app):
-    app.add_stylesheet('css/custom.css') 
+#    app.add_stylesheet('css/custom.css') 
+    app.add_css_file('css/custom.css')

docs/_generator/api/generate.bat

@@ -4,7 +4,7 @@ rd /Q /S api
 
 sphinx-apidoc -f -T -o api ../../../cm/cmind
 
-cm replace_string_in_file utils --input=api/cmind.rst --string="cmind package" --replacement="CM API"
+cm replace_string_in_file utils --input=api/cmind.rst --string="cmind package" --replacement="CM python package API"
 
 sphinx-build -M html . api
 

docs/_generator/api/generate.sh

@@ -1,6 +1,6 @@
 rm -rf api
 
-sphinx-apidoc -H "CM API" -f -T -o api ../../../cm/cmind
+sphinx-apidoc -H "CM python package API" -f -T -o api ../../../cm/cmind
 
 sphinx-build -M html . api
 

docs/_generator/api/index.rst

@@ -1,4 +1,4 @@
-.. Copyright 2022 MLCommons
+.. Copyright 2021-2024 MLCommons
 
 .. CM documentation master file
 

docs/_generator/generate_api.bat

@@ -1,2 +1,4 @@
+pip install sphinx recommonmark sphinx_markdown_tables sphinx_rtd_theme
+
 cd api
 generate.bat

docs/_generator/generate_api.sh

@@ -1,2 +1,4 @@
+pip install sphinx recommonmark sphinx_markdown_tables sphinx_rtd_theme
+
 cd api
 ./generate.sh

docs/debugging.md

@@ -19,4 +19,11 @@ When running MLPerf and other benchmarks, you can often use the `--debug` flag t
 start a shell with all environment variables prepared to run/debug the final OS command manually.
 You can also use GDB via environment variable `--env.CM_RUN_PREFIX="gdb --args "`
 
+## Visual Studio Code
 
+You can debug CM scripts using Visual Studio Code. See the [test-debug](https://github.com/mlcommons/cm4mlops/tree/main/script/test-debug) CM script 
+for a demo:
+
+* Debug CM internals and customize.py using [python entry point](https://github.com/mlcommons/cm4mlops/blob/main/script/test-debug/_demo.py#L8)
+* Debug native python code wrapped by CM scripts using CM break points: [code](https://github.com/mlcommons/cm4mlops/blob/main/script/test-debug/python/main.py#L18), 
+  [README](https://github.com/mlcommons/cm4mlops/blob/main/script/test-debug/README-extra.md)