Commit 9b168f4
docs(metrics): document the Hausdorff nan/inf contract
Adds the Google-style `Returns` and `Raises` sections the repository's path
instructions ask for, on `compute_hausdorff_distance` and on
`_compute_percentile_hausdorff_distance`, which had a one-line docstring and
no `Args`.
The sections state the part this change turns on: `nan` when neither mask has
a foreground, so there is nothing to measure and the reduction excludes it,
and `inf` when exactly one mask is empty, at the maximum and at every
percentile alike. That distinction was previously only inferable from the
code.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Signed-off-by: asifuddin01 <md.asif.uddin@g.bracu.ac.bd>1 parent 503e979 commit 9b168f4
1 file changed
Lines changed: 27 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
166 | 166 | | |
167 | 167 | | |
168 | 168 | | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
169 | 178 | | |
170 | 179 | | |
171 | 180 | | |
| |||
201 | 210 | | |
202 | 211 | | |
203 | 212 | | |
204 | | - | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
205 | 231 | | |
206 | 232 | | |
207 | 233 | | |
| |||
0 commit comments