Skip to content

Commit 1279009

Browse files
gfursingfursin
authored
minor docs update (#1394)
2 parents ab7b4e6 + 1196f71 commit 1279009

File tree

10 files changed

+109
-52
lines changed

10 files changed

+109
-52
lines changed

‎CONTRIBUTORS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,13 @@ to benefit everyone. Since then, this open-source automation technology
66
as a community effort thanks to all our volunteers, collaborators
77
and contributors listed here in alphabetical order:
88

9-
# MLCommons Collective Mind (CM)
9+
# MLCommons CM and CMX
1010

1111
* @Henryfzh
1212
* @Leonard226
1313
* @Oseltamivir
1414
* @Submandarine
15+
* Daniel Altunay
1516
* Resmi Arjun
1617
* Omar Benjelloun (Google)
1718
* Alice Cheng (Nvidia)

‎cm/CHANGES.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
## CMX V4.0.2
2+
- bug fixes
3+
14
## CMX V4.0.1
25
- provided backward compatibility with various MLCommons tools
36

‎cm/cmind/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
# White paper: https://arxiv.org/abs/2406.16791
1010
# Project contributors: https://github.com/mlcommons/ck/blob/master/CONTRIBUTING.md
1111

12-
__version__ = "4.0.1"
12+
__version__ = "4.0.2"
1313

1414
from cmind.core import access
1515
from cmind.core import x

‎cm/cmind/repo/automation/mlperf/_cm.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"action_substitutions": {
3+
"for":"xfor"
4+
},
5+
"alias": "mlperf",
6+
"automation_alias": "automation",
7+
"automation_uid": "bbeb15d8f0a944a4",
8+
"desc": "CMX interface for mlcr/mlperf",
9+
"sort": -1000,
10+
"tags": [
11+
"automation",
12+
"mlperf"
13+
],
14+
"uid": "12343304a8964782"
15+
}

‎cm/cmind/repo/automation/mlperf/module.py

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# CMX interface for mlcr
2+
3+
import os
4+
5+
from cmind.automation import Automation
6+
from cmind import utils
7+
from cmind import cli
8+
9+
class CAutomation(Automation):
10+
"""
11+
CMX interface for mlperf/mlcr
12+
"""
13+
14+
############################################################
15+
def __init__(self, cmind, automation_file):
16+
super().__init__(cmind, __file__)
17+
18+
############################################################
19+
def xfor(self, i):
20+
"""
21+
CMX interface for MLPerf
22+
23+
"""
24+
25+
_cmd = i['control']['_cmd'][2:]
26+
27+
cmd = 'mlcr ' + ' '.join(_cmd)
28+
29+
returncode = os.system(cmd)
30+
31+
r = {'return': returncode}
32+
if returncode > 0:
33+
r['error'] = 'mlcr command failed'
34+
35+
return r

