-
Notifications
You must be signed in to change notification settings - Fork 74k
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
Docs(Queue): Fix a PriorityQueue API missing bug #3927
Conversation
Add the description of `class PriorityQueue()` API in /python/ops/data_flow_ops.py. From line tensorflow#714 to tensorflow#759 you can check [here](https://github.com/tensorflow/tensorflow/blob/master/tensorflow/python/ops/data_flow_ops.py)
Thanks for the pull request! Unless I'm much mistaken, these files should be autogenerated from the source in data_flow_ops. @josh11b can you comment on what the right fix is? |
Can one of the admins verify this patch? |
The source for the documentation of tf.PriorityQueue lives in https://github.com/tensorflow/tensorflow/blob/master/tensorflow/python/ops/data_flow_ops.py#L715 tensorflow/g3doc/api_docs/python/io_ops.md is automatically generated. Any changes to it will be overwritten the next time the documentation generator runs. In fact, its very first line is: The fact that PriorityQueue is not being generated is an issue, which we can hopefully fix by adding PriorityQueue to the list here: If, once the documentation is being generated, there are still improvements to be made, those changes should be made to data_flow_ops.py. |
@josh11b So it is a missing mistake of the list, and when could you run the doc generator script? |
@DjangoPeng @josh11b I think Josh's point was that if you add the correct entry to https://github.com/tensorflow/tensorflow/blob/master/tensorflow/python/ops/io_ops.py#L82 then the documentation will get automatically generated (visibility pending our push). Please go ahead and make that change as well as any documentation updates to data_flow_ops.py in this PR. |
@rmlarsen I have added |
Add the class PriorityQueue to the list and it will automatically generate the corresponding documentation with the new description of PriorityQueue
@DjangoPeng Can you please revert the changes from io_ops.md, since this is an autogenerated file, and instead update the documentation in https://github.com/tensorflow/tensorflow/blob/master/tensorflow/python/ops/data_flow_ops.py#L715 if needed. |
@rmlarsen I have reverted the change from |
@tensorflow-jenkins test this please |
As we all know there are 4 subclass of
class QueueBase
, but only 3 subclass(FIFOQueue, PaddingFIFOQueue, RandomShuffleQueue) descriptions in the API Docs hereSo I add the description of
class PriorityQueue()
which are the comments in ../python/ops/data_flow_ops.py.Start line 714 to 759 and you can check here