Merge pull request #99 from GATEOverflow/dev

Fix script action docs
mlcommons · Feb 15, 2025 · 48e4da3 · 48e4da3
2 parents 6bf0439 + 6ff299e
commit 48e4da3
Showing 1 changed file with 92 additions and 1 deletion.
diff --git a/docs/targets/script/index.md b/docs/targets/script/index.md
@@ -146,23 +146,114 @@ mlc run script --tags=detect,os -j
 
 **Options:**  
 - `-j`: Shows the output in a JSON format
+
 - `mlcr` can be used as a shortcut to `mlc run script --tags=`
+
 - `--input`:
+
 - `--path`:
+
 - `--outdirname`:
+
 - `--new`:
+
 - `--force_cache`:
+
 - `--version`:
+
 - `--version_max`:
+
 - `--version_min`:
+
 - `--quiet`:
+
 - `--silent`:
+
 - `-v`:
+
 - *`<Individual script inputs>`: In addition to the above options an `mlcr` command also takes any input specified with in a script meta in `input_mappings` as its input.  
 
 <details>
   <summary><strong>Example Output</strong> 📌</summary>
-
+arjun@arjun-spr:~$ mlcr detect,os -j
+[2025-02-16 03:30:40,702 module.py:560 INFO] - * mlcr detect,os
+[2025-02-16 03:30:40,704 module.py:5334 INFO] -        ! cd /home/arjun
+[2025-02-16 03:30:40,704 module.py:5335 INFO] -        ! call /home/arjun/MLC/repos/gateoverflow@mlperf-automations/script/detect-os/run.sh from tmp-run.sh
+[2025-02-16 03:30:40,740 module.py:5481 INFO] -        ! call "postprocess" from /home/arjun/MLC/repos/gateoverflow@mlperf-automations/script/detect-os/customize.py
+[2025-02-16 03:30:40,749 module.py:2181 INFO] - {
+  "return": 0,
+  "env": {
+    "MLC_HOST_OS_TYPE": "linux",
+    "MLC_HOST_OS_BITS": "64",
+    "MLC_HOST_OS_FLAVOR": "ubuntu",
+    "MLC_HOST_OS_FLAVOR_LIKE": "debian",
+    "MLC_HOST_OS_VERSION": "24.04",
+    "MLC_HOST_OS_KERNEL_VERSION": "6.8.0-52-generic",
+    "MLC_HOST_OS_GLIBC_VERSION": "2.39",
+    "MLC_HOST_OS_MACHINE": "x86_64",
+    "MLC_HOST_OS_PACKAGE_MANAGER": "apt",
+    "MLC_HOST_OS_PACKAGE_MANAGER_INSTALL_CMD": "DEBIAN_FRONTEND=noninteractive apt-get install -y",
+    "MLC_HOST_OS_PACKAGE_MANAGER_UPDATE_CMD": "apt-get update -y",
+    "+MLC_HOST_OS_DEFAULT_LIBRARY_PATH": [
+      "/usr/local/lib/x86_64-linux-gnu",
+      "/lib/x86_64-linux-gnu",
+      "/usr/lib/x86_64-linux-gnu",
+      "/usr/lib/x86_64-linux-gnu64",
+      "/usr/local/lib64",
+      "/lib64",
+      "/usr/lib64",
+      "/usr/local/lib",
+      "/lib",
+      "/usr/lib",
+      "/usr/x86_64-linux-gnu/lib64",
+      "/usr/x86_64-linux-gnu/lib"
+    ],
+    "MLC_HOST_PLATFORM_FLAVOR": "x86_64",
+    "MLC_HOST_PYTHON_BITS": "64",
+    "MLC_HOST_SYSTEM_NAME": "arjun-spr"
+  },
+  "new_env": {
+    "MLC_HOST_OS_TYPE": "linux",
+    "MLC_HOST_OS_BITS": "64",
+    "MLC_HOST_OS_FLAVOR": "ubuntu",
+    "MLC_HOST_OS_FLAVOR_LIKE": "debian",
+    "MLC_HOST_OS_VERSION": "24.04",
+    "MLC_HOST_OS_KERNEL_VERSION": "6.8.0-52-generic",
+    "MLC_HOST_OS_GLIBC_VERSION": "2.39",
+    "MLC_HOST_OS_MACHINE": "x86_64",
+    "MLC_HOST_OS_PACKAGE_MANAGER": "apt",
+    "MLC_HOST_OS_PACKAGE_MANAGER_INSTALL_CMD": "DEBIAN_FRONTEND=noninteractive apt-get install -y",
+    "MLC_HOST_OS_PACKAGE_MANAGER_UPDATE_CMD": "apt-get update -y",
+    "+MLC_HOST_OS_DEFAULT_LIBRARY_PATH": [
+      "/usr/local/lib/x86_64-linux-gnu",
+      "/lib/x86_64-linux-gnu",
+      "/usr/lib/x86_64-linux-gnu",
+      "/usr/lib/x86_64-linux-gnu64",
+      "/usr/local/lib64",
+      "/lib64",
+      "/usr/lib64",
+      "/usr/local/lib",
+      "/lib",
+      "/usr/lib",
+      "/usr/x86_64-linux-gnu/lib64",
+      "/usr/x86_64-linux-gnu/lib"
+    ],
+    "MLC_HOST_PLATFORM_FLAVOR": "x86_64",
+    "MLC_HOST_PYTHON_BITS": "64",
+    "MLC_HOST_SYSTEM_NAME": "arjun-spr"
+  },
+  "state": {
+    "os_uname_machine": "x86_64",
+    "os_uname_all": "Linux arjun-spr 6.8.0-52-generic #53-Ubuntu SMP PREEMPT_DYNAMIC Sat Jan 11 00:06:25 UTC 2025 x86_64 x86_64 x86_64 GNU/Linux"
+  },
+  "new_state": {
+    "os_uname_machine": "x86_64",
+    "os_uname_all": "Linux arjun-spr 6.8.0-52-generic #53-Ubuntu SMP PREEMPT_DYNAMIC Sat Jan 11 00:06:25 UTC 2025 x86_64 x86_64 x86_64 GNU/Linux"
+  },
+  "deps": []
+}
+
+</details>
 ---
 
 ## **Docker Execution**