‎docs/README.CM.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# CM documentation
2+
3+
**We plan to rewrite and simplify the CM documentation and tutorials based on user feedback - please stay tuned for more details**.
4+
5+
Collective Mind (CM) is a lightweight, non-intrusive and technology-agnostic workflow automation framework
6+
being developed by the [MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
7+
based on the feedback from the [the community, MLCommons members and individual contributors](../CONTRIBUTING.md).
8+
9+
The goal is to provide a common, simple and human-readable interface to help users encode their knowledge
10+
about how to build, run and customize diverse AI/ML apps, benchmarks and research projects across
11+
continuously changing models, datasets, software and hardware from different vendors in a unified and automated way.
12+
13+
You can find on-going development tasks [here](https://github.com/mlcommons/ck/blob/dev/docs/taskforce.md#current-tasks).
14+
15+
* [Getting Started Guide and FAQ](getting-started.md)
16+
* [Introduction](introduction-cm.md)
17+
* [CM installation and customization](installation.md)
18+
* [Unified CLI and Python API](interface.md)
19+
* [CM framework core API](https://cknowledge.org/docs/cm)
20+
* [CM "script" automation](https://github.com/mlcommons/ck/blob/master/cm-mlops/automation/script/README-extra.md)
21+
* [CM "cache" automation](https://github.com/mlcommons/ck/blob/master/cm-mlops/automation/cache/README-extra.md)
22+
* [CM "experiment" automation](https://github.com/mlcommons/ck/blob/master/cm-mlops/automation/experiment/README-extra.md)
23+
* [List of all unified CM automations from MLCommons](list_of_automations.md)
24+
* [List of all portable and reusable CM scripts from MLCommons](https://access.cknowledge.org/playground/?action=scripts)
25+
* The most commonly used CM scripts (basic blocks needed for most portable and tech-agnostic automation workflows)
26+
* [detect OS](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
27+
* [detect CPU](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
28+
* [install system deps for CM](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm)
29+
* [install min system deps for Windows](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-min)
30+
* [download file](https://github.com/mlcommons/ck/blob/master/cm-mlops/script/download-file/README-extra.md)
31+
* [extract file](https://github.com/mlcommons/ck/blob/master/cm-mlops/script/extract-file/README-extra.md)
32+
* [download and extract file](https://github.com/mlcommons/ck/blob/master/cm-mlops/script/download-and-extract-file/README-extra.md)
33+
* [detect or install python](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
34+
* [install/manage multiple python venv](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-venv)
35+
* [detect conda manager](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-conda)
36+
* [detect/download COCO dataset](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco/README-extra.md)
37+
* [Debugging](debugging.md)
38+
* [Real-world use cases](use-cases.md)
39+
* [Tutorials](tutorials/README.md)
40+
* [Specifications](specs/README.md)
41+
* [Source code](https://github.com/mlcommons/ck/tree/master/cm/cmind)
42+
* [FAQ](faq.md)
43+
* [CM and CK history](history.md)

‎docs/README.md

Lines changed: 3 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,4 @@
1-
# CM documentation
1+
# Documentation
22

3-
**We plan to rewrite and simplify the CM documentation and tutorials based on user feedback - please stay tuned for more details**.
4-
5-
Collective Mind (CM) is a lightweight, non-intrusive and technology-agnostic workflow automation framework
6-
being developed by the [MLCommons Task Force on Automation and Reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md)
7-
based on the feedback from the [the community, MLCommons members and individual contributors](../CONTRIBUTING.md).
8-
9-
The goal is to provide a common, simple and human-readable interface to help users encode their knowledge
10-
about how to build, run and customize diverse AI/ML apps, benchmarks and research projects across
11-
continuously changing models, datasets, software and hardware from different vendors in a unified and automated way.
12-
13-
You can find on-going development tasks [here](https://github.com/mlcommons/ck/blob/dev/docs/taskforce.md#current-tasks).
14-
15-
* [Getting Started Guide and FAQ](getting-started.md)
16-
* [Introduction](introduction-cm.md)
17-
* [CM installation and customization](installation.md)
18-
* [Unified CLI and Python API](interface.md)
19-
* [CM framework core API](https://cknowledge.org/docs/cm)
20-
* [CM "script" automation](https://github.com/mlcommons/ck/blob/master/cm-mlops/automation/script/README-extra.md)
21-
* [CM "cache" automation](https://github.com/mlcommons/ck/blob/master/cm-mlops/automation/cache/README-extra.md)
22-
* [CM "experiment" automation](https://github.com/mlcommons/ck/blob/master/cm-mlops/automation/experiment/README-extra.md)
23-
* [List of all unified CM automations from MLCommons](list_of_automations.md)
24-
* [List of all portable and reusable CM scripts from MLCommons](https://access.cknowledge.org/playground/?action=scripts)
25-
* The most commonly used CM scripts (basic blocks needed for most portable and tech-agnostic automation workflows)
26-
* [detect OS](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os)
27-
* [detect CPU](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu)
28-
* [install system deps for CM](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm)
29-
* [install min system deps for Windows](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-min)
30-
* [download file](https://github.com/mlcommons/ck/blob/master/cm-mlops/script/download-file/README-extra.md)
31-
* [extract file](https://github.com/mlcommons/ck/blob/master/cm-mlops/script/extract-file/README-extra.md)
32-
* [download and extract file](https://github.com/mlcommons/ck/blob/master/cm-mlops/script/download-and-extract-file/README-extra.md)
33-
* [detect or install python](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3)
34-
* [install/manage multiple python venv](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-venv)
35-
* [detect conda manager](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-conda)
36-
* [detect/download COCO dataset](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco/README-extra.md)
37-
* [Debugging](debugging.md)
38-
* [Real-world use cases](use-cases.md)
39-
* [Tutorials](tutorials/README.md)
40-
* [Specifications](specs/README.md)
41-
* [Source code](https://github.com/mlcommons/ck/tree/master/cm/cmind)
42-
* [FAQ](faq.md)
43-
* [CM and CK history](history.md)
3+
* [Common Metadata eXchange automation framework (CMX, 2025+)](cmx)
4+
* [Collective Mind automation framework (CM, 2021-2024)](README.CM.md)

‎docs/cmx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../cmx

‎docs/cmx/README.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎mkdocs.yml

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,13 @@ theme:
2020
- toc.follow
2121
nav:
2222
- HOME: index.md
23-
- CMX:
24-
- Summary: ../cmx/README.md
25-
- Introduction: ../cmx/introduction.md
26-
- Installation: ../cmx/install.md
27-
- Getting Started Guide: ../cmx/getting-started.md
23+
- CMX:
24+
- Summary: cmx/README.md
25+
- Introduction: cmx/introduction.md
26+
- Installation: cmx/install.md
27+
- Getting Started Guide: cmx/getting-started.md
2828
- CK Playground: https://access.cKnowledge.org
29-
- Releases:
30-
- CMX: https://github.com/mlcommons/ck/releases
29+
- Releases: https://github.com/mlcommons/ck/releases
3130

3231
markdown_extensions:
3332
- pymdownx.tasklist:

0 commit comments

Comments
 (0)