:py:mod:`src.wsi`
=================

.. py:module:: src.wsi


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   chinese_whispers/index.rst
   cluster_wsbm/index.rst
   correlation_clustering/index.rst
   model/index.rst
   spectral/index.rst


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

Classes
~~~~~~~

.. autoapisummary::

   src.wsi.ClusterChineseWhispers
   src.wsi.ClusterCorrelation
   src.wsi.WSIModel
   src.wsi.ClusterSpectral




.. py:class:: ClusterChineseWhispers


   Bases: :py:obj:`src.wsi.model.WSIModel`

   .. py:attribute:: n_iters
      :type: int

      

   .. py:method:: predict(uses: list[src.use.Use]) -> list[int]



.. py:class:: ClusterCorrelation


   Bases: :py:obj:`src.wsi.model.WSIModel`

   .. py:attribute:: max_senses
      :type: int

      

   .. py:attribute:: max_attempts
      :type: int

      

   .. py:attribute:: max_iters
      :type: int

      

   .. py:attribute:: initial
      :type: list[Any]

      

   .. py:attribute:: split_flag
      :type: bool

      

   .. py:method:: predict(uses: list[src.use.Use]) -> list[int]



.. py:class:: WSIModel


   Bases: :py:obj:`pydantic.BaseModel`, :py:obj:`abc.ABC`

   Helper class that provides a standard way to create an ABC using
   inheritance.

   .. py:attribute:: wic
      :type: WSIModel.wic

      

   .. py:method:: similarity_matrix(use_pairs: list[tuple[src.use.Use, src.use.Use]]) -> numpy.typing.NDArray[numpy.float64]


   .. py:method:: predict(uses: list[src.use.Use]) -> list[int]
      :abstractmethod:


   .. py:method:: make_freq_dists(clusters: dict[src.use.UseID, int], use_to_grouping: dict[src.use.UseID, str], groupings: tuple[str, str]) -> tuple[numpy.typing.NDArray[numpy.int32], numpy.typing.NDArray[numpy.int32]]


   .. py:method:: normalize_cluster(cluster: list[int]) -> list[float]
      :staticmethod:



.. py:class:: ClusterSpectral


   Bases: :py:obj:`src.wsi.model.WSIModel`

   .. py:attribute:: n_clusters
      :type: int

      

   .. py:method:: predict(uses: list[src.use.Use]) -> list[int]