facebookresearch / pytorch3d

PyTorch3D is FAIR's library of reusable components for deep learning with 3D data
https://pytorch3d.org/
Other
8.81k stars 1.32k forks source link

Update chamfer.py documentation #1550

Closed alecjacobson closed 1 year ago

alecjacobson commented 1 year ago

Fixes https://github.com/facebookresearch/pytorch3d/issues/1548 by indicating in the documentation that this function computes the bi-directional chamfer distance.

facebook-github-bot commented 1 year ago

Hi @alecjacobson!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

alecjacobson commented 1 year ago

CLA should be signed now.

facebook-github-bot commented 1 year ago

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

bottler commented 1 year ago

Thanks for this! The issue was actually fixed in a different way in https://github.com/facebookresearch/pytorch3d/commit/5ffeb4d580f5c7043ed1691e49d2d99f0f655bbc : It enables single-directional chamfer to be calculated as an option. I think the docstring is now explanatory enough, but perhaps a formula like yours here for the default case could still be useful.