Merge pull request #1289 from MouseLand/flows_and_message

Output zeros for style vector and remove welcome message

Author: mrariden

cellpose/__init__.py

@@ -1,6 +1 @@
 from cellpose.version import version, version_str
-message = f'''\n
-Welcome to CellposeSAM, cellpose v{version_str}! The neural network component of
-CPSAM is much larger than in previous versions and CPU excution is slow. 
-We encourage users to use GPU/MPS if available. \n\n''' 
-print(message)

cellpose/models.py

@@ -209,7 +209,7 @@ def eval(self, x, batch_size=8, resample=True, channels=None, channel_axis=None,
                 flows[k][1] = XY flows at each pixel; 
                 flows[k][2] = cell probability (if > cellprob_threshold, pixel used for dynamics); 
                 flows[k][3] = final pixel locations after Euler integration; 
-            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.
+            styles (list of 1D arrays of length 256 or single 1D array): Style vector containing only zeros. Retained for compaibility with CP3. 
             
         """
 

cellpose/vit_sam.py

@@ -77,7 +77,7 @@ def forward(self, x):
 
         # maintain the second output of feature size 256 for backwards compatibility
 
-        return x1, torch.randn((x.shape[0], 256), device=x.device)
+        return x1, torch.zeros((x.shape[0], 256), device=x.device)
 
     def load_model(self, PATH, device, strict = False):        
         state_dict = torch.load(PATH, map_location = device, weights_only=True)

docs/settings.rst

@@ -10,6 +10,10 @@ See the :ref:`cpmclass` for all run options.
     Cellpose 3 used ``models.Cellpose`` class which has been removed in Cellpose 4. Users should
     now only use the ``models.CellposeModel`` class. 
 
+.. warning::
+    Cellpose-SAM **does NOT** calculate a style vector in the CellposeModel.eval() method. For compatibility a 
+    vector of zeros is returned as the style vector. You will need to use Cellpose 3 if you want to use the style vector.
+    
 Here is an example of calling the ``CellposeModel`` class and
 running a list of images for reference: