Skip to content

Commit 7bf446c

Browse files
committed
[Improvement] Improve docs for new additions.
Versions for deprecations and features are highlighted.
1 parent 14c2982 commit 7bf446c

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

CytofDR/dr.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,12 @@ def evaluate(self,
239239
This method requires ``add_evaluation_metadata`` to run first. ``original_cell_types`` and
240240
``embedding_cell_types`` are optional for the downstream category. For ``concordance``, if
241241
you wish to use clustering results for embedding and comparison files, set the appropriate
242-
clusterings to ``embedding_cell_types`` and ``comparison_cell_types``.
242+
clusterings to ``embedding_cell_types`` and ``comparison_cell_types``.
243+
244+
.. versionadded:: 0.2.0
245+
246+
The `pairwise_downsample` option for `pwd_metric`; the `pairwise_downsample_size` parameter for when
247+
`pairwise_downbsample` is chosen.
243248
"""
244249

245250
if len(self.reductions) == 0:

CytofDR/evaluation.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -479,7 +479,10 @@ def embedding_concordance(embedding: "np.ndarray",
479479
:return: The score or "NA"
480480
481481
.. Note:: When there is no overlapping labels, "NA" is automatically returned as ``str``.
482-
.. Deprecation Notice:: Passing in `str` for the `comparison_classes` parameter is deprecated
482+
483+
.. deprecated:: 0.2.0
484+
485+
Passing in `str` for the `comparison_classes` parameter is deprecated
483486
and will be removed in futrue versions.
484487
"""
485488

0 commit comments

Comments
 (0)