dacapo.blockwise.predict_worker
===============================

.. py:module:: dacapo.blockwise.predict_worker


Attributes
----------

.. autoapisummary::

   dacapo.blockwise.predict_worker.logger
   dacapo.blockwise.predict_worker.read_write_conflict
   dacapo.blockwise.predict_worker.fit
   dacapo.blockwise.predict_worker.path


Functions
---------

.. autoapisummary::

   dacapo.blockwise.predict_worker.cli
   dacapo.blockwise.predict_worker.start_worker
   dacapo.blockwise.predict_worker.start_worker_fn
   dacapo.blockwise.predict_worker.spawn_worker


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

.. py:data:: logger

.. py:data:: read_write_conflict
   :type:  bool
   :value: False


.. py:data:: fit
   :type:  str
   :value: 'valid'


.. py:data:: path

.. py:function:: cli(log_level)

   CLI for running the predict worker.

   The predict worker is used to apply a trained model to a dataset.

   :param log_level: The log level to use for logging.
   :type log_level: str


.. py:function:: start_worker(run_name: str, iteration: int | None, input_container: upath.UPath | str, input_dataset: str, output_container: upath.UPath | str, output_dataset: str, return_io_loop: Optional[bool] = False)

.. py:function:: start_worker_fn(run_name: str, iteration: int | None, input_container: upath.UPath | str, input_dataset: str, output_container: upath.UPath | str, output_dataset: str, return_io_loop: Optional[bool] = False)

   Start a worker to apply a trained model to a dataset.

   :param run_name: The name of the run to apply.
   :type run_name: str
   :param iteration: The training iteration of the model to use for prediction.
   :type iteration: int or None
   :param input_container: The input container.
   :type input_container: Path | str
   :param input_dataset: The input dataset.
   :type input_dataset: str
   :param output_container: The output container.
   :type output_container: Path | str
   :param output_dataset: The output dataset.
   :type output_dataset: str


.. py:function:: spawn_worker(run_name: str, iteration: int | None, input_array_identifier: dacapo.store.array_store.LocalArrayIdentifier, output_array_identifier: dacapo.store.array_store.LocalArrayIdentifier)

   Spawn a worker to predict on a given dataset.

   :param run_name: The name of the run to apply.
   :type run_name: str
   :param iteration: The training iteration of the model to use for prediction.
   :type iteration: int or None
   :param input_array_identifier: The raw data to predict on.
   :type input_array_identifier: LocalArrayIdentifier
   :param output_array_identifier: The identifier of the prediction array.
   :type output_array_identifier: LocalArrayIdentifier

   :returns: The function to run the worker.
   :rtype: Callable