[data] correct api annotation for tfrecords_datasource #46171
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: can <[email protected]>
can-anyscale
requested review from
ericl,
scv119,
c21,
amogkam,
scottjlee,
bveeramani,
raulchen,
stephanie-wang and
omatthew98
as code owners
bveeramani
reviewed
Jun 28, 2024
doc/source/data/api/data_source.rst
Outdated
| @@ -0,0 +1,12 @@ | |||
| .. _data-source-api: | |||
|
|
|||
| Global configuration | |||
There was a problem hiding this comment.
To minimize clutter in the sidebar and improve the discoverability of TFXReadOptions, could we co-locate this reference with read_tfrecords in the Input/Output page? I don't think we should place TFXReadOptions on a page by itself if it's only used with read_tfrecords
Signed-off-by: can <[email protected]>
|
@bveeramani's comments |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
tfrecords_datasourcehas two APIs:TFRecordDatasourceshould be internal andTFXReadOptionsshould be public. To do so, I splittedtfrecords_datasource.pyinto two parts.Test: