feat: Update CC-3DT++ and config refactor.

Author: RoyYang0714

README.md

@@ -12,7 +12,7 @@
 
 ## Quickstart
 
-You can checkout our [documentation](https://docs.vis.xyz/4d/index.html).
+You can checkout our [documentation](https://vis4d.readthedocs.io).
 
 You can use the [template](https://github.com/SysCV/vis4d-template) here to start your own project with Vis4D.
 
@@ -24,7 +24,7 @@ Installation is as easy as
 python3 -m pip install vis4d
 ```
 
-[For more detailed information, check out our installation guide](docs/source/user_guide/install.rst)
+[For more detailed information, check out our installation guide](https://vis4d.readthedocs.io/en/latest/user_guide/install.html)
 
 ## Basic CLI usage
 
@@ -33,19 +33,13 @@ python3 -m pip install vis4d
 ```bash
 # vis4d.engine
 vis4d fit --config vis4d/zoo/faster_rcnn/faster_rcnn_coco.py --gpus 1
-
-# vis4d.pl
-vis4d-pl fit --config vis4d/zoo/faster_rcnn/faster_rcnn_coco.py --gpus 1
 ```
 
 - To test a model
 
 ```bash
 # vis4d.engine
 vis4d test --config vis4d/zoo/faster_rcnn/faster_rcnn_coco.py --gpus 1
-
-# vis4d.pl
-vis4d-pl test --config vis4d/zoo/faster_rcnn/faster_rcnn_coco.py --gpus 1
 ```
 
 ## DDP
@@ -55,43 +49,27 @@ vis4d-pl test --config vis4d/zoo/faster_rcnn/faster_rcnn_coco.py --gpus 1
 - Local machine / SLURM interactivate job (`job-name=bash`)
 
 ```bash
-# vis4d.engine
-./scripts/dist_train.sh <config-file> <num-gpus>
-
-# vis4d.pl
-vis4d-pl fit --config <config-file> --gpus <num-gpus>
+vis4d fit --config <config-file> --gpus <num-gpus>
 ```
 
 - SLURM
 
 ```bash
-# vis4d.engine
-srun vis4d fit --config <config-file> --gpus <num-gpus> --slurm True
-
-# vis4d.pl
-srun vis4d-pl fit --config <config-file> --gpus <num-gpus>
+srun vis4d fit --config <config-file> --gpus <num-gpus>
 ```
 
 ### Testing
 
 - Local machine / SLURM interactivate job (`job-name=bash`)
 
 ```bash
-# vis4d.engine
-./scripts/dist_test.sh <config-file> <num-gpus>
-
-# vis4d.pl
-vis4d-pl test --config <config-file> --gpus <num-gpus>
+vis4d test --config <config-file> --gpus <num-gpus>
 ```
 
 - SLURM
 
 ```bash
-# vis4d.engine
-srun vis4d test --config <config-file> --gpus <num-gpus> --slurm True
-
-# vis4d.pl
-srun vis4d-pl test --config <config-file> --gpus <num-gpus>
+srun vis4d test --config <config-file> --gpus <num-gpus>
 ```
 
 ## Acknowledgement

pyproject.toml

@@ -136,11 +136,10 @@ dependencies = {file = ["requirements/install.txt"]}
 include = ["vis4d*"]
 
 [project.urls]
-"Documentation" = "https://docs.vis.xyz/4d"
+"Documentation" = "https://vis4d.readthedocs.io"
 "Source" = "https://github.com/syscv/vis4d"
-"Tracker" = "https://github.com/syscv/"
+"Tracker" = "https://github.com/syscv/vis4d/issues"
 
 [project.scripts]
 vis4d = "vis4d.engine.run:entrypoint"
-vis4d-pl = "vis4d.pl.run:entrypoint"
 vis4d-zoo = "vis4d.zoo.run:entrypoint"

scripts/eval_nusc/README.md

@@ -10,19 +10,16 @@ pip install -r nusc.txt
 ```
 
 ### Run
-- $WORK_DIR is your output folder which contains the prediction json file.
-- $VERSION is `mini` or `trainval` to select mini or validation split.
-
 ```bash
 # Detection
-python eval.py \
+python run.py \
 --input $FOLDER_OF_PREDICTION \
 --version $VERSION \
 --dataroot $NUSC_DATA_ROOT \
 --mode detection
 
 # Tracking
-python eval.py \
+python run.py \
 --input $FOLDER_OF_PREDICTION \
 --version $VERSION \
 --dataroot $NUSC_DATA_ROOT \

scripts/eval_nusc/eval.py scripts/eval_nusc/run.pyscripts/eval_nusc/eval.py renamed to scripts/eval_nusc/run.py

@@ -97,13 +97,14 @@ def print_metric_summary(metric_summary_path: str) -> None:
     parser.add_argument(
         "--version",
         "-v",
-        choices=["v1.0-trainval", "v1.0-test", "v1.0-mini"],
+        choices=["trainval", "mini"],
         help="NuScenes dataset version to convert.",
     )
     parser.add_argument(
         "--dataroot",
         "-d",
         help="NuScenes dataset root.",
+        default="./data/nuscenes",
     )
     parser.add_argument(
         "-m",
@@ -120,7 +121,7 @@ def print_metric_summary(metric_summary_path: str) -> None:
         metric = "track_3d"
 
     evaluate(
-        args.version,
+        f"v1.0-{args.version}",
         args.dataroot,
         args.mode,
         args.input,

tests/vis4d-test-data

@@ -115,7 +115,9 @@ def _filter_detections(
         class_ids: Tensor,
         embeddings: Tensor,
         velocities: Tensor | None = None,
-    ) -> tuple[Tensor, Tensor, Tensor, Tensor, Tensor, Tensor, Tensor, Tensor]:
+    ) -> tuple[
+        Tensor, Tensor, Tensor, Tensor, Tensor, Tensor, Tensor | None, Tensor
+    ]:
         """Remove overlapping objects across classes via nms.
 
         Args:
@@ -239,7 +241,7 @@ def depth_ordering(
             )
             for v in obsvvv_velocities:
                 velsim_weight_list.append(
-                    F.pairwise_distance(
+                    F.pairwise_distance(  # pylint: disable=not-callable
                         v, memory_velocities[:, -3:]
                     ).unsqueeze(0)
                 )

vis4d/op/track3d/cc_3dt.py

@@ -30,7 +30,6 @@ def imshow(
     image: ArrayLike,
     image_mode: str = "RGB",
     image_viewer: ImageViewerBackend = MatplotlibImageViewer(),
-    file_path: str | None = None,
 ) -> None:
     """Shows a single image.
 
@@ -39,7 +38,6 @@ def imshow(
         image_mode (str, optional): Image Mode. Defaults to "RGB".
         image_viewer (ImageViewerBackend, optional): The Image viewer backend
             to use. Defaults to MatplotlibImageViewer().
-        file_path (str): The path to save the image to. Defaults to None.
     """
     image = preprocess_image(image, image_mode)
     image_viewer.show_images([image])
@@ -264,8 +262,6 @@ def imshow_masks(
     n_colors: int = 50,
     image_mode: str = "RGB",
     canvas: CanvasBackend = PillowCanvasBackend(),
-    image_viewer: ImageViewerBackend = MatplotlibImageViewer(),
-    file_path: str | None = None,
 ) -> None:
     """Shows semantic masks overlayed over the given image.
 
@@ -280,14 +276,10 @@ def imshow_masks(
         image_mode (str, optional): Image Mode.. Defaults to "RGB".
         canvas (CanvasBackend, optional): Canvas backend to use.
             Defaults to PillowCanvasBackend().
-        image_viewer (ImageViewerBackend, optional): The Image viewer backend
-            to use. Defaults to MatplotlibImageViewer().
-        file_path (str): The path to save the image to. Defaults to None.
     """
     imshow(
         draw_masks(image, masks, class_ids, n_colors, image_mode, canvas),
         image_mode,
-        image_viewer,
     )
 
 
@@ -427,8 +419,8 @@ def imshow_track_matches(
                 r_canvas = draw_bboxes(
                     ref_image, ref_box[batch_i], image_mode=image_mode
                 )
-                k_canvas = k_canvas.as_numpy_image()
-                r_canvas = r_canvas.as_numpy_image()
-                stacked_img = np.vstack([k_canvas, r_canvas])
+                k_np_img = k_canvas.as_numpy_image()
+                r_np_img = r_canvas.as_numpy_image()
+                stacked_img = np.vstack([k_np_img, r_np_img])
 
                 imshow(stacked_img, image_mode, image_viewer)

vis4d/vis/image/functional.py

@@ -127,7 +127,7 @@ def get_config() -> ExperimentConfig:
         class_config(
             VisualizerCallback,
             visualizer=class_config(BoundingBoxVisualizer, vis_freq=100),
-            save_prefix=config.output_dir,
+            output_dir=config.output_dir,
             test_connector=class_config(
                 CallbackConnector, key_mapping=CONN_BBOX_2D_VIS
             ),

vis4d/zoo/bdd100k/faster_rcnn/faster_rcnn_r50_1x_bdd100k.py

@@ -128,7 +128,7 @@ def get_config() -> ExperimentConfig:
         class_config(
             VisualizerCallback,
             visualizer=class_config(BoundingBoxVisualizer, vis_freq=100),
-            save_prefix=config.output_dir,
+            output_dir=config.output_dir,
             test_connector=class_config(
                 CallbackConnector, key_mapping=CONN_BBOX_2D_VIS
             ),

vis4d/zoo/bdd100k/faster_rcnn/faster_rcnn_r50_3x_bdd100k.py

@@ -133,7 +133,7 @@ def get_config() -> ExperimentConfig:
         class_config(
             VisualizerCallback,
             visualizer=class_config(SegMaskVisualizer, vis_freq=25),
-            save_prefix=config.output_dir,
+            output_dir=config.output_dir,
             test_connector=class_config(
                 CallbackConnector, key_mapping=CONN_INS_MASK_2D_VIS
             ),