Skip to content

Commit

Permalink
revisited automatically generated READMEs for CM scripts (automation …
Browse files Browse the repository at this point in the history
…recipes)

based on user feedback: mlcommons/ck#1169
  • Loading branch information
gfursin committed Mar 22, 2024
1 parent cbc9c45 commit 2bb9483
Show file tree
Hide file tree
Showing 272 changed files with 12,009 additions and 14,898 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,11 @@ pip install cmind -U

cm pull repo mlcommons@ck

cm checkout repo mlcommons@ck --branch=dev
cm checkout repo mlcommons@ck --branch=master

cm rm cache -f

cm run script "python app image-classification onnx"
cmr "python app image-classification onnx"

Expand Down
20 changes: 20 additions & 0 deletions cm-mlops/automation/cache/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,26 @@
print(r['error'])
```

#### copy_to_remote

* CM CLI: ```cm copy_to_remote cache``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/cache/module.py#L186))
* CM CLI with UID: ```cm copy_to_remote cache,541d6f712a6b464e``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/cache/module.py#L186))
* CM Python API:
```python
import cmind

r=cm.access({
'action':'copy_to_remote'
'automation':'cache,541d6f712a6b464e'
'out':'con'
```
[add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/cache/module.py#L186)
```python
})
if r['return']>0:
print(r['error'])
```

### Maintainers

* [Open MLCommons taskforce on automation and reproducibility](https://cKnowledge.org/mlcommons-taskforce)
27 changes: 27 additions & 0 deletions cm-mlops/automation/cfg/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
*This README is automatically generated - don't edit! Use `README-extra.md` for extra notes!*

### Automation actions

#### test

* CM CLI: ```cm test cfg``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/cfg/module.py#L15))
* CM CLI with UID: ```cm test cfg,88dce9c160324c5d``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/cfg/module.py#L15))
* CM Python API:
```python
import cmind

r=cm.access({
'action':'test'
'automation':'cfg,88dce9c160324c5d'
'out':'con'
```
[add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/cfg/module.py#L15)
```python
})
if r['return']>0:
print(r['error'])
```

### Maintainers

* [Open MLCommons taskforce on automation and reproducibility](https://cKnowledge.org/mlcommons-taskforce)
12 changes: 6 additions & 6 deletions cm-mlops/automation/experiment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@

#### rerun

* CM CLI: ```cm rerun experiment``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L417))
* CM CLI with UID: ```cm rerun experiment,a0a2d123ef064bcb``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L417))
* CM CLI: ```cm rerun experiment``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L428))
* CM CLI with UID: ```cm rerun experiment,a0a2d123ef064bcb``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L428))
* CM Python API:
```python
import cmind
Expand All @@ -55,7 +55,7 @@
'automation':'experiment,a0a2d123ef064bcb'
'out':'con'
```
[add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L417)
[add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L428)
```python
})
if r['return']>0:
Expand All @@ -64,8 +64,8 @@

#### replay

* CM CLI: ```cm replay experiment``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L440))
* CM CLI with UID: ```cm replay experiment,a0a2d123ef064bcb``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L440))
* CM CLI: ```cm replay experiment``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L451))
* CM CLI with UID: ```cm replay experiment,a0a2d123ef064bcb``` ([add flags (dict keys) from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L451))
* CM Python API:
```python
import cmind
Expand All @@ -75,7 +75,7 @@
'automation':'experiment,a0a2d123ef064bcb'
'out':'con'
```
[add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L440)
[add keys from this API](https://github.com/mlcommons/ck/tree/master/cm-mlops/automation/experiment/module.py#L451)
```python
})
if r['return']>0:
Expand Down
Loading

0 comments on commit 2bb9483

Please sign in to comment.