Tweak docs for better understanding of what spatial_scale does #4522
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Very minor thing and possibly just my opinion but I found the docs for spatial scale in the roi_pool variants misleading. Conceptually we are mapping the box co-ordinates to the input co-ordinates, not the other way around. So if
scale_factor = 0.5
we might consider that we are doing the mapping box -> box * 0.5. I only figured this out because I felt suspicious enough to open up a console and try it with a toy feature map. For argument's sake, you could write it the other way around, but then you'd have to invert the scale factor for it to be semantically correct.Also added an example to make it super clear.
Happy to get other opinions. If agreed, also happy to have this snuck in with a diff PR if convenient.