:py:mod:`rofunc.utils.visualab.segment.vlpart.vlpart`
=====================================================

.. py:module:: rofunc.utils.visualab.segment.vlpart.vlpart

.. autodoc2-docstring:: rofunc.utils.visualab.segment.vlpart.vlpart
   :allowtitles:

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

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`VLPart <rofunc.utils.visualab.segment.vlpart.vlpart.VLPart>`
     -

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`build_vlpart <rofunc.utils.visualab.segment.vlpart.vlpart.build_vlpart>`
     - .. autodoc2-docstring:: rofunc.utils.visualab.segment.vlpart.vlpart.build_vlpart
          :summary:
   * - :py:obj:`custom_detector_postprocess <rofunc.utils.visualab.segment.vlpart.vlpart.custom_detector_postprocess>`
     - .. autodoc2-docstring:: rofunc.utils.visualab.segment.vlpart.vlpart.custom_detector_postprocess
          :summary:

API
~~~

.. py:function:: build_vlpart(checkpoint=None)
   :canonical: rofunc.utils.visualab.segment.vlpart.vlpart.build_vlpart

   .. autodoc2-docstring:: rofunc.utils.visualab.segment.vlpart.vlpart.build_vlpart

.. py:class:: VLPart(backbone, proposal_generator: torch.nn.Module, roi_heads: torch.nn.Module)
   :canonical: rofunc.utils.visualab.segment.vlpart.vlpart.VLPart

   Bases: :py:obj:`torch.nn.Module`

   .. py:property:: device
      :canonical: rofunc.utils.visualab.segment.vlpart.vlpart.VLPart.device

      .. autodoc2-docstring:: rofunc.utils.visualab.segment.vlpart.vlpart.VLPart.device

   .. py:method:: get_text_embeddings(vocabulary, prefix_prompt='a ')
      :canonical: rofunc.utils.visualab.segment.vlpart.vlpart.VLPart.get_text_embeddings

      .. autodoc2-docstring:: rofunc.utils.visualab.segment.vlpart.vlpart.VLPart.get_text_embeddings

   .. py:method:: inference(batched_inputs: typing.List[typing.Dict[str, torch.Tensor]], do_postprocess: bool = True, text_prompt: str = 'dog')
      :canonical: rofunc.utils.visualab.segment.vlpart.vlpart.VLPart.inference

      .. autodoc2-docstring:: rofunc.utils.visualab.segment.vlpart.vlpart.VLPart.inference

   .. py:method:: preprocess_image(batched_inputs: typing.List[typing.Dict[str, torch.Tensor]])
      :canonical: rofunc.utils.visualab.segment.vlpart.vlpart.VLPart.preprocess_image

      .. autodoc2-docstring:: rofunc.utils.visualab.segment.vlpart.vlpart.VLPart.preprocess_image

.. py:function:: custom_detector_postprocess(results, output_height: int, output_width: int, max_shape, mask_threshold: float = 0.5)
   :canonical: rofunc.utils.visualab.segment.vlpart.vlpart.custom_detector_postprocess

   .. autodoc2-docstring:: rofunc.utils.visualab.segment.vlpart.vlpart.custom_detector_postprocess