Update det-metrics.py

det-metrics.py

@@ -342,13 +342,38 @@ class DetectionMetric(evaluate.Metric):
         return fig
 
     def wandb(self, results , wandb_project='detection_metrics'):
+        """
+        Logs metrics to Weights and Biases (wandb) for tracking and visualization.
+    
+        This function logs the provided metrics to Weights and Biases (wandb), a platform for tracking machine learning experiments.
+        Each key in the `results` dictionary represents a separate run and the corresponding value contains the metrics for that run.
+        The function logs in to wandb using an API key obtained from the secret 'WANDB_API_KEY', initializes a run for 
+        each key in `results` and logs the metrics.
+    
+        Args:
+            results (dict): A dictionary where each key is a unique identifier for a run and each value is another dictionary
+                            containing the metrics to log. Example:
+                            {
+                                "run1": {"metrics": {"accuracy": 0.9, "loss": 0.1}},
+                                "run2": {"metrics": {"accuracy": 0.85, "loss": 0.15}}
+                            }
+            wandb_project (str, optional): The name of the wandb project to which the runs will be logged. Defaults to 'detection_metrics'.
+    
+        Environment Variables:
+            WANDB_API_KEY: The API key for authenticating with wandb.
+    
+        Imports:
+            os: To retrieve environment variables.
+            wandb: To interact with the Weights and Biases platform.
+            datetime: To generate a timestamp for run names.
+        """
         import os
         import wandb
         import datetime
 
         current_datetime = datetime.datetime.now()
         formatted_datetime = current_datetime.strftime("%Y-%m-%d_%H-%M-%S")
-        wandb.login(key=os.getenv('wandb_key'))
+        wandb.login(key=os.getenv('WANDB_API_KEY'))
 
         for k in results.keys():
             run = wandb.init(project=wandb_project, name=f"{k}-{formatted_datetime}")