Project-MONAI / Project-MONAI/MetricsReloaded

Documentation: AssignmentMapping

Open Beginner friendly
#12 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
104
Forks
18
PR merge metrics
No merged PRs in 30d

Description

It would be clearer if the documentation specified the datatype of pred_loc, ref_loc and pred_prob.
I initially thought pred_loc meant the location of the file containing the prediction and that the network was going to read the file.
pred_loc is actually an array.

https://github.com/csudre/MetricsReloaded/blob/160de53fc57a64ad6c0eb6bc07e12ef11e537b0e/utility/assignment_localization.py#L13-L15

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the referenced lines 13-15 in utility/assignment_localization.py and inspect how AssignmentMapping uses pred_loc, ref_loc, and pred_prob. Update the relevant documentation to state that each value is an array or otherwise specify its datatype, so readers do not mistake pred_loc for a file path.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.