afe.apis.compilation_job
========================

.. py:module:: afe.apis.compilation_job

.. autoapi-nested-parse::

   The API for controlling a compilation job.  This API is
   intended for use in a user-defined module that is passed
   to the command-line interface.

   The recommended usage is to pass a CompilationJob to
   set_compilation_job.  Parameters that direct
   compilation are incorporated into the CompilationJob.
   The job will be read by the command-line driver.



Classes
-------

.. autoapisummary::

   afe.apis.compilation_job.CompilationJob


Functions
---------

.. autoapisummary::

   afe.apis.compilation_job.set_compilation_job


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

.. py:class:: CompilationJob



   A specification of how to calibrate, quantize, evaluate,
   and compile a model.


   .. py:attribute:: preprocess_transforms
      :type:  List[afe.apis.transform.Transform]


   .. py:attribute:: postprocess_transforms
      :type:  List[afe.apis.transform.Transform]


   .. py:attribute:: calibration_input
      :type:  Iterable[afe.apis.compilation_job_base.Tensors]


   .. py:attribute:: evaluation_input
      :type:  Iterable[Tuple[afe.apis.compilation_job_base.Tensors, afe.apis.compilation_job_base.GroundTruth]]


   .. py:attribute:: evaluate_result
      :type:  afe.apis.statistic.Statistic[Tuple[afe.apis.compilation_job_base.Tensors, afe.apis.compilation_job_base.GroundTruth], str]


.. py:function:: set_compilation_job(job: CompilationJob[Any]) -> None

   Use the given CompilationJob to control compilation.  If called multiple
   times, the job that is passed to the final call will be used.