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

[Data] Fix read_tfrecords() docstring to display tfx-bsl tip #46717

Merged
merged 4 commits into from
Jul 22, 2024

Conversation

scottjlee
Copy link
Contributor

@scottjlee scottjlee commented Jul 19, 2024

Why are these changes needed?

The documentation for read_tfrecords() is missing the section about tfx-bsl optimization, because the .. info:: tag is not recognized. Change it to a tip instead.

Now looks like:
Screenshot at Jul 22 09-23-24

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

Signed-off-by: Scott Lee <[email protected]>
Signed-off-by: Scott Lee <[email protected]>
Signed-off-by: Scott Lee <[email protected]>
@scottjlee scottjlee marked this pull request as ready for review July 22, 2024 16:23
@scottjlee scottjlee added the go add ONLY when ready to merge, run all tests label Jul 22, 2024
@bveeramani bveeramani merged commit d0b46ef into ray-project:master Jul 22, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
go add ONLY when ready to merge, run all tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants