Review: formatting changes + change github action

Author: am17an

.github/workflows/update-ops-docs.yml

@@ -23,23 +23,18 @@ jobs:
           with:
               python-version: '3.x'
 
-        - name: Generate operations documentation
-          run: ./scripts/create_ops_docs.py
-
-        - name: Check if docs/ops.md was updated
-          id: check_changes
+        - name: Generate operations documentation to temporary file
           run: |
-              if git diff --quiet docs/ops.md; then
-                  echo "changed=false" >> $GITHUB_OUTPUT
-              else
-                  echo "changed=true" >> $GITHUB_OUTPUT
-              fi
+              mkdir -p /tmp/ops_check
+              ./scripts/create_ops_docs.py /tmp/ops_check/ops.md
 
-        - name: Commit updated documentation
-          if: steps.check_changes.outputs.changed == 'true' && github.event_name == 'push'
+        - name: Check if docs/ops.md matches generated version
           run: |
-              git config --local user.email "[email protected]"
-              git config --local user.name "GitHub Action"
-              git add docs/ops.md
-              git commit -m "Update operations documentation from CSV files"
-              git push
+              if ! diff -q docs/ops.md /tmp/ops_check/ops.md; then
+                  echo "Operations documentation (docs/ops.md) is not up to date with the backend CSV files."
+                  echo "To fix: run ./scripts/create_ops_docs.py and commit the updated docs/ops.md along with your changes"
+                  echo "Differences found:"
+                  diff docs/ops.md /tmp/ops_check/ops.md || true
+                  exit 1
+              fi
+              echo "Operations documentation is up to date."

docs/ops/ryzen3800.csv renamed to docs/ops/CPU.csv

@@ -5,15 +5,17 @@
 """
 import csv
 import logging
+import sys
 from pathlib import Path
 from typing import Dict, List, Set
 from collections import defaultdict
 
 
 class DocsGenerator:
-    def __init__(self, ggml_root: str):
+    def __init__(self, ggml_root: str, output_filename: str = "ops.md"):
         self.ggml_root = Path(ggml_root)
         self.ops_dir = self.ggml_root / "docs" / "ops"
+        self.output_filename = output_filename
         self.backend_support: Dict[str, Dict[str, List[bool]]] = defaultdict(
             lambda: defaultdict(list)
         )
@@ -170,7 +172,7 @@ def run(self) -> None:
         docs_dir = self.ggml_root / "docs"
         docs_dir.mkdir(exist_ok=True)
 
-        ops_file = docs_dir / "ops.md"
+        ops_file = docs_dir / self.output_filename
         with open(ops_file, "w") as f:
             f.write(markdown_content)
 
@@ -180,10 +182,14 @@ def run(self) -> None:
 
 
 def main():
-    # Configure logging
     logging.basicConfig(level=logging.INFO)
 
-    generator = DocsGenerator(".")
+    if len(sys.argv) > 1:
+        output_filename = sys.argv[1]
+    else:
+        output_filename = "ops.md"
+
+    generator = DocsGenerator(".", output_filename)
     generator.run()
 
 

docs/ops/rtx3090.csv renamed to docs/ops/CUDA.csv

@@ -819,9 +819,9 @@ struct console_printer : public printer {
         fflush(stdout);
 
         if (result.supported) {
-            printf("\033[1;32myes\033[0m\n");
+            printf("\033[1;32mSUPPORTED\033[0m\n");
         } else {
-            printf("\033[1;31mno\033[0m\n");
+            printf("\033[1;31mNOT SUPPORTED\033[0m\n");
         }
     }
 };
@@ -1342,9 +1342,7 @@ struct test_case {
         test_result result(ggml_backend_name(backend), current_op_name, vars(), "support", supported, supported,
                            supported ? "yes" : "no", 0.0, 0.0, 0.0, 0, 0, device_desc, backend_reg_name);
 
-        if (output_printer) {
-            output_printer->print_test_result(result);
-        }
+        output_printer->print_test_result(result);
 
         return true;
     }
@@ -5691,7 +5689,7 @@ static bool test_backend(ggml_backend_t backend, test_mode mode, const char * op
 }
 
 static void usage(char ** argv) {
-    printf("Usage: %s [mode] [-o <op>] [-b <backend>] [-p <params regex>] [--output <console|sql>]\n", argv[0]);
+    printf("Usage: %s [mode] [-o <op>] [-b <backend>] [-p <params regex>] [--output <console|sql|csv>]\n", argv[0]);
     printf("    valid modes:\n");
     printf("      - test (default, compare with CPU backend for correctness)\n");
     printf("      - grad (compare gradients from backpropagation with method of finite differences)\n");