From a0cc317ad46b2c4778ad2de5ba12e4fd8a91a0d4 Mon Sep 17 00:00:00 2001 From: C-Achard Date: Fri, 15 Dec 2023 10:35:51 +0100 Subject: [PATCH] Add optional requirements in docs --- docs/source/guides/installation_guide.rst | 51 +++++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/docs/source/guides/installation_guide.rst b/docs/source/guides/installation_guide.rst index 54c93af8..61f03677 100644 --- a/docs/source/guides/installation_guide.rst +++ b/docs/source/guides/installation_guide.rst @@ -110,3 +110,54 @@ OR to install from source: .. code-block:: pip install -e . + +Optional requirements +--------------------- + +Additional functionalities +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Several additional functionalities are available optionally. To install them, use the following commands: + +- CRF post-processing: + +.. code-block:: + + pip install pydensecrf@git+https://github.com/lucasb-eyer/pydensecrf.git#egg=master + +- Weights & Biases integration: + +.. code-block:: + + pip install napari-cellseg3D[wandb] + + +- ONNX model support (EXPERIMENTAL): + Depending on your hardware, you can install the CPU or GPU version of ONNX. + +.. code-block:: + + pip install napari-cellseg3D[onnx-cpu] + pip install napari-cellseg3D[onnx-gpu] + +Development requirements +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Building the documentation: + +.. code-block:: + + pip install napari-cellseg3D[docs] + +- Running tests locally: + +.. code-block:: + + pip install pydensecrf@git+https://github.com/lucasb-eyer/pydensecrf.git#egg=master + pip install napari-cellseg3D[test] + +- Dev utilities: + +.. code-block:: + + pip install napari-cellseg3D[dev]