Skip to content

Commit

Permalink
Add optional requirements in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
C-Achard committed Dec 15, 2023
1 parent 2283e41 commit a0cc317
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions docs/source/guides/installation_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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]

0 comments on commit a0cc317

Please sign in to comment.