hyrax.verbs.umap
================

.. py:module:: hyrax.verbs.umap


Attributes
----------

.. autoapisummary::

   hyrax.verbs.umap.logger


Classes
-------

.. autoapisummary::

   hyrax.verbs.umap.Umap


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

.. py:data:: logger

.. py:class:: Umap(config)

   Bases: :py:obj:`hyrax.verbs.verb_registry.Verb`


   Umap latent space points into 2d

   .. py:method:: __init__

   Overall initialization for all verbs that saves the config


   .. py:attribute:: cli_name
      :value: 'umap'



   .. py:attribute:: add_parser_kwargs


   .. py:attribute:: description
      :value: 'Transforms the entire dataset into a lower-dimensional space by fitting a UMAP model.'



   .. py:method:: setup_parser(parser: argparse.ArgumentParser)
      :staticmethod:


      Stub of parser setup



   .. py:method:: run_cli(args: argparse.Namespace | None = None)

      Stub CLI implementation



   .. py:method:: run(input_dir: Union[pathlib.Path, str] | None = None, model_path: Union[pathlib.Path, str] | None = None)

      Deprecated wrapper for reduce_dimensions running the UMAP algorithm.

      This wrapper delegates execution to ``reduce_dimensions`` with
      ``algorithm='umap'`` so that ``umap`` verb remains available for backward compatibility.
      But users are encouraged to switch to using
      ``reduce_dimensions``.

      :param input_dir: The directory containing the inference results.
      :type input_dir: str or Path, Optional
      :param model_path: The path to a pre-existing UMAP model.
      :type model_path: str or Path, Optional

      :returns: The method does not return anything but saves the UMAP representations to disk.
      :rtype: None



   .. py:method:: _run(input_dir: Union[pathlib.Path, str] | None = None, model_path: Union[pathlib.Path, str] | None = None)

      See run()