*************
tools package
*************

The Tools Package provides various tools for working with Faceswap outside of the core functionality.

.. contents:: Contents
   :local:

Subpackages
===========

.. toctree::
   :maxdepth: 1

   manual

alignments module
=================
.. automodule:: tools.alignments.alignments
   :members:
   :undoc-members:
   :show-inheritance:

mask module
===========

.. automodule:: tools.mask.mask
   :members:
   :undoc-members:
   :show-inheritance:

preview module
===============

.. rubric:: Module Summary

.. autosummary::
   :nosignatures:
   
   ~tools.preview.preview.ActionFrame
   ~tools.preview.preview.ConfigFrame
   ~tools.preview.preview.ConfigTools
   ~tools.preview.preview.FacesDisplay
   ~tools.preview.preview.ImagesCanvas
   ~tools.preview.preview.OptionsBook
   ~tools.preview.preview.Patch
   ~tools.preview.preview.Preview
   ~tools.preview.preview.Samples

.. rubric:: Module

.. automodule:: tools.preview.preview
   :members:
   :undoc-members:
   :show-inheritance: