v0.1.3

.github/workflows/ci.yml

@@ -19,7 +19,7 @@ jobs:
       - name: set up python
         uses: actions/setup-python@v2
         with:
-          python-version: "3.10"
+          python-version: "3.11"
 
       - name: install
         run: |
@@ -55,11 +55,11 @@ jobs:
           python3 -m mypy tests
 
   test:
-    name: test py${{ matrix.python-version }}
+    name: test
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.10"]
+        python-version: ["3.11"]
 
     steps:
       - uses: actions/checkout@v2
@@ -89,7 +89,7 @@ jobs:
         run: python3 -m coverage run --source=vis4d -m pytest --pyargs tests
 
       - name: test coverage
-        run: python3 -m coverage report --fail-under=88 -m
+        run: python3 -m coverage report -m
 
       - name: build
         run: python3 -m build

.gitignore

@@ -61,14 +61,13 @@ doc/media
 # python build
 build/
 dist/
-scalabel.egg-info
+vis4d.egg-info
 
 # coverage
 .coverage*
 
 # package default workspace
 vis4d-workspace
-vis4d.egg-info
 
 *.tmp
 

.gitmodules

@@ -1,4 +1,4 @@
 [submodule "vis4d-test-data"]
-	path = tests/vis4d-test-data
-	url = git@github.com:SysCV/vis4d-test-data.git
+    path = tests/vis4d-test-data
+    url = git@github.com:SysCV/vis4d-test-data.git
     branch = main

.pylintrc

@@ -411,6 +411,7 @@ max-spelling-suggestions=2
 
 # Maximum number of arguments for function / method
 max-args=20
+max-positional-arguments=20
 
 # Maximum number of locals for function / method body
 max-locals=100

.readthedocs.yaml

@@ -8,6 +8,9 @@ build:
 python:
   install:
     - requirements: docs/requirements.txt
+    - requirements: requirements/install.txt
+    - requirements: requirements/torch-lib.txt
+    - requirements: requirements/viewer.txt
 
 sphinx:
   configuration: docs/source/conf.py

docs/requirements.txt

@@ -5,4 +5,5 @@ sphinx_autodoc_defaultargs
 sphinx_autodoc_typehints
 sphinx_copybutton
 sphinx_design
+sphinx_rtd_theme
 sphinxcontrib-aafig

docs/source/conf.py

@@ -24,7 +24,7 @@
 
 project = "Vis4D"
 copyright = "2022, ETH Zurich"
-author = "Tobias Fischer"
+author = "Vis4D Team"
 
 
 # -- General configuration ---------------------------------------------------
@@ -94,21 +94,22 @@
         "Vis4D Documentation",
         author,
         "Vis4D",
-        "Dynamic Scene Understanding in Pytorch.",
+        "Dynamic Scene Understanding in PyTorch.",
         "Miscellaneous",
     )
 ]
 
 # -- auto doc settings -------------------------------------------------------
 autosummary_generate = True
 autodoc_member_order = "groupwise"
-autoclass_content = "both"
+# autoclass_content = "both"
 add_module_names = False  # Remove namespaces from class/method signatures
+autodoc_member_order = "bysource"
 autodoc_default_options = {
     "members": True,
     "methods": True,
     "special-members": "__call__",
-    "exclude-members": "_abc_impl,__init__",
+    "exclude-members": "_abc_impl,__repr__",
 }
 
 # -- Napoleon settings -------------------------------------------------------
@@ -117,7 +118,7 @@
 # project.
 napoleon_google_docstring = True
 napoleon_numpy_docstring = False
-napoleon_include_init_with_doc = False
+napoleon_include_init_with_doc = True
 napoleon_include_private_with_doc = False
 napoleon_include_special_with_doc = True
 napoleon_use_admonition_for_examples = False

docs/source/datasets.rst

@@ -0,0 +1,3 @@
+********
+Datasets
+********

docs/source/dev_guide/cli.rst

@@ -1,17 +1,19 @@
 ###
 CLI
 ###
+
 We provide a command line interface for training and evaluating your models.
 Assuming you have installed the package using pip, you can use the command `vis4d` to access the CLI.
 
-Alternatively, you can run the CLI using `python -m vis4d.engine.cli` or `python -m vis4d.pl.cli` if you want to use the PyTorch Lightning version.
+Alternatively, you can run the CLI using `python -m vis4d.engine.run` or `python -m vis4d.pl.run` if you want to use the PyTorch Lightning version.
 
 The CLI relies on a configuration file to specify each experiment. We use `ml_collections <https://github.com/google/ml_collections>`_ as underlying framework to define the configuration files.
 You can read up on our configuration files in the `Config System <configuration_files>`_ section.
 
 =============
 CLI Interface
 =============
+
 The provided examples assume that the experiment configuration file is located at `path_to_experiment_cfg.py`.
 You can read up on our configuration files in the `Config System <configuration_files>`_ section.
 
