8000 minor docs update by gfursin · Pull Request #1394 · mlcommons/ck · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

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 6 commits into from
Feb 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@ to benefit everyone. Since then, this open-source automation technology
as a community effort thanks to all our volunteers, collaborators
and contributors listed here in alphabetical order:

# MLCommons Collective Mind (CM)
# MLCommons CM and CMX

* @Henryfzh
* @Leonard226
* @Oseltamivir
* @Submandarine
* Daniel Altunay
* Resmi Arjun
* Omar Benjelloun (Google)
* Alice Cheng (Nvidia)
Expand Down
3 changes: 3 additions & 0 deletions cm/CHANGES.md
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

Expand Down
2 changes: 1 addition & 1 deletion cm/cmind/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# White paper: https://arxiv.org/abs/2406.16791
# Project contributors: https://github.com/mlcommons/ck/blob/master/CONTRIBUTING.md

__version__ = "4.0.1"
__version__ = "4.0.2"

from cmind.core import access
from cmind.core import x
Expand Down
15 changes: 15 additions & 0 deletions cm/cmind/repo/automation/mlperf/_cm.json
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"
}
35 changes: 35 additions & 0 deletions cm/cmind/repo/automation/mlperf/module.py
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
43 changes: 43 additions & 0 deletions docs/README.CM.md
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)
45 changes: 3 additions & 42 deletions docs/README.md
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)
1 change: 1 addition & 0 deletions docs/cmx
1 change: 0 additions & 1 deletion docs/cmx/README.md

This file was deleted.

13 changes: 6 additions & 7 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,13 @@ theme:
- toc.follow
nav:
- HOME: index.md
- CMX:
- Summary: ../cmx/README.md
- Introduction: ../cmx/introduction.md
- Installation: ../cmx/install.md
- Getting Started Guide: ../cmx/getting-started.md
- CMX:
- Summary: cmx/README.md
- Introduction: cmx/introduction.md
- Installation: cmx/install.md
- Getting Started Guide: cmx/getting-started.md
- CK Playground: https://access.cKnowledge.org
- Releases:
- CMX: https://github.com/mlcommons/ck/releases
- Releases: https://github.com/mlcommons/ck/releases

markdown_extensions:
- pymdownx.tasklist:
Expand Down
Loading
0