Merge pull request #803 from scap3yvt/802-add-a-script-to-generate-in…

…formation-useful-for-debugging

Added a script to generate information useful for debugging

.github/ISSUE_TEMPLATE/---bug-report.md

@@ -29,9 +29,11 @@ python -c 'import GANDLF as g;print(g.__version__)'
 -->
 Version information of the GaNDLF package in the virtual environment.
 
-**Desktop (please complete the following information):**
- - OS: [e.g. Windows/Linux (include detailed distro information)/macOS]
- - Version (including Build information, if any): [e.g. Fedora 22 or Windows 10.1803]
+**Environment information:**
+<!-- Put the output of the following command:
+python ./gandlf_debugInfo
+-->
+OS, hardware, and so on.
 
 **Additional context**
 Add any other context about the problem here.

GANDLF/utils/__init__.py

@@ -54,6 +54,7 @@
     print_and_format_metrics,
     determine_classification_task_type,
     getBase2,
+    get_git_hash,
 )
 
 from .modelio import (

GANDLF/utils/generic.py

@@ -1,4 +1,4 @@
-import os, datetime, sys
+import os, datetime, subprocess, sys
 from copy import deepcopy
 import random
 import numpy as np
@@ -329,3 +329,21 @@ def determine_classification_task_type(params: dict) -> str:
     """
     task = "binary" if params["model"]["num_classes"] == 2 else "multiclass"
     return task
+
+
+def get_git_hash() -> str:
+    """
+    Get the git hash of the current commit.
+
+    Returns:
+        str: The git hash of the current commit.
+    """
+    try:
+        git_hash = (
+            subprocess.check_output(["git", "rev-parse", "HEAD"], cwd=os.getcwd())
+            .decode("ascii")
+            .strip()
+        )
+    except (subprocess.CalledProcessError, FileNotFoundError):
+        git_hash = "None"
+    return git_hash

GANDLF/utils/modelio.py

@@ -1,12 +1,10 @@
-import hashlib
-import os
-import subprocess
+import hashlib, os
 from typing import Any, Dict, Optional, Tuple
 
 import torch
 
 from ..version import __version__
-from .generic import get_unique_timestamp
+from .generic import get_unique_timestamp, get_git_hash
 
 # these are the base keys for the model dictionary to save
 model_dict_full = {
@@ -155,16 +153,7 @@ def save_model(
     ).hexdigest()
     model_dict["version"] = __version__
     model_dict["parameters"] = params
-
-    try:
-        # this will try to encode the git hash of the current GaNDLF codebase, and reverts to "None" if not found
-        model_dict["git_hash"] = (
-            subprocess.check_output(["git", "rev-parse", "HEAD"], cwd=os.getcwd())
-            .decode("ascii")
-            .strip()
-        )
-    except (subprocess.CalledProcessError, FileNotFoundError):
-        model_dict["git_hash"] = "None"
+    model_dict["git_hash"] = get_git_hash()
 
     torch.save(model_dict, path)
 

gandlf_debugInfo

@@ -0,0 +1,20 @@
+#!usr/bin/env python
+# -*- coding: utf-8 -*-
+import platform
+
+from GANDLF import __version__
+from GANDLF.utils import get_git_hash
+
+
+if __name__ == "__main__":
+    print(f"GANDLF version: {__version__}")
+    print(f"Git hash: {get_git_hash()}")
+    print(f"Platform: {platform.platform()}")
+    print(f"Machine: {platform.machine()}")
+    print(f"Processor: {platform.processor()}")
+    print(f"Architecture: {(' ').join(list(platform.architecture()))}")
+    print("Python environment:")
+    print(f"  Version: {platform.python_version()}")
+    print(f"  Implementation: {platform.python_implementation()}")
+    print(f"  Compiler: {platform.python_compiler()}")
+    print(f"  Build: {(' ').join(list(platform.python_build()))}")