-
Notifications
You must be signed in to change notification settings - Fork 118
minor docs update #1394
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
minor docs update #1394
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
adaabf9
minor docs update
gfursin a25e1e7
minor update
gfursin 562f717
Merge pull request #29 from mlcommons/master
gfursin b215358
Merge pull request #30 from mlcommons/master
gfursin e0895a5
bug fixes
gfursin 1196f71
Merge branch 'master' of github.com:ctuning/mlcommons-ck
gfursin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,6 @@ | ||
## CMX V4.0.2 | ||
- bug fixes | ||
|
||
## CMX V4.0.1 | ||
- provided backward compatibility with various MLCommons tools | ||
|
||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
{ | ||
"action_substitutions": { | ||
"for":"xfor" | ||
}, | ||
"alias": "mlperf", | ||
"automation_alias": "automation", | ||
"automation_uid": "bbeb15d8f0a944a4", | ||
"desc": "CMX interface for mlcr/mlperf", | ||
"sort": -1000, | ||
"tags": [ | ||
"automation", | ||
"mlperf" | ||
], | ||
"uid": "12343304a8964782" | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# CMX interface for mlcr | ||
|
||
import os | ||
|
||
from cmind.automation import Automation | ||
from cmind import utils | ||
from cmind import cli | ||
|
||
class CAutomation(Automation): | ||
""" | ||
CMX interface for mlperf/mlcr | ||
""" | ||
|
||
############################################################ | ||
def __init__(self, cmind, automation_file): | ||
super().__init__(cmind, __file__) | ||
|
||
############################################################ | ||
def xfor(self, i): | ||
""" | ||
CMX interface for MLPerf | ||
|
||
""" | ||
|
||
_cmd = i['control']['_cmd'][2:] | ||
|
||
cmd = 'mlcr ' + ' '.join(_cmd) | ||
|
||
returncode = os.system(cmd) | ||
|
||
r = {'return': returncode} | ||
if returncode > 0: | ||
r['error'] = 'mlcr command failed' | ||
|
||
return r |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# CM documentation | ||
|
||
**We plan to rewrite and simplify the CM documentation and tutorials based on user feedback - 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 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. | ||
|
||
You can find on-going development tasks [here](https://github.com/mlcommons/ck/blob/dev/docs/taskforce.md#current-tasks). | ||
|
||
* [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) | ||
* [List of all unified CM automations from MLCommons](list_of_automations.md) | ||
* [List of all portable and reusable CM scripts from MLCommons](https://access.cknowledge.org/playground/?action=scripts) | ||
* The most commonly used CM scripts (basic blocks needed for most portable and tech-agnostic automation workflows) | ||
* [detect OS](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os) | ||
* [detect CPU](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu) | ||
* [install system deps for CM](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm) | ||
* [install min system deps for Windows](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-min) | ||
* [download file](https://github.com/mlcommons/ck/blob/master/cm-mlops/script/download-file/README-extra.md) | ||
* [extract file](https://github.com/mlcommons/ck/blob/master/cm-mlops/script/extract-file/README-extra.md) | ||
* [download and extract file](https://github.com/mlcommons/ck/blob/master/cm-mlops/script/download-and-extract-file/README-extra.md) | ||
* [detect or install python](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3) | ||
* [install/manage multiple python venv](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-venv) | ||
* [detect conda manager](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-conda) | ||
* [detect/download COCO dataset](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco/README-extra.md) | ||
* [Debugging](debugging.md) | ||
* [Real-world use cases](use-cases.md) | ||
* [Tutorials](tutorials/README.md) | ||
* [Specifications](specs/README.md) | ||
* [Source code](https://github.com/mlcommons/ck/tree/master/cm/cmind) | ||
* [FAQ](faq.md) | ||
* [CM and CK history](history.md) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,43 +1,4 @@ | ||
# CM documentation | ||
# Documentation | ||
|
||
**We plan to rewrite and simplify the CM documentation and tutorials based on user feedback - 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 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. | ||
|
||
You can find on-going development tasks [here](https://github.com/mlcommons/ck/blob/dev/docs/taskforce.md#current-tasks). | ||
|
||
* [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) | ||
* [List of all unified CM automations from MLCommons](list_of_automations.md) | ||
* [List of all portable and reusable CM scripts from MLCommons](https://access.cknowledge.org/playground/?action=scripts) | ||
* The most commonly used CM scripts (basic blocks needed for most portable and tech-agnostic automation workflows) | ||
* [detect OS](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-os) | ||
* [detect CPU](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/detect-cpu) | ||
* [install system deps for CM](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-cm) | ||
* [install min system deps for Windows](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-sys-utils-min) | ||
* [download file](https://github.com/mlcommons/ck/blob/master/cm-mlops/script/download-file/README-extra.md) | ||
* [extract file](https://github.com/mlcommons/ck/blob/master/cm-mlops/script/extract-file/README-extra.md) | ||
* [download and extract file](https://github.com/mlcommons/ck/blob/master/cm-mlops/script/download-and-extract-file/README-extra.md) | ||
* [detect or install python](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-python3) | ||
* [install/manage multiple python venv](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/install-python-venv) | ||
* [detect conda manager](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-conda) | ||
* [detect/download COCO dataset](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/get-dataset-coco/README-extra.md) | ||
* [Debugging](debugging.md) | ||
* [Real-world use cases](use-cases.md) | ||
* [Tutorials](tutorials/README.md) | ||
* [Specifications](specs/README.md) | ||
* [Source code](https://github.com/mlcommons/ck/tree/master/cm/cmind) | ||
* [FAQ](faq.md) | ||
* [CM and CK history](history.md) | ||
* [Common Metadata eXchange automation framework (CMX, 2025+)](cmx) | ||
* [Collective Mind automation framework (CM, 2021-2024)](README.CM.md) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../cmx |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.