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

docs - revise heading levels for feature detection (images) #6029

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 4 additions & 7 deletions docs/advanced_topics/images/feature_detection.rst
Expand Up @@ -18,13 +18,10 @@ Two third-party tools are known to work with Wagtail: One based on OpenCV_ for g
.. _Rustface: https://github.com/torchbox/rustface-py/

OpenCV on Debian/Ubuntu
~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^

Feature detection requires OpenCV_ which can be a bit tricky to install as it's not currently pip-installable.

Installation options
~~~~~~~~~~~~~~~~~~~~

There is more than one way to install these components, but in each case you will need to test that both OpenCV itself *and* the Python interface have been correctly installed.


Expand Down Expand Up @@ -77,7 +74,7 @@ If you don't get an import error, installation has probably been successful.


Rustface
~~~~~~~~
^^^^^^^^

Rustface_ is Python library with prebuilt wheel files provided for Linux and macOS. Although implemented in Rust it is pip-installable:

Expand All @@ -88,7 +85,7 @@ Rustface_ is Python library with prebuilt wheel files provided for Linux and mac


Registering with Willow
^^^^^^^^^^^^^^^^^^^^^^^
```````````````````````

Rustface provides a plug-in that needs to be registered with Willow_.

Expand All @@ -109,7 +106,7 @@ For example, in an app's AppConfig.ready_.


Cropping
^^^^^^^^
--------

The face detection algorithm produces a focal area that is tightly cropped to the face rather than the whole head.

Expand Down