Update README.md generalizing all cuDF components - #20357
Conversation
mroeschke
added
improvement
bdice
left a comment
bdice
left a comment
There was a problem hiding this comment.
Initial feedback. I recommend looking over some of these for additional inspiration: https://github.com/matiassingers/awesome-readme
Co-authored-by: Bradley Dice <bdice@bradleydice.com> Co-authored-by: Matthew Murray <41342305+Matt711@users.noreply.github.com>
vyasr
left a comment
vyasr
left a comment
There was a problem hiding this comment.
This is a great first step. I left one comment, but I think in general we can go ahead and iterate from here. I suggest that we think about including the README into the top-level index file in the cudf documentation. That was something I had intended way back when I was spending more time on our docs with the intent of providing a more unified presentation of the different layers of the cudf stack. Once we have that we can include more of our diagrams and perhaps provide a more unified presentation of all the components.
| ``` | ||
|
|
||
| ## Installation | ||
| A development version of each library is available as a nightly release by specifying the `-c rapidsai-nightly` channel instead. |
There was a problem hiding this comment.
If we're mentioning development versions, we should also mention the nightly wheels https://anaconda.org/rapidsai-wheels-nightly/repo?type=pypi&label=main
|
/merge |
The cuDF documentation, https://docs.rapids.ai/api/cudf/stable/, is primarily cudf Python focused. Similar to what was done in #20357 with the README, I think it would be good to reorient our documentation to highlight all projects on the landing page and migrate all our cuDF Python specific pages into the `source/cudf/` directory. This PR primarily **moves** documentation and only renames/modifies content for "unification" * The landing page now mirrors the "About" section in our README, noting all the projects that live in the cudf repo * The top level "developer guide" now links to each project's developer guide where content was moved * A few directories renamed for unification e.g. `libcudf_docs` -> `libcudf`, `user_guide` -> `cudf` (where all the content was cudf Python focused) I'd recommend reviewing `docs/cudf/source/index.rst` as it underwent the most change Authors: - Matthew Roeschke (https://github.com/mroeschke) Approvers: - Mads R. B. Kristensen (https://github.com/madsbk) - Vyas Ramasubramani (https://github.com/vyasr) URL: #22352
4 participants
Description
This PR is essentially a net-rewrite of the
README.mdthat was previously, heavily pandas focus.The rewrite tries to:
Open to other items to include
The rendered version can also be viewed at https://github.com/mroeschke/cudf/blob/ref/cudf/readme/README.md
Checklist