Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

error in docs #11866

Closed
jeremy-rutman opened this issue Jul 29, 2017 · 5 comments
Closed

error in docs #11866

jeremy-rutman opened this issue Jul 29, 2017 · 5 comments
Labels
stat:contribution welcome Status - Contributions welcome type:docs-bug Document issues

Comments

@jeremy-rutman
Copy link
Contributor

jeremy-rutman commented Jul 29, 2017

The docs here for bounding boxes have an error :
The paragraph reading

For example, if an image is 100 x 200 pixels and the bounding box is [0.1, 0.2, 0.5, 0.9], the bottom-left and upper-right coordinates of the bounding box will be (10, 40) to (50, 180).

would better go something like:

For example, if an image is 100 x 200 pixels and the bounding box is [0.1, 0.2, 0.5, 0.9], the upper-left and bottom-right coordinates of the bounding box will be (10, 40) to (50, 180), using a somewhat idiosyncratic (y,x) notation, or (40,10) to (180,50) using the rather more common (x,y) notation for points in a plane. All this is with 'usual' coordinate axes (origin in the top left corner, increasing x to right and increasing y going down)

@clemens-tolboom
Copy link

Is it really height x width ? Yes as said on https://www.tensorflow.org/versions/r0.12/api_docs/python/image/working_with_bounding_boxes

The coordinates of the each bounding box in boxes are encoded as [y_min, x_min, y_max, x_max].

You could create a PR for around line 700 in
https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/ops/image_ops.cc#L700

I agree It is not intuitive but it's mentioned as swapped.


Wouldn't it be better to mention width and height to trigger the users?

For example, if an image is 100 height x 200 width pixels

or

For example, if an image is 100 x 200 (height x width) pixels

@jeremy-rutman
Copy link
Contributor Author

I tried doing a pr 11889 as you suggested, thanks.

@aselle
Copy link
Contributor

aselle commented Jul 31, 2017

see #11889 for fix.

@aselle aselle added stat:contribution welcome Status - Contributions welcome type:docs-bug Document issues labels Jul 31, 2017
@divyam3897
Copy link

Hi, it should be closed if fixed?

@jeremy-rutman
Copy link
Contributor Author

the pr was merged so I suppse you are right, will close if I can

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stat:contribution welcome Status - Contributions welcome type:docs-bug Document issues
Projects
None yet
Development

No branches or pull requests

4 participants