vis4d 1.0.0
Vis4D: Python package for Visual 4D scene understanding
License: Apache 2.0
Requires Python: >=3.11

<p align="center">
    <!-- pypi-strip -->
    <picture>
    <!-- /pypi-strip -->
    <img alt="vis4d" src="https://dl.cv.ethz.ch/vis4d/vis4d_logo.svg" width="400">
    <!-- pypi-strip -->
    </picture>
    <!-- /pypi-strip -->
    <br/>
    A modular library for 4D scene understanding
</p>

## Quickstart

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.

## Installation

Installation is as easy as

```bash
python3 -m pip install vis4d
```

[For more detailed information, check out our installation guide](https://vis4d.readthedocs.io/en/latest/user_guide/install.html)

## Basic CLI usage

- To train a model, e.g. Faster-RCNN on COCO

```bash
# vis4d.engine
vis4d 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
```

## DDP

### Training

- Local machine / SLURM interactivate job (`job-name=bash`)

```bash
vis4d fit --config <config-file> --gpus <num-gpus>
```

- SLURM

```bash
srun vis4d fit --config <config-file> --gpus <num-gpus>
```

### Testing

- Local machine / SLURM interactivate job (`job-name=bash`)

```bash
vis4d test --config <config-file> --gpus <num-gpus>
```

- SLURM

```bash
srun vis4d test --config <config-file> --gpus <num-gpus>
```

## Acknowledgement
Vis4D is a group effort by our team at ETH Zurich.
[Yung-Hsu Yang](https://royyang0714.github.io/) built the current version and will be the main maintainer of the codebase.

Vis4D was originally written by [Tobias Fischer](https://tobiasfshr.github.io/) during the first three years of his Ph.D. at ETH Zurich, [Thomas E. Huang](https://www.thomasehuang.com/) helped contribute many models, [Tao Sun](https://www.suniique.com/) implemented the ViT models and designed the evaluation pipeline, and[René Zurbrügg](https://github.com/renezurbruegg) designed the config system.


## Contributors
**Project Leads**
- [Yung-Hsu Yang](https://royyang0714.github.io/)*
- [Tobias Fischer](https://tobiasfshr.github.io/)*
 
**Core Contributors**
- [Thomas E. Huang](https://www.thomasehuang.com/)*
- [Tao Sun](https://www.suniique.com/)
- [René Zurbrügg](https://renezurbruegg.github.io/)
 
**Advisors**
- [Fisher Yu](https://www.yf.io/)
 
`*` denotes equal contribution

**We are open to contributions and suggestions, feel free to reach out to us.**

[Check out our contribution guidelines for this project](docs/source/dev_guide/contribute.rst)

**Community Contributors**
 
<a href="https://github.com/SysCV/vis4d/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=SysCV/vis4d" />
</a>


## Citation

If you find Vis4D is useful for your research, please consider citing the following BibTeX entry.

```bibtex
@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}
}
```