Skip to content

Commit d915511

Browse files
committed
Edits docs related to style vector
1 parent 9c6f3b2 commit d915511

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

cellpose/models.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ def eval(self, x, batch_size=8, resample=True, channels=None, channel_axis=None,
209209
flows[k][1] = XY flows at each pixel;
210210
flows[k][2] = cell probability (if > cellprob_threshold, pixel used for dynamics);
211211
flows[k][3] = final pixel locations after Euler integration;
212-
styles (list of 1D arrays of length 256 or single 1D array): Style vector summarizing each image, also used to estimate size of objects in image.
212+
styles (list of 1D arrays of length 256 or single 1D array): Style vector containing only zeros. Retained for compaibility with CP3.
213213
214214
"""
215215

docs/settings.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ See the :ref:`cpmclass` for all run options.
1010
Cellpose 3 used ``models.Cellpose`` class which has been removed in Cellpose 4. Users should
1111
now only use the ``models.CellposeModel`` class.
1212

13+
.. warning::
14+
Cellpose-SAM **does NOT** calculate a style vector in the CellposeModel.eval() method. For compatibility a
15+
vector of zeros is returned as the style vector. You will need to use Cellpose 3 if you want to use the style vector.
16+
1317
Here is an example of calling the ``CellposeModel`` class and
1418
running a list of images for reference:
1519

0 commit comments

Comments
 (0)