pytorch3d
pytorch3d copied to clipboard
DOC: `se3_log_map` does not highlight that `eps` and `cos_bound` are unused
Reading through the documentation for se3_log_map, I was under the impression that eps and cos_bound were important for numerical stability:
https://github.com/facebookresearch/pytorch3d/blob/43cd681d4fc55fefa9a47e70d3ca0a02818ce44a/pytorch3d/transforms/se3.py#L142-L147
However, following #1609 and 292acc7 it appeared that eps and cos_bound are only retained for backwards compatibility in so3_log_map (Note the o instead of e). This is made clear in the corresponding documentation:
https://github.com/facebookresearch/pytorch3d/blob/43cd681d4fc55fefa9a47e70d3ca0a02818ce44a/pytorch3d/transforms/so3.py#L184-L185
Now, given that se3_log_map calls so3_log_map,
https://github.com/facebookresearch/pytorch3d/blob/43cd681d4fc55fefa9a47e70d3ca0a02818ce44a/pytorch3d/transforms/se3.py#L173
I believe the deprecation of eps and cos_bound should also be highlighted in teh documentation of se3_log_map.