Skip to content

Commit

Permalink
Add changes for 83347b9
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jun 4, 2024
1 parent 836bbf3 commit 6686b3b
Show file tree
Hide file tree
Showing 21 changed files with 260 additions and 241 deletions.
3 changes: 3 additions & 0 deletions _sources/autoapi/dacapo/blockwise/argmax_worker/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down Expand Up @@ -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.

Expand All @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down Expand Up @@ -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.
Expand Down
57 changes: 22 additions & 35 deletions _sources/autoapi/dacapo/compute_context/bsub/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
57 changes: 22 additions & 35 deletions _sources/autoapi/dacapo/compute_context/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
33 changes: 20 additions & 13 deletions _sources/autoapi/dacapo/compute_context/local_torch/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading

0 comments on commit 6686b3b

Please sign in to comment.