hyrax.verbs.lookup
==================

.. py:module:: hyrax.verbs.lookup


Attributes
----------

.. autoapisummary::

   hyrax.verbs.lookup.logger


Classes
-------

.. autoapisummary::

   hyrax.verbs.lookup.Lookup


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

.. py:data:: logger

.. py:class:: Lookup(config)

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


   Look up an inference result using the ID of a data member

   .. py:method:: __init__

   Overall initialization for all verbs that saves the config


   .. py:attribute:: cli_name
      :value: 'lookup'



   .. py:attribute:: add_parser_kwargs


   .. py:attribute:: description
      :value: 'Look up an inference result using the ID of a data member.'



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


      Set up our arguments by configuring a subparser

      :param parser: The sub-parser to configure
      :type parser: ArgumentParser



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

      Entrypoint to Lookup from the CLI.

      :param args: The parsed command line arguments
      :type args: Optional[Namespace], optional



   .. py:method:: run(id: str, results_dir: Union[pathlib.Path, str] | None = None) -> numpy.ndarray | None

      Lookup the latent-space representation of a particular ID

      Requires the relevant dataset to be configured, and for inference to have been run.

      :param id: The ID of the input data to look up the inference result
      :type id: str
      :param results_dir: The directory containing the inference results.
      :type results_dir: str, Optional

      :returns: The output tensor of the model for the given input.
      :rtype: Optional[np.ndarray]