v1.0.0

README.md

@@ -2,7 +2,7 @@
     <!-- pypi-strip -->
     <picture>
     <!-- /pypi-strip -->
-    <img alt="vis4d" src="docs/source/_static/vis4d_logo.svg" width="400">
+    <img alt="vis4d" src="https://dl.cv.ethz.ch/vis4d/vis4d_logo.svg" width="400">
     <!-- pypi-strip -->
     </picture>
     <!-- /pypi-strip -->
@@ -85,7 +85,7 @@ Vis4D was originally written by [Tobias Fischer](https://tobiasfshr.github.io/)
 - [Tobias Fischer](https://tobiasfshr.github.io/)*
 
 **Core Contributors**
-- [Thomas E. Huang](https://www.thomasehuang.com/)
+- [Thomas E. Huang](https://www.thomasehuang.com/)*
 - [Tao Sun](https://www.suniique.com/)
 - [René Zurbrügg](https://renezurbruegg.github.io/)
 
@@ -110,9 +110,9 @@ Vis4D was originally written by [Tobias Fischer](https://tobiasfshr.github.io/)
 If you find Vis4D is useful for your research, please consider citing the following BibTeX entry.
 
 ```bibtex
-@misc{vis4d_2024,
-  author = {{Yung-Hsu Yang and Tobias Fischer and Thomas E. Huang} and René Zurbrügg and Tao Sun and Fisher Yu},
-  title = {Vis4D},
+@misc{vis4d2024,
+  author = {Yang, Yung-Hsu and Fischer, Tobias and Huang, Thomas E. and Zurbr{\"u}gg, Ren{\'e} and Sun, Tao and Yu, Fisher},
+  title = {Vis4{D}},
   howpublished = {\url{https://github.com/SysCV/vis4d}},
   year = {2024}
 }

docs/source/conf.py

@@ -23,7 +23,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "Vis4D"
-copyright = "2022, ETH Zurich"
+copyright = "2024, ETH Zurich"
 author = "Vis4D Team"
 
 
@@ -56,7 +56,7 @@
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
-source_suffix = [".rst", ".ipynb"]
+source_suffix = [".rst", ".ipynb", ".md"]
 
 # The master toctree document.
 master_doc = "index"
@@ -70,17 +70,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "furo"
-
-# TODO revise logo
-html_theme_options = {
-    "light_logo": "vis4d_logo.svg",
-    "dark_logo": "vis4d_logo.svg",
-    "sidebar_hide_name": True,
-    "navigation_with_keys": True,
-}
-
-# html_favicon = '_static/img/logo_favicon.png'
+html_theme = "sphinx_rtd_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -133,5 +123,10 @@
 
 # -- MYSTNB -----------------------------------------------------------------
 
-suppress_warnings = ["mystnb.unknown_mime_type", "myst.header"]
+suppress_warnings = [
+    "mystnb.unknown_mime_type",
+    "myst.header",
+    "ref.python",
+    "docutils",
+]
 nb_execution_mode = "off"

docs/source/contribute.md

@@ -0,0 +1,33 @@
+
+# How to Contribute
+
+To contribute to the codebase, users should create a pull request in the GitHub repository.
+
+To do this, first checkout the latest main branch with:
+
+```bash
+git checkout main
+git pull
+```
+
+Next, you can make the code changes that you’d like to contribute.
+
+After making your changes, please make sure to resolve all the code formatting and documentation issues that may arise by checking:
+
+```bash
+bash scripts/lint.sh
+```
+
+If you see any errors or warnings as output of this, please correct them and run this script again until there are no issues anymore.
+
+Once you pass all linting checks, you can commit your changes to a new branch:
+
+```bash
+git checkout -b my-feature
+git commit -m "awesome new feature"
+git push
+```
+
+Finally, you can create your pull request on the GitHub repo website and request tobiasfshr or other maintaining members as reviewer.
+
+Once your pull request is approved, it will be merged to the main branch.

docs/source/dev_guide/callback.md

@@ -0,0 +1,56 @@
+# Callbacks
+
+We use PyTorch Lightning [Callbacks](https://lightning.ai/docs/pytorch/stable/api/lightning.pytorch.callbacks.Callback.html#lightning.pytorch.callbacks.Callback) to support various functionality.
+
+Each callback relies on `Callback Connector` to connect between data, model, and callbacks.
+
+For each config, the default callback is logging callback which helps to logging the output of console.
+
+```python
+def get_default_callbacks_cfg(
+    epoch_based: bool = True,
+    refresh_rate: int = 50,
+) -> list[ConfigDict]:
+    """Get default callbacks config.
+
+    It will return a list of callbacks config including:
+        - LoggingCallback
+
+    Args:
+        epoch_based (bool, optional): Whether to use epoch based logging.
+        refresh_rate (int, optional): Refresh rate for the logging. Defaults to
+            50.
+
+    Returns:
+        list[ConfigDict]: List of callbacks config.
+    """
+    callbacks = []
+
+    # Logger
+    callbacks.append(
+        class_config(
+            LoggingCallback, epoch_based=epoch_based, refresh_rate=refresh_rate
+        )
+    )
+
+    return callbacks
+```
+
+You can hook any `Callback` in the config as follow:
+
+```python
+callbacks.append(
+    class_config(
+        EvaluatorCallback,
+        evaluator=class_config(
+            COCODetectEvaluator, data_root=data_root, split=test_split
+        ),
+        metrics_to_eval=["Det"],
+        test_connector=class_config(
+            CallbackConnector, key_mapping=CONN_COCO_BBOX_EVAL
+        ),
+    )
+)
+```
+
+Check more details [here](https://github.com/SysCV/vis4d/tree/main/vis4d/engine/callbacks).