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.

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

[vpdq] Add vpdq Dockerfile for development #1599

Merged
merged 1 commit into from
Jul 1, 2024

Conversation

ianwal
Copy link
Contributor

@ianwal ianwal commented Jun 30, 2024

Summary

  • Add Dockerfile for development convenience
    • Note: User still needs to setup and use venv for the Python bindings. This container is just for setting up an environment. But pip install -e . works out the box for the bindings.
  • Add devcontainer config to use the Dockerfile with VSCode
    • Autogenerated by the devcontainer VSCode extension.
  • Add Docker documentation
  • Added the missing pkg-config to dependencies
  • Fixed some documentation markdown issues

Not sure the best practice if other devcontainers are added to the repo, but for now this works.

Test Plan

Markdown renders as expected.

Container builds successfully.

vpdq and Python bindings build successfully and pass all tests in the container.

Copy link
Contributor

@Dcallies Dcallies left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks again @ianwal! I hope whatever it is you are building back there is going well!

[FAISS](https://github.com/facebookresearch/faiss) has been successfully integrated with vPDQ in the [python-threatexchange](../python-threatexchange/threatexchange/extensions/vpdq) library. See the [README](../python-threatexchange/threatexchange/extensions/vpdq/README.md) for more information.

## Contact

[email protected]

[email protected]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice spot!

@Dcallies Dcallies merged commit f653b62 into facebook:main Jul 1, 2024
2 checks passed
@ianwal ianwal deleted the add-dockerfile branch July 1, 2024 20:42
@ianwal
Copy link
Contributor Author

ianwal commented Jul 2, 2024

Thanks again @ianwal! I hope whatever it is you are building back there is going well!

No problem, thanks for giving good feedback in these PRs! Working on this and my project that uses was a huge help in getting my firmware engineer job, so I like coming back and making some improvements to it as I learn more over time 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants