diff --git a/_sources/autoapi/dacapo/blockwise/argmax_worker/index.rst.txt b/_sources/autoapi/dacapo/blockwise/argmax_worker/index.rst.txt index dd84e5e5..7e482ae1 100644 --- a/_sources/autoapi/dacapo/blockwise/argmax_worker/index.rst.txt +++ b/_sources/autoapi/dacapo/blockwise/argmax_worker/index.rst.txt @@ -32,6 +32,7 @@ Functions dacapo.blockwise.argmax_worker.create_compute_context dacapo.blockwise.argmax_worker.cli dacapo.blockwise.argmax_worker.start_worker + dacapo.blockwise.argmax_worker.start_worker_fn dacapo.blockwise.argmax_worker.spawn_worker @@ -577,6 +578,8 @@ Module Contents .. py:function:: start_worker(input_container: upath.UPath | str, input_dataset: str, output_container: upath.UPath | str, output_dataset: str, return_io_loop: bool = False) +.. py:function:: start_worker_fn(input_container: upath.UPath | str, input_dataset: str, output_container: upath.UPath | str, output_dataset: str, return_io_loop: bool = False) + Start the threshold worker. :param input_container: The input container. diff --git a/_sources/autoapi/dacapo/blockwise/predict_worker/index.rst.txt b/_sources/autoapi/dacapo/blockwise/predict_worker/index.rst.txt index 988b72b4..6a4a9782 100644 --- a/_sources/autoapi/dacapo/blockwise/predict_worker/index.rst.txt +++ b/_sources/autoapi/dacapo/blockwise/predict_worker/index.rst.txt @@ -35,6 +35,7 @@ Functions dacapo.blockwise.predict_worker.create_compute_context dacapo.blockwise.predict_worker.cli dacapo.blockwise.predict_worker.start_worker + dacapo.blockwise.predict_worker.start_worker_fn dacapo.blockwise.predict_worker.spawn_worker @@ -677,7 +678,9 @@ Module Contents :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(run_name: str | dacapo.experiments.Run, 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 | dacapo.experiments.Run, 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. @@ -695,7 +698,7 @@ Module Contents :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) +.. py:function:: spawn_worker(run_name: str | dacapo.experiments.Run, 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. diff --git a/_sources/autoapi/dacapo/blockwise/relabel_worker/index.rst.txt b/_sources/autoapi/dacapo/blockwise/relabel_worker/index.rst.txt index bfb5e822..278a36e0 100644 --- a/_sources/autoapi/dacapo/blockwise/relabel_worker/index.rst.txt +++ b/_sources/autoapi/dacapo/blockwise/relabel_worker/index.rst.txt @@ -30,6 +30,7 @@ Functions dacapo.blockwise.relabel_worker.create_compute_context dacapo.blockwise.relabel_worker.cli dacapo.blockwise.relabel_worker.start_worker + dacapo.blockwise.relabel_worker.start_worker_fn dacapo.blockwise.relabel_worker.relabel_in_block dacapo.blockwise.relabel_worker.find_components dacapo.blockwise.relabel_worker.read_cross_block_merges @@ -101,7 +102,9 @@ Module Contents .. py:data:: path -.. py:function:: start_worker(output_container, output_dataset, tmpdir, return_io_loop=False, *args, **kwargs) +.. py:function:: start_worker(output_container, output_dataset, tmpdir, return_io_loop=False) + +.. py:function:: start_worker_fn(output_container, output_dataset, tmpdir, return_io_loop=False) Start the relabel worker. @@ -151,7 +154,7 @@ Module Contents :rtype: Tuple[np.ndarray, np.ndarray] -.. py:function:: spawn_worker(output_array_identifier: dacapo.store.array_store.LocalArrayIdentifier, tmpdir: str, *args, **kwargs) +.. py:function:: spawn_worker(output_array_identifier: dacapo.store.array_store.LocalArrayIdentifier, tmpdir: str) Spawn a worker to predict on a given dataset. diff --git a/_sources/autoapi/dacapo/blockwise/segment_worker/index.rst.txt b/_sources/autoapi/dacapo/blockwise/segment_worker/index.rst.txt index a7debb12..42970aae 100644 --- a/_sources/autoapi/dacapo/blockwise/segment_worker/index.rst.txt +++ b/_sources/autoapi/dacapo/blockwise/segment_worker/index.rst.txt @@ -32,6 +32,7 @@ Functions dacapo.blockwise.segment_worker.create_compute_context dacapo.blockwise.segment_worker.cli dacapo.blockwise.segment_worker.start_worker + dacapo.blockwise.segment_worker.start_worker_fn dacapo.blockwise.segment_worker.spawn_worker @@ -573,7 +574,9 @@ Module Contents .. py:data:: path -.. py:function:: start_worker(input_container: str, input_dataset: str, output_container: str, output_dataset: str, tmpdir: str, function_path: str, return_io_loop: bool = False) +.. py:function:: start_worker(input_container: str | upath.UPath, input_dataset: str, output_container: str | upath.UPath, output_dataset: str, tmpdir: str | upath.UPath, function_path: str | upath.UPath, return_io_loop: bool = False) + +.. py:function:: start_worker_fn(input_container: str | upath.UPath, input_dataset: str, output_container: str | upath.UPath, output_dataset: str, tmpdir: str | upath.UPath, function_path: str | upath.UPath, return_io_loop: bool = False) Start a worker to run a segment function on a given dataset. diff --git a/_sources/autoapi/dacapo/blockwise/threshold_worker/index.rst.txt b/_sources/autoapi/dacapo/blockwise/threshold_worker/index.rst.txt index fa5c7653..612ff9ec 100644 --- a/_sources/autoapi/dacapo/blockwise/threshold_worker/index.rst.txt +++ b/_sources/autoapi/dacapo/blockwise/threshold_worker/index.rst.txt @@ -32,6 +32,7 @@ Functions dacapo.blockwise.threshold_worker.create_compute_context dacapo.blockwise.threshold_worker.cli dacapo.blockwise.threshold_worker.start_worker + dacapo.blockwise.threshold_worker.start_worker_fn dacapo.blockwise.threshold_worker.spawn_worker @@ -571,6 +572,8 @@ Module Contents .. py:function:: start_worker(input_container: upath.UPath | str, input_dataset: str, output_container: upath.UPath | str, output_dataset: str, threshold: float = 0.0, return_io_loop: bool = False) +.. py:function:: start_worker_fn(input_container: upath.UPath | str, input_dataset: str, output_container: upath.UPath | str, output_dataset: str, threshold: float = 0.0, return_io_loop: bool = False) + Start the threshold worker. :param input_container: The input container. diff --git a/_sources/autoapi/dacapo/compute_context/bsub/index.rst.txt b/_sources/autoapi/dacapo/compute_context/bsub/index.rst.txt index dac8efa1..f3d5e00a 100644 --- a/_sources/autoapi/dacapo/compute_context/bsub/index.rst.txt +++ b/_sources/autoapi/dacapo/compute_context/bsub/index.rst.txt @@ -20,28 +20,35 @@ Module Contents - The ComputeContext class is an abstract base class for defining the context in which computations are to be done. - It is inherited from the built-in class `ABC` (Abstract Base Classes). Other classes can inherit this class to define - their own specific variations of the context. It requires to implement several property methods, and also includes - additional methods related to the context design. + Helper class that provides a standard way to create an ABC using + inheritance. - .. attribute:: device - The device on which computations are to be done. + .. py:attribute:: distribute_workers + :type: Optional[bool] + + The ComputeContext class is an abstract base class for defining the context in which computations are to be done. + It is inherited from the built-in class `ABC` (Abstract Base Classes). Other classes can inherit this class to define + their own specific variations of the context. It requires to implement several property methods, and also includes + additional methods related to the context design. + + .. attribute:: device - .. method:: _wrap_command(command) + The device on which computations are to be done. - Wraps a command in the context specific command. + .. method:: _wrap_command(command) + + Wraps a command in the context specific command. - .. method:: wrap_command(command) + .. method:: wrap_command(command) - Wraps a command in the context specific command and returns it. + Wraps a command in the context specific command and returns it. - .. method:: execute(command) + .. method:: execute(command) - Runs a command in the context specific way. + Runs a command in the context specific way. - .. note:: The class is abstract and requires to implement the abstract methods. + .. note:: The class is abstract and requires to implement the abstract methods. .. py:property:: device @@ -109,28 +116,8 @@ Module Contents - The ComputeContext class is an abstract base class for defining the context in which computations are to be done. - It is inherited from the built-in class `ABC` (Abstract Base Classes). Other classes can inherit this class to define - their own specific variations of the context. It requires to implement several property methods, and also includes - additional methods related to the context design. - - .. attribute:: device - - The device on which computations are to be done. - - .. method:: _wrap_command(command) - - Wraps a command in the context specific command. - - .. method:: wrap_command(command) - - Wraps a command in the context specific command and returns it. - - .. method:: execute(command) - - Runs a command in the context specific way. - - .. note:: The class is abstract and requires to implement the abstract methods. + Helper class that provides a standard way to create an ABC using + inheritance. .. py:attribute:: distribute_workers diff --git a/_sources/autoapi/dacapo/compute_context/compute_context/index.rst.txt b/_sources/autoapi/dacapo/compute_context/compute_context/index.rst.txt index 1ec495c7..8face7d5 100644 --- a/_sources/autoapi/dacapo/compute_context/compute_context/index.rst.txt +++ b/_sources/autoapi/dacapo/compute_context/compute_context/index.rst.txt @@ -85,28 +85,35 @@ Module Contents - The ComputeContext class is an abstract base class for defining the context in which computations are to be done. - It is inherited from the built-in class `ABC` (Abstract Base Classes). Other classes can inherit this class to define - their own specific variations of the context. It requires to implement several property methods, and also includes - additional methods related to the context design. + Helper class that provides a standard way to create an ABC using + inheritance. - .. attribute:: device - The device on which computations are to be done. + .. py:attribute:: distribute_workers + :type: Optional[bool] - .. method:: _wrap_command(command) + The ComputeContext class is an abstract base class for defining the context in which computations are to be done. + It is inherited from the built-in class `ABC` (Abstract Base Classes). Other classes can inherit this class to define + their own specific variations of the context. It requires to implement several property methods, and also includes + additional methods related to the context design. - Wraps a command in the context specific command. + .. attribute:: device - .. method:: wrap_command(command) + The device on which computations are to be done. - Wraps a command in the context specific command and returns it. + .. method:: _wrap_command(command) - .. method:: execute(command) + Wraps a command in the context specific command. - Runs a command in the context specific way. + .. method:: wrap_command(command) - .. note:: The class is abstract and requires to implement the abstract methods. + Wraps a command in the context specific command and returns it. + + .. method:: execute(command) + + Runs a command in the context specific way. + + .. note:: The class is abstract and requires to implement the abstract methods. .. py:property:: device diff --git a/_sources/autoapi/dacapo/compute_context/index.rst.txt b/_sources/autoapi/dacapo/compute_context/index.rst.txt index 0b480bb9..adc01a26 100644 --- a/_sources/autoapi/dacapo/compute_context/index.rst.txt +++ b/_sources/autoapi/dacapo/compute_context/index.rst.txt @@ -40,28 +40,35 @@ Package Contents - The ComputeContext class is an abstract base class for defining the context in which computations are to be done. - It is inherited from the built-in class `ABC` (Abstract Base Classes). Other classes can inherit this class to define - their own specific variations of the context. It requires to implement several property methods, and also includes - additional methods related to the context design. + Helper class that provides a standard way to create an ABC using + inheritance. - .. attribute:: device - The device on which computations are to be done. + .. py:attribute:: distribute_workers + :type: Optional[bool] + + The ComputeContext class is an abstract base class for defining the context in which computations are to be done. + It is inherited from the built-in class `ABC` (Abstract Base Classes). Other classes can inherit this class to define + their own specific variations of the context. It requires to implement several property methods, and also includes + additional methods related to the context design. + + .. attribute:: device - .. method:: _wrap_command(command) + The device on which computations are to be done. - Wraps a command in the context specific command. + .. method:: _wrap_command(command) + + Wraps a command in the context specific command. - .. method:: wrap_command(command) + .. method:: wrap_command(command) - Wraps a command in the context specific command and returns it. + Wraps a command in the context specific command and returns it. - .. method:: execute(command) + .. method:: execute(command) - Runs a command in the context specific way. + Runs a command in the context specific way. - .. note:: The class is abstract and requires to implement the abstract methods. + .. note:: The class is abstract and requires to implement the abstract methods. .. py:property:: device @@ -196,28 +203,8 @@ Package Contents - The ComputeContext class is an abstract base class for defining the context in which computations are to be done. - It is inherited from the built-in class `ABC` (Abstract Base Classes). Other classes can inherit this class to define - their own specific variations of the context. It requires to implement several property methods, and also includes - additional methods related to the context design. - - .. attribute:: device - - The device on which computations are to be done. - - .. method:: _wrap_command(command) - - Wraps a command in the context specific command. - - .. method:: wrap_command(command) - - Wraps a command in the context specific command and returns it. - - .. method:: execute(command) - - Runs a command in the context specific way. - - .. note:: The class is abstract and requires to implement the abstract methods. + Helper class that provides a standard way to create an ABC using + inheritance. .. py:attribute:: distribute_workers diff --git a/_sources/autoapi/dacapo/compute_context/local_torch/index.rst.txt b/_sources/autoapi/dacapo/compute_context/local_torch/index.rst.txt index 0e1a1425..ee5cd332 100644 --- a/_sources/autoapi/dacapo/compute_context/local_torch/index.rst.txt +++ b/_sources/autoapi/dacapo/compute_context/local_torch/index.rst.txt @@ -20,28 +20,35 @@ Module Contents - The ComputeContext class is an abstract base class for defining the context in which computations are to be done. - It is inherited from the built-in class `ABC` (Abstract Base Classes). Other classes can inherit this class to define - their own specific variations of the context. It requires to implement several property methods, and also includes - additional methods related to the context design. + Helper class that provides a standard way to create an ABC using + inheritance. - .. attribute:: device - The device on which computations are to be done. + .. py:attribute:: distribute_workers + :type: Optional[bool] + + The ComputeContext class is an abstract base class for defining the context in which computations are to be done. + It is inherited from the built-in class `ABC` (Abstract Base Classes). Other classes can inherit this class to define + their own specific variations of the context. It requires to implement several property methods, and also includes + additional methods related to the context design. + + .. attribute:: device + + The device on which computations are to be done. - .. method:: _wrap_command(command) + .. method:: _wrap_command(command) - Wraps a command in the context specific command. + Wraps a command in the context specific command. - .. method:: wrap_command(command) + .. method:: wrap_command(command) - Wraps a command in the context specific command and returns it. + Wraps a command in the context specific command and returns it. - .. method:: execute(command) + .. method:: execute(command) - Runs a command in the context specific way. + Runs a command in the context specific way. - .. note:: The class is abstract and requires to implement the abstract methods. + .. note:: The class is abstract and requires to implement the abstract methods. .. py:property:: device diff --git a/autoapi/dacapo/blockwise/argmax_worker/index.html b/autoapi/dacapo/blockwise/argmax_worker/index.html index 61911797..ae20062d 100644 --- a/autoapi/dacapo/blockwise/argmax_worker/index.html +++ b/autoapi/dacapo/blockwise/argmax_worker/index.html @@ -147,9 +147,12 @@
start_worker
(input_container, input_dataset, ...[, ...])
start_worker_fn
(input_container, input_dataset, ...[, ...])
Start the threshold worker.
spawn_worker
(input_array_identifier, ...)
spawn_worker
(input_array_identifier, ...)
Spawn a worker to predict on a given dataset.
Start the threshold worker.
start_worker
(run_name, iteration, input_container, ...)
start_worker_fn
(run_name, iteration, input_container, ...)
Start a worker to apply a trained model to a dataset.
spawn_worker
(run_name, iteration, ...)
spawn_worker
(run_name, iteration, ...)
Spawn a worker to predict on a given dataset.
Start a worker to apply a trained model to a dataset.
Spawn a worker to predict on a given dataset.
start_worker
(output_container, output_dataset, tmpdir)
start_worker_fn
(output_container, output_dataset, tmpdir)
Start the relabel worker.
relabel_in_block
(array_out, old_values, new_values, block)
relabel_in_block
(array_out, old_values, new_values, block)
Relabel the array in the given block.
find_components
(nodes, edges)
find_components
(nodes, edges)
Find the components.
read_cross_block_merges
(tmpdir)
read_cross_block_merges
(tmpdir)
Read the cross block merges.
spawn_worker
(output_array_identifier, tmpdir, *args, ...)
spawn_worker
(output_array_identifier, tmpdir)
Spawn a worker to predict on a given dataset.
Start the relabel worker.
Spawn a worker to predict on a given dataset.
start_worker
(input_container, input_dataset, ...[, ...])
start_worker_fn
(input_container, input_dataset, ...[, ...])
Start a worker to run a segment function on a given dataset.
spawn_worker
(input_array_identifier, ...)
spawn_worker
(input_array_identifier, ...)
Spawn a worker to predict on a given dataset.
Start a worker to run a segment function on a given dataset.
start_worker
(input_container, input_dataset, ...[, ...])
start_worker_fn
(input_container, input_dataset, ...[, ...])
Start the threshold worker.
spawn_worker
(input_array_identifier, ...[, threshold])
spawn_worker
(input_array_identifier, ...[, threshold])
Spawn a worker to predict on a given dataset.
Start the threshold worker.
- | The ComputeContext class is an abstract base class for defining the context in which computations are to be done. |
+Helper class that provides a standard way to create an ABC using |
- | The ComputeContext class is an abstract base class for defining the context in which computations are to be done. |
+Helper class that provides a standard way to create an ABC using |
Helper class that provides a standard way to create an ABC using +inheritance.
+The ComputeContext class is an abstract base class for defining the context in which computations are to be done. It is inherited from the built-in class ABC (Abstract Base Classes). Other classes can inherit this class to define their own specific variations of the context. It requires to implement several property methods, and also includes @@ -154,6 +159,8 @@
The class is abstract and requires to implement the abstract methods.
+The ComputeContext class is an abstract base class for defining the context in which computations are to be done. -It is inherited from the built-in class ABC (Abstract Base Classes). Other classes can inherit this class to define -their own specific variations of the context. It requires to implement several property methods, and also includes -additional methods related to the context design.
-The device on which computations are to be done.
-Wraps a command in the context specific command.
-Wraps a command in the context specific command and returns it.
-Runs a command in the context specific way.
-Note
-The class is abstract and requires to implement the abstract methods.
-Helper class that provides a standard way to create an ABC using +inheritance.
Returns the device on which computations are to be done.
Wraps a command in the context specific command.
A device can be a CPU, GPU, TPU, etc. It is used to specify the context in which computations are to be done.
diff --git a/autoapi/dacapo/compute_context/compute_context/index.html b/autoapi/dacapo/compute_context/compute_context/index.html index 8400a6c6..b0972422 100644 --- a/autoapi/dacapo/compute_context/compute_context/index.html +++ b/autoapi/dacapo/compute_context/compute_context/index.html @@ -112,7 +112,7 @@A class that provides options for configuring DaCapo.
The ComputeContext class is an abstract base class for defining the context in which computations are to be done.
Helper class that provides a standard way to create an ABC using
Helper class that provides a standard way to create an ABC using +inheritance.
+The ComputeContext class is an abstract base class for defining the context in which computations are to be done. It is inherited from the built-in class ABC (Abstract Base Classes). Other classes can inherit this class to define their own specific variations of the context. It requires to implement several property methods, and also includes @@ -231,6 +236,8 @@
The class is abstract and requires to implement the abstract methods.
+- | The ComputeContext class is an abstract base class for defining the context in which computations are to be done. |
+Helper class that provides a standard way to create an ABC using |
The LocalTorch class is a subclass of the ComputeContext class. |
||
- | The ComputeContext class is an abstract base class for defining the context in which computations are to be done. |
+Helper class that provides a standard way to create an ABC using |
Helper class that provides a standard way to create an ABC using +inheritance.
+The ComputeContext class is an abstract base class for defining the context in which computations are to be done. It is inherited from the built-in class ABC (Abstract Base Classes). Other classes can inherit this class to define their own specific variations of the context. It requires to implement several property methods, and also includes @@ -176,6 +181,8 @@
The class is abstract and requires to implement the abstract methods.
+The ComputeContext class is an abstract base class for defining the context in which computations are to be done. -It is inherited from the built-in class ABC (Abstract Base Classes). Other classes can inherit this class to define -their own specific variations of the context. It requires to implement several property methods, and also includes -additional methods related to the context design.
-The device on which computations are to be done.
-Wraps a command in the context specific command.
-Wraps a command in the context specific command and returns it.
-Runs a command in the context specific way.
-Note
-The class is abstract and requires to implement the abstract methods.
-Helper class that provides a standard way to create an ABC using +inheritance.
Returns the device on which computations are to be done.
Wraps a command in the context specific command.
A device can be a CPU, GPU, TPU, etc. It is used to specify the context in which computations are to be done.
diff --git a/autoapi/dacapo/compute_context/local_torch/index.html b/autoapi/dacapo/compute_context/local_torch/index.html index 48811179..b88aeda3 100644 --- a/autoapi/dacapo/compute_context/local_torch/index.html +++ b/autoapi/dacapo/compute_context/local_torch/index.html @@ -109,7 +109,7 @@