Skip to content

Commit

Permalink
minor docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
gfursin committed Feb 5, 2025
1 parent 9eccc99 commit adaabf9
Show file tree
Hide file tree
Showing 6 changed files with 55 additions and 51 deletions.
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
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

0 comments on commit adaabf9

Please sign in to comment.