Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
haruishi43 committed Apr 7, 2024
1 parent 65ccb7c commit 4297a67
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
- Compatible with `cuda` tensors for faster processing.
- No need for other dependencies except for `numpy` and `torch`.
- Added functionality like creating rotation matrices, batched processing, and automatic type detection.
- Works with various input modals
- Highly modular

If you found this module helpful to your project, please site this repository:
Expand Down Expand Up @@ -73,6 +74,11 @@ There are no _real_ differences in `class` or `func` APIs:

Each API automatically detects the input type (`numpy.ndarray` or `torch.Tensor`), and outputs are the same type.

The arguments for each `class` or `func` depends on the transform, but here are the common arguments:
- `z_down (bool)`: whether to use a coordinate system with z-axis pointing down, defaults to `False`
- `mode (str)`: interpolation mode, defaults to `bilinear`
- `clip_output (bool)`: whether to clip values based on the range of the input values, default to `True`

An example for `Equi2Pers`/`equi2pers`:

<table>
Expand Down

0 comments on commit 4297a67

Please sign in to comment.