Minor fixes for consistent JSON output

Author: fjwillemsen

kernel_tuner/file_utils.py

@@ -223,10 +223,11 @@ def store_metadata_file(metadata_filename: str):
         if hardware_description_string[0] == "{" and hardware_description_string[-1] == "}":
             # sometimes lshw outputs a list of length 1, sometimes just as a dict, schema wants a list
             hardware_description_string = "[" + hardware_description_string + "]"
-        metadata["hardware"] = dict(hardware_description=json.loads(hardware_description_string))
         metadata["operating_system"] = os_string
     except:
-        metadata["hardware"] = "error retrieving hardware description"
+        hardware_description_string = "[error retrieving hardware description]"
+        metadata["operating_system"] = "unidentified OS"
+    metadata["hardware"] = dict(hardware_description=json.loads(hardware_description_string))
 
     # attempts to use nvidia-smi or rocm-smi if present
     device_query = {}

kernel_tuner/schema/T4/1.0.0/metadata-schema.json

@@ -1,45 +1,49 @@
 {
-    "$schema": "https://json-schema.org/draft/2020-12/schema",
-    "$id": "https://github.com/odgaard/TuningSchema/blob/T4/metadata-schema.json",
-    "title": "Open Autotuning Metadata Schema",
-    "type": "object",
-    "properties": {
-        "schema_version": {
-            "description": "The version number of the schema in major.minor.patch format.",
-            "type": "string",
-            "pattern": "^[0-9]{1,}.[0-9]{1,}.[0-9]{1,}$",
-            "example": "1.0.0"
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/odgaard/TuningSchema/blob/T4/metadata-schema.json",
+  "title": "Open Autotuning Metadata Schema",
+  "type": "object",
+  "properties": {
+    "schema_version": {
+      "description": "The version number of the schema in major.minor.patch format.",
+      "type": "string",
+      "pattern": "^[0-9]{1,}.[0-9]{1,}.[0-9]{1,}$",
+      "example": "1.0.0"
+    },
+    "metadata": {
+      "type": "object",
+      "properties": {
+        "zenodo": {
+          "type": "object",
+          "description": "The zenodo metadata used to publish the artifact"
         },
-        "metadata": {
-            "type": "object",
-            "properties": {
-                "zenodo": {
-                    "type": "object",
-                    "description": "The zenodo metadata used to publish the artifact"
-                },
-                "hardware": {
-                    "type": "object",
-                    "properties": {
-                        "lshw": {
-                            "type": "array",
-                            "description": "The output of lshw as JSON"
-                        }
-                    }
-                },
-                "environment": {
-                    "type": "object",
-                    "properties": {
-                        "device_query": {
-                            "type": "object",
-                            "description": "The output from tools such as nvidia-smi as JSON"
-                        },
-                        "requirements": {
-                            "type": "array",
-                            "description": "the python libraries used as a list of strings"
-                        }
-                    }
-                }
+        "hardware": {
+          "type": "object",
+          "properties": {
+            "hardware_description": {
+              "type": "array",
+              "description": "The hardware description in JSON, OS-dependent (e.g. lshw on Linux)"
+            },
+            "operating_system": {
+              "type": "string",
+              "description": "The operating system used"
             }
+          }
+        },
+        "environment": {
+          "type": "object",
+          "properties": {
+            "device_query": {
+              "type": "object",
+              "description": "The output from tools such as nvidia-smi as JSON"
+            },
+            "requirements": {
+              "type": "array",
+              "description": "the python libraries used as a list of strings"
+            }
+          }
         }
-   }
-}
+      }
+    }
+  }
+}