Skip to content

Commit

Permalink
Merge branch 'dev' into dev
Browse files Browse the repository at this point in the history
  • Loading branch information
arjunsuresh authored Feb 3, 2025
2 parents 41c282f + 6a91792 commit ca136ee
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 80 deletions.
46 changes: 0 additions & 46 deletions docs/cm-yaml-guide.md

This file was deleted.

15 changes: 13 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,18 @@ See the [automatically generated catalog](scripts/index.md) of all the MLC scrip
* Further each MLC script can have multiple variations and they are identified by variation tags which are treated in the same way as tags and identified by a `_` prefix.

### MLC script execution flow
<img src="https://github.com/mlcommons/cm4mlops/raw/mlperf-inference/automation/script/assets/scripts-workflow.png" width="248">
```mermaid
graph TD
MLC -->|env = incoming env + env_from_meta| B[Script]
B -->|env - local_env_keys| C[List of Dependencies]
C --> D[Preprocess]
D -->|env - local_env_keys| E[Prehook dependencies]
E -->F[Run script]
F -->|env - clean_env_keys_post_deps| G[Posthook dependencies]
G --> H[Postprocess]
H -->|env - clean_env_keys_post_deps| I[Post dependencies]
I -->|"env(new_env_keys)"| J[Script return]
```

* When an MLC script is invoked (either by tags or by unique ID), its `meta.yaml` is processed first which will check for any `deps` script and if there are, then they are executed in order.
* Once all the `deps` scripts are executed, `customize.py` file is checked and if existing `preprocess` function inside it is executed if present.
Expand Down Expand Up @@ -75,5 +86,5 @@ Please see [here](getting-started.md) for trying MLC scripts.



&copy; 2022-24 [MLCommons](https://mlcommons.org)<br>
&copy; 2022-25 [MLCommons](https://mlcommons.org)<br>

32 changes: 0 additions & 32 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,38 +21,6 @@ theme:
nav:
- HOME: index.md
- Getting Started: getting-started.md
- CM Scripts:
- scripts/index.md
- Python-automation: scripts/Python-automation/index.md
- MLPerf-benchmark-support: scripts/MLPerf-benchmark-support/index.md
- Modular-AI-ML-application-pipeline: scripts/Modular-AI-ML-application-pipeline/index.md
- Modular-application-pipeline: scripts/Modular-application-pipeline/index.md
- Modular-MLPerf-inference-benchmark-pipeline: scripts/Modular-MLPerf-inference-benchmark-pipeline/index.md
- Modular-MLPerf-benchmarks: scripts/Modular-MLPerf-benchmarks/index.md
- Reproduce-MLPerf-benchmarks: scripts/Reproduce-MLPerf-benchmarks/index.md
- Modular-MLPerf-training-benchmark-pipeline: scripts/Modular-MLPerf-training-benchmark-pipeline/index.md
- DevOps-automation: scripts/DevOps-automation/index.md
- Docker-automation: scripts/Docker-automation/index.md
- AI-ML-optimization: scripts/AI-ML-optimization/index.md
- AI-ML-models: scripts/AI-ML-models/index.md
- CM-automation: scripts/CM-automation/index.md
- TinyML-automation: scripts/TinyML-automation/index.md
- Cloud-automation: scripts/Cloud-automation/index.md
- Platform-information: scripts/Platform-information/index.md
- Detection-or-installation-of-tools-and-artifacts: scripts/Detection-or-installation-of-tools-and-artifacts/index.md
- Compiler-automation: scripts/Compiler-automation/index.md
- CM-Interface: scripts/CM-Interface/index.md
- Legacy-CK-support: scripts/Legacy-CK-support/index.md
- AI-ML-datasets: scripts/AI-ML-datasets/index.md
- CUDA-automation: scripts/CUDA-automation/index.md
- AI-ML-frameworks: scripts/AI-ML-frameworks/index.md
- Reproducibility-and-artifact-evaluation: scripts/Reproducibility-and-artifact-evaluation/index.md
- GUI: scripts/GUI/index.md
- Collective-benchmarking: scripts/Collective-benchmarking/index.md
- Tests: scripts/Tests/index.md
- Dashboard-automation: scripts/Dashboard-automation/index.md
- Remote-automation: scripts/Remote-automation/index.md
- CM-interface-prototyping: scripts/CM-interface-prototyping/index.md

markdown_extensions:
- pymdownx.tasklist:
Expand Down

0 comments on commit ca136ee

Please sign in to comment.