detector_benchmark.watermark.dip
================================

.. py:module:: detector_benchmark.watermark.dip


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/detector_benchmark/watermark/dip/dip/index


Classes
-------

.. autoapisummary::

   detector_benchmark.watermark.dip.DIP


Package Contents
----------------

.. py:class:: DIP(algorithm_config: dict, gen_model, transformers_config: detector_benchmark.utils.configs.ModelConfig, *args, **kwargs)

   Bases: :py:obj:`detector_benchmark.watermark.base.BaseWatermark`


   Top-level class for DIP algorithm.


   .. py:attribute:: config


   .. py:attribute:: utils


   .. py:attribute:: logits_processor


   .. py:method:: generate_watermarked_text(prompt: str, *args, **kwargs) -> str

      Generate watermarked text.



   .. py:method:: generate(encoded_prompts: list, *args, **kwargs) -> str

      Generate watermarked text. Takes a list of encoded prompts as input, like transformers model.generate.



   .. py:method:: detect_watermark(text: str, return_dict: bool = True, *args, **kwargs)

      Detect watermark in the text.