We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 47ef0d5 commit 28f98daCopy full SHA for 28f98da
1 file changed
docs/python-api.md
@@ -507,6 +507,14 @@ Descendant nodes
507
Tree.num_samples
508
Tree.num_tracked_samples
509
510
+Note that :meth:Tree.num_samples provides an efficient way to count samples under a node.
511
+However, samples and leaves are not always equivalent: some samples may be internal nodes,
512
+some leaves may not be samples (in unsimplified tree sequences), and the same node can be
513
+a leaf in one tree but internal in another. While `tree.num_samples` often equals the leaf
514
+count (particularly in simplified tree sequences without internal samples), a strict leaf
515
+count requires tree traversal, e.g. via `num_leaves = len(list(tree.leaves()))`.
516
+
517
518
Multiple nodes
519
.. autosummary::
520
Tree.is_descendant
0 commit comments