Skip to content

[Datasets] [Docs] Datasets library branding + positioning tweaks#22067

Merged
ericl merged 3 commits intoray-project:masterfrom
clarkzinzow:datasets/docs/updates
Feb 6, 2022
Merged

[Datasets] [Docs] Datasets library branding + positioning tweaks#22067
ericl merged 3 commits intoray-project:masterfrom
clarkzinzow:datasets/docs/updates

Conversation

@clarkzinzow
Copy link
Copy Markdown
Contributor

@clarkzinzow clarkzinzow commented Feb 2, 2022

This PR restores the "Ray Datasets" library branding and makes a few tweaks around last-mile preprocessing positioning. Larger changes, such as:

  1. Changing the landing page to give an overview of Ray's data ecosystem.
  2. Create dedicated user guide pages for creating/saving datasets (I/O), transforming datasets, exchanging datasets with other frameworks, and pipelining operations.
  3. Trim "Getting Started" down to a linear flow.
  4. Change hierarchy to Ray Data --> {Datasets, Third Party Integrations --> {Dask-on-Ray, Modin, etc.}}.

will take place in a future PR.

Copy link
Copy Markdown
Contributor

@ericl ericl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change overall seems right to me (fixes some accuracy issues).

@ericl
Copy link
Copy Markdown
Contributor

ericl commented Feb 3, 2022

rv = self.filter(record)
  | File "/opt/miniconda/lib/python3.6/logging/init.py", line 720, in filter
  | result = f.filter(record)
  | File "/opt/miniconda/lib/python3.6/site-packages/sphinx/util/logging.py", line 430, in filter
  | raise exc
  | sphinx.errors.SphinxWarning: /ray/doc/source/data/getting-started.rst:3:Title overline too short.
 


@ericl ericl added the @author-action-required The PR author is responsible for the next step. Remove tag to send back to the reviewer. label Feb 3, 2022
@ericl
Copy link
Copy Markdown
Contributor

ericl commented Feb 3, 2022

Sounds like we agree on the next steps. While we ponder the right wording, @clarkzinzow want to fix the LINT error?

@clarkzinzow clarkzinzow force-pushed the datasets/docs/updates branch from d74784c to f58c64a Compare February 3, 2022 22:15
@clarkzinzow clarkzinzow force-pushed the datasets/docs/updates branch from 86e0ac1 to 4643887 Compare February 4, 2022 22:45
@ericl ericl merged commit fb0d6e6 into ray-project:master Feb 6, 2022
ericl added a commit that referenced this pull request Feb 17, 2022
* [docs] landing page (fixes #21750) (#21859)

Co-authored-by: Richard Liaw <rliaw@berkeley.edu>

* [Doc] Fix bad doc and recover doc of c++ api (#22213)

* [Docs] Ray Data docs target state (#21931)

Preview: [docs](https://ray--21931.org.readthedocs.build/en/21931/data/dataset.html)

The Ray Data project's docs now have a clearer structure and have partly been rewritten/modified. In particular we have

- [x] A Getting Started Guide
- [x] An explicit User / How-To Guide
- [x] A dedicated Key Concepts page
- [x] A consistent naming convention in `Ray Data` whenever is is referred to the project.

This surfaces quite clearly that, apart from the "Getting Started" sections, we really only have one real example. Once we have more, we can create an "Example" section like many other sub-projects have. This will be addressed in #21838.

* [Datasets] [Docs] Datasets library branding + positioning tweaks (#22067)

* [train] Minor fixes on Ray Train user guide doc (#22379)

Fixes some typos and format issues.

* [Doc] Fix bad links of dask and mars in ray-libraries.rst (#22210)

* merge

Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>

* merge

Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>

* merge

Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>

* [docs] Clean up long titles in TOC (#22016)

* LINT

Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>

Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
Co-authored-by: Guyang Song <guyang.sgy@antfin.com>
Co-authored-by: Clark Zinzow <clarkzinzow@gmail.com>
Co-authored-by: Hao Chen <chenh1024@gmail.com>
Co-authored-by: Eric Liang <ekhliang@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

@author-action-required The PR author is responsible for the next step. Remove tag to send back to the reviewer.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants