mexca.container
===============

.. py:module:: mexca.container

.. autoapi-nested-parse::

   Containers of pipeline components.



Classes
-------

.. autoapisummary::

   mexca.container.BaseContainer
   mexca.container.FaceExtractorContainer
   mexca.container.SpeakerIdentifierContainer
   mexca.container.VoiceExtractorContainer
   mexca.container.AudioTranscriberContainer
   mexca.container.SentimentExtractorContainer


Module Contents
---------------

.. py:class:: BaseContainer(image_name: str, get_latest_tag: bool = False)

   Base class for container components. Only for internal use.

   :param image_name: Name of docker image. A tag is automatically added from the package version.
   :type image_name: str
   :param get_latest_tag: Whether to pull the latest version of the container instead of the version matching the package version.
                          This is mainly useful for debugging.
   :type get_latest_tag: bool, default=False


.. py:class:: FaceExtractorContainer(num_faces: Optional[int], min_face_size: int = 20, thresholds: Tuple[float] = (0.6, 0.7, 0.7), factor: float = 0.709, post_process: bool = True, select_largest: bool = True, selection_method: Optional[str] = None, keep_all: bool = True, device: Optional[torch.device] = 'cpu', embeddings_model: str = 'vggface2', image_name: str = 'mexca/face-extractor', get_latest_tag: bool = False)



   Container for `FaceExtractor` component.

   :param image_name: Name of the image to create a container from.
                      Pulls the image from Docker Hub if not found locally.
   :type image_name: str, default='mexca-face-extractor'

   .. seealso:: :obj:`FaceExtractor`


.. py:class:: SpeakerIdentifierContainer(num_speakers: Optional[int] = None, use_auth_token: Union[bool, str] = True, image_name: str = 'mexca/speaker-identifier', get_latest_tag: bool = False)



   Container for `SpeakerIdentifier` component.

   :param image_name: Name of the image to create a container from.
                      Pulls the image from Docker Hub if not found locally.
   :type image_name: str, default='mexca-speaker-identifier'

   .. seealso:: :obj:`SpeakerIdentifier`


.. py:class:: VoiceExtractorContainer(config: Optional[mexca.data.VoiceFeaturesConfig] = None, image_name: str = 'mexca/voice-extractor', get_latest_tag: bool = False)



   Container for `VoiceExtractor` component.

   :param config: Voice feature extraction configuration object. If `None`, uses :class:`VoiceFeaturesConfig`'s default configuration.
   :type config: VoiceFeaturesConfig, optional, default=None
   :param image_name: Name of the image to create a container from.
                      Pulls the image from Docker Hub if not found locally.
   :type image_name: str, default='mexca-voice-extractor'

   .. seealso:: :obj:`VoiceExtractor`


.. py:class:: AudioTranscriberContainer(whisper_model: Optional[str] = 'small', device: Optional[Union[str, torch.device]] = 'cpu', sentence_rule: Optional[str] = None, image_name: str = 'mexca/audio-transcriber', get_latest_tag: bool = False)



   Container for `AudioTrascriber` component.

   :param image_name: Name of the image to create a container from.
                      Pulls the image from Docker Hub if not found locally.
   :type image_name: str, default='mexca-audio-transcriber'

   .. seealso:: :obj:`AudioTranscriber`


.. py:class:: SentimentExtractorContainer(image_name: str = 'mexca/sentiment-extractor', get_latest_tag: bool = False)



   Container for `SentimentExtractor` component.

   :param image_name: Name of the image to create a container from.
                      Pulls the image from Docker Hub if not found locally.
   :type image_name: str, default='mexca-sentiment-extractor'

   .. seealso:: :obj:`SentimentExtractor`