update the readme

README.md

@@ -105,6 +105,47 @@ The output is a dictionary containing the following metrics:
 
 We levereage one of the internal variables of motmetrics ```MOTAccumulator``` class, ```events```, which keeps track of the detections hits and misses. These values are then processed via the ```track_ratios``` function which counts the ratio of assigned to total appearance count per unique object id. We then define the ```recognition``` function that counts how many objects have been seen more times then the desired threshold.
 
+
+
+
+## W&B logging
+When you use **module.wandb()**, it is possible to log the User Frindly metrics values in Weights and Bias (W&B). The W&B key is stored as a Secret in this repository.
+
+### Params
+- **wandb_project** - Name of the W&B project (Default: `'user_freindly_metrics'`)
+- **log_plots** (bool, optional): Generates categorized bar charts for global metrics. Defaults to True
+- **debug** (bool, optional): Logs everything to the console and w&b Logs page. Defaults to False
+  
+```python
+import evaluate
+import logging
+from seametrics.payload.processor import PayloadProcessor
+
+logging.basicConfig(level=logging.WARNING)
+
+# Configure your dataset and model details
+payload = PayloadProcessor(
+    dataset_name="SENTRY_VIDEOS_DATASET_QA",
+    gt_field="ground_truth_det_fused_id",
+    models=["ahoy_IR_b2_engine_3_7_0_757_g8765b007_oversea"],
+    sequence_list=["Sentry_2023_02_08_PROACT_CELADON_@6m_MOB_2023_02_08_14_41_51"],
+    tracking_mode=True
+).payload
+
+
+# Evaluate using SEA-AI/user-friendly-metrics
+module = evaluate.load("SEA-AI/user-friendly-metrics")
+res = module._compute(payload, max_iou=0.5, recognition_thresholds=[0.3, 0.5, 0.8])
+
+module.wandb(res,log_plots=True, debug=True)
+```
+
+
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/65ca2aafdc38a2858aa43f1e/RYEsFwt6K-jP0mp7_RIZv.png)
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/65ca2aafdc38a2858aa43f1e/BK0LqOAahukp6filT3ODb.png)
+
 ## Citations
 
 ```bibtex {"id":"01HPS3ASFJXVQR88985GKHAQRE"}