Skip to content

Commit a0cc317

Browse files
committed
Add optional requirements in docs
1 parent 2283e41 commit a0cc317

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

docs/source/guides/installation_guide.rst

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,3 +110,54 @@ OR to install from source:
110110
.. code-block::
111111
112112
pip install -e .
113+
114+
Optional requirements
115+
---------------------
116+
117+
Additional functionalities
118+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
119+
120+
Several additional functionalities are available optionally. To install them, use the following commands:
121+
122+
- CRF post-processing:
123+
124+
.. code-block::
125+
126+
pip install pydensecrf@git+https://github.com/lucasb-eyer/pydensecrf.git#egg=master
127+
128+
- Weights & Biases integration:
129+
130+
.. code-block::
131+
132+
pip install napari-cellseg3D[wandb]
133+
134+
135+
- ONNX model support (EXPERIMENTAL):
136+
Depending on your hardware, you can install the CPU or GPU version of ONNX.
137+
138+
.. code-block::
139+
140+
pip install napari-cellseg3D[onnx-cpu]
141+
pip install napari-cellseg3D[onnx-gpu]
142+
143+
Development requirements
144+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
145+
146+
- Building the documentation:
147+
148+
.. code-block::
149+
150+
pip install napari-cellseg3D[docs]
151+
152+
- Running tests locally:
153+
154+
.. code-block::
155+
156+
pip install pydensecrf@git+https://github.com/lucasb-eyer/pydensecrf.git#egg=master
157+
pip install napari-cellseg3D[test]
158+
159+
- Dev utilities:
160+
161+
.. code-block::
162+
163+
pip install napari-cellseg3D[dev]

0 commit comments

Comments
 (0)