faceswap/docs/full/plugins/extract.rst
torzdf 1c081aea7d
Add ability to export and import alignment data (#1383)
* tools.alignments - add export job

* plugins.extract: Update __repr__ for ExtractorBatch dataclass

* plugins.extract: Initial implementation of external import plugins

* plugins.extract: Disable lm masks on ROI alignment data import

* lib.align: Add `landmark_type` property to AlignedFace and return dummy data for ROI Landmarks pose estimate

* plugins.extract: Add centering config item for align import and fix filename mapping for images

* plugins.extract: Log warning on downstream plugins on limited alignment data

* tools: Fix plugins for 4 point ROI landmarks (alignments, sort, mask)

* tools.manual: Fix for 2D-4 ROI landmarks

* training: Fix for 4 point ROI landmarks

* lib.convert: Average color plugin. Avoid divide by zero errors

* extract - external:
  - Default detector to 'external' when importing alignments
  - Handle different frame origin co-ordinates

* alignments: Store video extension in alignments file

* plugins.extract.external: Handle video file keys

* plugins.extract.external: Output warning if missing data

* locales + docs

* plugins.extract.align.external: Roll the corner points to top-left for different origins

* Clean up

* linting fix
2024-04-15 12:19:15 +01:00

128 lines
2.3 KiB
ReStructuredText
Executable File

***************
extract package
***************
The Extract Package handles the various plugins available for extracting face sets in Faceswap.
.. contents:: Contents
:local:
extract\_media module
=====================
.. automodule:: plugins.extract.extract_media
:members:
:undoc-members:
:show-inheritance:
pipeline module
===============
.. automodule:: plugins.extract.pipeline
:members:
:undoc-members:
:show-inheritance:
_base module
============
.. automodule:: plugins.extract._base
:members:
:undoc-members:
:show-inheritance:
align plugins package
=====================
.. contents:: Contents
:local:
align._base.aligner module
--------------------------
.. automodule:: plugins.extract.align._base.aligner
:members:
:undoc-members:
:show-inheritance:
align._base.processing module
-----------------------------
.. automodule:: plugins.extract.align._base.processing
:members:
:undoc-members:
:show-inheritance:
align.cv2_dnn module
--------------------
.. automodule:: plugins.extract.align.cv2_dnn
:members:
:undoc-members:
:show-inheritance:
align.fan module
----------------
.. automodule:: plugins.extract.align.fan
:members:
:undoc-members:
:show-inheritance:
detect plugins package
======================
.. contents:: Contents
:local:
detect._base module
-------------------
.. automodule:: plugins.extract.detect._base
:members:
:undoc-members:
:show-inheritance:
detect.mtcnn module
-------------------
.. automodule:: plugins.extract.detect.mtcnn
:members:
:undoc-members:
:show-inheritance:
mask plugins package
====================
.. contents:: Contents
:local:
mask._base module
-----------------
.. automodule:: plugins.extract.mask._base
:members:
:undoc-members:
:show-inheritance:
mask.bisenet_fp module
----------------------
.. automodule:: plugins.extract.mask.bisenet_fp
:members:
:undoc-members:
:show-inheritance:
recognition plugins package
===========================
.. contents:: Contents
:local:
recognition._base module
------------------------
.. automodule:: plugins.extract.recognition._base
:members:
:undoc-members:
:show-inheritance:
recognition.vgg_face2 module
----------------------------
.. automodule:: plugins.extract.recognition.vgg_face2
:members:
:undoc-members:
:show-inheritance: