chore(external): add note and warning for solo predict breaking change (

#2697)

amends #2689 to add a note in the changelog as well as a warning noting
that it is a breaking change.

CHANGELOG.md

@@ -60,8 +60,8 @@ is available in the [commit logs](https://github.com/scverse/scvi-tools/commits/
 
 #### Fixed
 
--   Fix {meth}`scvi.external.SOLO.predict` to correctly return probabiities instead of logits
-    when passing in `soft=True` {pr}`2689`.
+-   Breaking change: Fix {meth}`scvi.external.SOLO.predict` to correctly return probabiities
+    instead of logits when passing in `soft=True` (the default option) {pr}`2689`.
 
 ### 1.1.2 (2024-03-01)
 

scvi/external/solo/_model.py

@@ -400,6 +400,14 @@ def predict(self, soft: bool = True, include_simulated_doublets: bool = False) -
         -------
         DataFrame with prediction, index corresponding to cell barcode.
         """
+        warnings.warn(
+            "Prior to scvi-tools 1.1.3, `SOLO.predict` with `soft=True` (the default option) "
+            "returned logits instead of probabilities. This behavior has since been corrected to "
+            "return probabiltiies.",
+            UserWarning,
+            stacklevel=settings.warnings_stacklevel,
+        )
+
         adata = self._validate_anndata(None)
         scdl = self._make_data_loader(adata=adata)