@@ -20,6 +22,7 @@ We support both, our own training engine as well as `PyTorch Lightning <https://
 ------------
 CLI Commands
 ------------
+
 .. code-block:: bash
 
   vis4d [fit | test] --config path_to_experiment_cfg.py
@@ -54,16 +57,14 @@ Quick Start
 
 .. code-block:: bash
 
-   vis4d fit --config path_to_experiment_cfg.py
+   vis4d test --config path_to_experiment_cfg.py
 
 **Overwrite Config Parameters**
 
 .. code-block:: bash
 
    vis4d fit --config path_to_experiment_cfg.py --config.my_field=2 --config.my.nested.field="test"
 
-
-
 **Perform Parameter Sweeps**
 
 .. code-block:: bash
@@ -87,6 +88,7 @@ Note that misstyping a config parameter
    vis4d fit --config path_to_experiment_cfg.py --config.params.lrs=0.01
 
 will result in the following error:
+
 .. code-block:: bash
 
-   AttributeError: Did you mean "lr" instead of "lrw"?'
+   AttributeError: Did you mean "lr" instead of "lrs"?'

docs/source/faq/trouble.rst

@@ -2,10 +2,6 @@
 Troubleshooting
 ***************
 
-================
-Training crashes
-================
-
 -----------
 File limits
 -----------

docs/source/index.rst

@@ -44,7 +44,6 @@ for further research and development of 4D Vision algorithms.
 
 .. toctree::
     :hidden:
-    :maxdepth: 1
     :caption: Reference
 
     API<api/vis4d>

docs/source/user_guide/3D_visualization.ipynb

@@ -20,7 +20,7 @@
     "os.environ[\"WEBRTC_IP\"] = \"127.0.0.1\"\n",
     "\n",
     "import pickle\n",
-    "from vis4d.vis.functional import show_points\n",
+    "from vis4d.vis.pointcloud.functional import show_points\n",
     "import numpy as np"
    ]
   },

docs/source/user_guide/faster_rcnn_example.py

@@ -6,7 +6,7 @@
 
 import lightning.pytorch as pl
 import numpy as np
-from torch.optim import SGD
+from torch.optim.sgd import SGD
 from torch.optim.lr_scheduler import LinearLR, MultiStepLR
 
 from vis4d.config import class_config
@@ -137,7 +137,7 @@ def get_config() -> ExperimentConfig:
     ##                     CALLBACKS                    ##
     ######################################################
     # Logger and Checkpoint
-    callbacks = get_default_callbacks_cfg(config.output_dir, refresh_rate=1)
+    callbacks = get_default_callbacks_cfg(refresh_rate=1)
 
     # Evaluator
     callbacks.append(

docs/source/user_guide/getting_started.ipynb

@@ -251,7 +251,7 @@
     "from vis4d.model.detect.faster_rcnn import FasterRCNN\n",
     "\n",
     "from vis4d.data.const import CommonKeys as K\n",
-    "from vis4d.vis.functional.image import imshow_bboxes\n",
+    "from vis4d.vis.image.functional import imshow_bboxes\n",
     "\n",
     "from vis4d.config import instantiate_classes\n",
     "from vis4d.zoo.base.datasets.coco import get_coco_detection_cfg"

docs/source/user_guide/visualization.ipynb

@@ -15,22 +15,12 @@
    "cell_type": "code",
    "execution_count": 1,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Jupyter environment detected. Enabling Open3D WebVisualizer.\n",
-      "[Open3D INFO] WebRTC GUI backend enabled.\n",
-      "[Open3D INFO] WebRTCWindowSystem: HTTP handshake server disabled.\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "from __future__ import annotations\n",
     "\n",
     "from vis4d.common.typing import NDArrayF64, NDArrayI64\n",
-    "from vis4d.vis.functional import imshow_bboxes, imshow_masks, imshow_topk_bboxes, imshow, draw_bboxes, draw_masks, imshow_track_matches\n",
+    "from vis4d.vis.image.functional import imshow_bboxes, imshow_masks, imshow_topk_bboxes, imshow, draw_bboxes, draw_masks, imshow_track_matches\n",
     "\n",
     "import pickle\n",
     "import numpy as np"
@@ -453,7 +443,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.8"
+   "version": "3.11.9"
   },
   "vscode": {
    "interpreter": {

pyproject.toml

@@ -14,6 +14,7 @@ line_length = 79
 
 [tool.pyright]
 include = ["vis4d"]
+typeCheckingMode = "off"
 
 [tool.coverage]
     [tool.coverage.report]
@@ -112,12 +113,12 @@ plugins = ["numpy.typing.mypy_plugin"]
 
 [project]
 name = "vis4d"
-version = "0.1.2"
-authors = [{name = "VIS @ ETH", email = "i@yf.io"}]
+version = "0.1.3"
+authors = [{name = "Vis4D Team"}]
 description = "Vis4D Python package for Visual 4D scene understanding"
 readme = "README.md"
 license = {text = "Apache 2.0"}
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 classifiers = [
     "Programming Language :: Python :: 3",
     "License :: OSI Approved :: Apache Software License",