[clarify] Rename 'vcm_eval_mode' flag to 'apply_pred_offset'

Author: chrisr-12

compressai_vision/evaluators/evaluators.py

@@ -565,13 +565,13 @@ def __init__(
         dataset,
         output_dir="./vision_output/",
         eval_criteria="MOTA",
-        vcm_eval_mode=False,
+        apply_pred_offset=False,
         **args,
     ):
         super().__init__(
             datacatalog_name, dataset_name, dataset, output_dir, eval_criteria
         )
-        self.vcm_eval_mode = vcm_eval_mode
+        self.apply_pred_offset = apply_pred_offset
 
         self.set_annotation_info(dataset)
 
@@ -613,7 +613,7 @@ def digest(self, gt, pred):
         pred_list = []
         for tlwh, id in zip(pred["tlwhs"], pred["ids"]):
             x1, y1, w, h = tlwh
-            if self.vcm_eval_mode: # Replicate offset applied in load_motchallenge() in motmetrics library, used in VCM eval framework to load predictions from disk
+            if self.apply_pred_offset: # Replicate offset applied in load_motchallenge() in motmetrics library, used in VCM eval framework to load predictions from disk
                 x1 -= 1
                 y1 -= 1
             # x2, y2 = x1 + w, y1 + h

scripts/evaluation/tvd/eval_on_tvdvcm_vcmrs.sh

@@ -95,7 +95,7 @@ compressai-${PIPELINE}-inference --config-name=${CONF_NAME} \
        	++dataset.config.annotation_file=gt/gt.txt \
         ++dataset.config.dataset_name=mpeg-${SEQ} \
         ++evaluator.type=MOT-TVD-EVAL \
-        ++evaluator.vcm_eval_mode=True \
+        ++evaluator.apply_pred_offset=True \
         ++codec.experiment=${EXPERIMENT} \
 	codec=vcmrs.yaml \
         ++codec.encoder_config.intra_period=${INTRA_PERIOD} \