ray icon indicating copy to clipboard operation
ray copied to clipboard

[Data][Docs] Remove "Data Representations (internal)"

Open bveeramani opened this issue 1 year ago • 3 comments

Why are these changes needed?

We shouldn't document Data internals that aren't relevant to developers.

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 :(

bveeramani avatar Jun 14 '23 22:06 bveeramani

seems like block is being referenced here /ray/doc/source/data/examples/custom-datasource.rst:97: WARNING: undefined label: block-api, and generally is part of the DeveloperAPI for creating new datasources.

amogkam avatar Jun 15 '23 00:06 amogkam

seems like block is being referenced here /ray/doc/source/data/examples/custom-datasource.rst:97: WARNING: undefined label: block-api, and generally is part of the DeveloperAPI for creating new datasources.

@amogkam where would we put the Block reference? Maybe somewhere in the Dataset reference?

bveeramani avatar Jun 15 '23 00:06 bveeramani

I think it's fine to keep under Data Representations. And we can downgrade it to developer API.

amogkam avatar Jun 15 '23 00:06 amogkam