-
Notifications
You must be signed in to change notification settings - Fork 120
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8d0562d
commit f0b30ca
Showing
12 changed files
with
374 additions
and
9 deletions.
There are no files selected for viewing
This file contains 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 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 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 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 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 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,146 @@ | ||
| <details> | ||
| <summary>Click here to see the table of contents.</summary> | ||
|
|
||
| * [About](#about) | ||
| * [Summary](#summary) | ||
| * [Reuse this script in your project](#reuse-this-script-in-your-project) | ||
| * [ Install CM automation language](#install-cm-automation-language) | ||
| * [ Check CM script flags](#check-cm-script-flags) | ||
| * [ Run this script from command line](#run-this-script-from-command-line) | ||
| * [ Run this script from Python](#run-this-script-from-python) | ||
| * [ Run this script via GUI](#run-this-script-via-gui) | ||
| * [ Run this script via Docker (beta)](#run-this-script-via-docker-(beta)) | ||
| * [Customization](#customization) | ||
| * [ Script flags mapped to environment](#script-flags-mapped-to-environment) | ||
| * [ Default environment](#default-environment) | ||
| * [Script workflow, dependencies and native scripts](#script-workflow-dependencies-and-native-scripts) | ||
| * [Script output](#script-output) | ||
| * [New environment keys (filter)](#new-environment-keys-(filter)) | ||
| * [New environment keys auto-detected from customize](#new-environment-keys-auto-detected-from-customize) | ||
| * [Maintainers](#maintainers) | ||
|
|
||
| </details> | ||
|
|
||
| *Note that this README is automatically generated - don't edit!* | ||
|
|
||
| ### About | ||
|
|
||
| #### Summary | ||
|
|
||
| * CM GitHub repository: *[mlcommons@ck](https://github.com/mlcommons/ck/tree/master/cm-mlops)* | ||
| * GitHub directory for this script: *[GitHub](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-patch)* | ||
| * CM meta description for this script: *[_cm.yaml](_cm.yaml)* | ||
| * CM "database" tags to find this script: *create,patch* | ||
| * Output cached? *False* | ||
| ___ | ||
| ### Reuse this script in your project | ||
|
|
||
| #### Install CM automation language | ||
|
|
||
| * [Installation guide](https://github.com/mlcommons/ck/blob/master/docs/installation.md) | ||
| * [CM intro](https://doi.org/10.5281/zenodo.8105339) | ||
|
|
||
| #### Pull CM repository with this automation | ||
|
|
||
| ```cm pull repo mlcommons@ck``` | ||
|
|
||
|
|
||
| #### Run this script from command line | ||
|
|
||
| 1. `cm run script --tags=create,patch [--input_flags]` | ||
|
|
||
| 2. `cmr "create patch" [--input_flags]` | ||
|
|
||
| * `input_flags` can be seen [here](#script-flags-mapped-to-environment) | ||
|
|
||
| #### Run this script from Python | ||
|
|
||
| <details> | ||
| <summary>Click here to expand this section.</summary> | ||
|
|
||
| ```python | ||
|
|
||
| import cmind | ||
|
|
||
| r = cmind.access({'action':'run' | ||
| 'automation':'script', | ||
| 'tags':'create,patch' | ||
| 'out':'con', | ||
| ... | ||
| (other input keys for this script) | ||
| ... | ||
| }) | ||
|
|
||
| if r['return']>0: | ||
| print (r['error']) | ||
|
|
||
| ``` | ||
|
|
||
| </details> | ||
|
|
||
|
|
||
| #### Run this script via GUI | ||
|
|
||
| ```cmr "cm gui" --script="create,patch"``` | ||
|
|
||
| Use this [online GUI](https://cKnowledge.org/cm-gui/?tags=create,patch) to generate CM CMD. | ||
|
|
||
| #### Run this script via Docker (beta) | ||
|
|
||
| `cm docker script "create patch" [--input_flags]` | ||
|
|
||
| ___ | ||
| ### Customization | ||
|
|
||
|
|
||
| #### Script flags mapped to environment | ||
| <details> | ||
| <summary>Click here to expand this section.</summary> | ||
|
|
||
| * `--new=value` → `CM_CREATE_PATCH_NEW=value` | ||
| * `--old=value` → `CM_CREATE_PATCH_OLD=value` | ||
|
|
||
| **Above CLI flags can be used in the Python CM API as follows:** | ||
|
|
||
| ```python | ||
| r=cm.access({... , "new":...} | ||
| ``` | ||
|
|
||
| </details> | ||
|
|
||
| #### Default environment | ||
|
|
||
| <details> | ||
| <summary>Click here to expand this section.</summary> | ||
|
|
||
| These keys can be updated via `--env.KEY=VALUE` or `env` dictionary in `@input.json` or using script flags. | ||
|
|
||
|
|
||
| </details> | ||
|
|
||
| ___ | ||
| ### Script workflow, dependencies and native scripts | ||
|
|
||
| <details> | ||
| <summary>Click here to expand this section.</summary> | ||
|
|
||
| 1. Read "deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-patch/_cm.yaml) | ||
| 1. ***Run "preprocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-patch/customize.py)*** | ||
| 1. Read "prehook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-patch/_cm.yaml) | ||
| 1. ***Run native script if exists*** | ||
| 1. Read "posthook_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-patch/_cm.yaml) | ||
| 1. ***Run "postrocess" function from [customize.py](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-patch/customize.py)*** | ||
| 1. Read "post_deps" on other CM scripts from [meta](https://github.com/mlcommons/ck/tree/master/cm-mlops/script/create-patch/_cm.yaml) | ||
| </details> | ||
|
|
||
| ___ | ||
| ### Script output | ||
| `cmr "create patch" [--input_flags] -j` | ||
| #### New environment keys (filter) | ||
|
|
||
| #### New environment keys auto-detected from customize | ||
|
|
||
| ___ | ||
| ### Maintainers | ||
|
|
||
| * [Open MLCommons taskforce on automation and reproducibility](https://github.com/mlcommons/ck/blob/master/docs/taskforce.md) |
Oops, something went wrong.