hyrax.verbs.engine
==================

.. py:module:: hyrax.verbs.engine


Attributes
----------

.. autoapisummary::

   hyrax.verbs.engine.logger


Classes
-------

.. autoapisummary::

   hyrax.verbs.engine.Engine


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

.. py:data:: logger

.. py:class:: Engine(config)

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


   This verb drives inference with an ONNX model in production.

   .. py:method:: __init__

   Overall initialization for all verbs that saves the config


   .. py:attribute:: cli_name
      :value: 'engine'



   .. py:attribute:: add_parser_kwargs


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


      Setup parser for engine verb



   .. py:method:: run_cli(args=None)

      CLI stub for Engine verb



   .. py:method:: run(model_directory: str = None)

      [x] Read in the user config
      [x] Prepare all the datasets requested
      [x] Implement a simple strategy for reading in batches of data samples
      [x] Process the samples with any custom collate functions as well as a default collate function
      [x] Pass the collated batch to the appropriate to_tensor function
      [x] Send that output to the ONNX-ified model
      [x] Persist the results of inference.