Skip to main content

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

Metadata

Release files for vis4d 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vis4d 1.0.0
File Size Uploaded Provenance Actions
vis4d-1.0.0.tar.gz 384.2 kB Without provenance Details for vis4d-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for vis4d 1.0.0
File Interpreter ABI Platform Actions
vis4d-1.0.0-py3-none-any.whl Python 3 none any Details for vis4d-1.0.0-py3-none-any.whl

Total release size: 985.5 kB

Release files / vis4d-1.0.0.tar.gz

Download URL vis4d-1.0.0.tar.gz
Size 384.2 kB
Tags Source
SHA-256 checksum
How to use checksums
0bca6d1b7a805e06486ebe153835fa0866fc5d24710e31b761e2b173b50d9f42
BLAKE2b-256 checksum
How to use checksums
36191c4103a29eb27912dd793a9bf854806dbb32c0573426a2a27f143f18188b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.9

Release files / vis4d-1.0.0-py3-none-any.whl

Download URL vis4d-1.0.0-py3-none-any.whl
Size 601.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
84afa1d83d6dbc638c50025d312b21ee5d45d11dda204e1be1c3af7b9102650f
BLAKE2b-256 checksum
How to use checksums
750eaafe703e323712aaf8e61d120706662fad1abbe502d387d9024649fa19a4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.9

Security for vis4d 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page