Skip to main content

Vis4D: Python package for Visual 4D scene understanding

Project description

vis4d
A modular library for 4D scene understanding

Quickstart

You can checkout our documentation.

You can use the template here to start your own project with Vis4D.

Installation

Installation is as easy as

python3 -m pip install vis4d

For more detailed information, check out our installation guide

Basic CLI usage

  • To train a model, e.g. Faster-RCNN on COCO
# vis4d.engine
vis4d fit --config vis4d/zoo/faster_rcnn/faster_rcnn_coco.py --gpus 1
  • To test a model
# 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)
vis4d fit --config <config-file> --gpus <num-gpus>
  • SLURM
srun vis4d fit --config <config-file> --gpus <num-gpus>

Testing

  • Local machine / SLURM interactivate job (job-name=bash)
vis4d test --config <config-file> --gpus <num-gpus>
  • SLURM
srun vis4d test --config <config-file> --gpus <num-gpus>

Acknowledgement

Vis4D is a group effort by our team at ETH Zurich. Yung-Hsu Yang built the current version and will be the main maintainer of the codebase.

Vis4D was originally written by Tobias Fischer during the first three years of his Ph.D. at ETH Zurich, Thomas E. Huang helped contribute many models, Tao Sun implemented the ViT models and designed the evaluation pipeline, andRené Zurbrügg designed the config system.

Contributors

Project Leads

Core Contributors

Advisors

* 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

Community Contributors

Citation

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vis4d-1.0.0.tar.gz (384.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vis4d-1.0.0-py3-none-any.whl (601.3 kB view details)

Uploaded Python 3

File details

Details for the file vis4d-1.0.0.tar.gz.

File metadata

  • Download URL: vis4d-1.0.0.tar.gz
  • Upload date:
  • Size: 384.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for vis4d-1.0.0.tar.gz
Algorithm Hash digest
SHA256 0bca6d1b7a805e06486ebe153835fa0866fc5d24710e31b761e2b173b50d9f42
MD5 3d38dbcbae0191f962b8c4b86c77dfe7
BLAKE2b-256 36191c4103a29eb27912dd793a9bf854806dbb32c0573426a2a27f143f18188b

See more details on using hashes here.

File details

Details for the file vis4d-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: vis4d-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 601.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for vis4d-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 84afa1d83d6dbc638c50025d312b21ee5d45d11dda204e1be1c3af7b9102650f
MD5 fe3f16cde4947e2e42d0315f7230c4f3
BLAKE2b-256 750eaafe703e323712aaf8e61d120706662fad1abbe502d387d9024649fa19a4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page