Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #41

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@
[![Unittests](https://github.com/google-research/visu3d/actions/workflows/pytest_and_autopublish.yml/badge.svg)](https://github.com/google-research/visu3d/actions/workflows/pytest_and_autopublish.yml)
[![PyPI version](https://badge.fury.io/py/visu3d.svg)](https://badge.fury.io/py/visu3d)

### Is v3d for you ?
### Is v3d for you?

Yes!

Despite the name, `visu3d` is not limited at all to visualization, nor 3d, but
it can be used in all ML programs (and beyond).

The library provides an abstraction layer on top of TF/Jax/Numpy (same code works
The library provides an abstraction layer on top of TF/Jax/Numpy (the same code works
everywhere) at various levels:

* **For all ML programs:** v3d introduces the `DataclassArray` abstraction which
significantly reduces boilerplate/verbosity when manipulating datastructures
significantly reduces boilerplate/verbosity when manipulating data structures
by adding numpy-like indexing and vectorization to `dataclasses`. (Future
plans will move this to an independent module.)

Expand All @@ -27,15 +27,15 @@ On top of `DataclassArray`, v3d introduces:

Everything in `v3d` is extensible:

* Your codebase can gradually opt in to specific features you need (e.g.
* Your codebase can gradually opt into specific features you need (e.g.
trivially migrate your `dataclass` to `v3d.DataclassArray` without any other
changes).
* Combine native v3d primitives with your custom ones (see doc below).

On top of the `v3d` primitives:

* **Best Colab experience:** Everything is trivially visualizable with zero
boilerplate. Inspect & debug camera poses, trajectories,....
boilerplate. Inspect & debug camera poses, and trajectories,...

### Core features

Expand Down Expand Up @@ -110,7 +110,7 @@ With native support for auto-diff, `jax.vmap`, `jax.tree_utils`,...

<section class="zippy">

Common primitives (`Ray`, `Camera`, `Transform`,...), so user can express
Common primitives (`Ray`, `Camera`, `Transform`,...), so the user can express
intent, instead of math.

```python
Expand Down Expand Up @@ -139,7 +139,7 @@ for a full list of primitive.

Creating your own primitives is trivial.

Converting any dataclass to dataclass array is trivial:
Converting any dataclass to a dataclass array is trivial:

* Inherit from `v3d.DataclassArray`
* Use
Expand Down