DOCS-#3904: Improving Modin README #3929
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
naren-ponder
commented
Jan 11, 2022
Codecov Report
@@ Coverage Diff @@
## master #3929 +/- ##
===========================================
- Coverage 85.59% 36.41% -49.18%
===========================================
Files 201 187 -14
Lines 16671 15893 -778
===========================================
- Hits 14269 5787 -8482
- Misses 2402 10106 +7704
Continue to review full report at Codecov.
|
|
|
|
mvashishtha
reviewed
Jan 11, 2022
dorisjlee
reviewed
Jan 12, 2022
There was a problem hiding this comment.
Looks pretty good. I think @dorisjlee leaves a very good comment about demo-able code block straight away.
|
I'd probably mention explicitly somewhere that performance effect could better be seen on large datasets and on small data sets perf can be worse than pandas |
|
We also miss mentioning of current conda-forge version |
YarShev
reviewed
Jan 17, 2022
|
@naren-ponder : Once we finalize the README content (add GIF and TOC), can we also migrate the same content over to our home page for ReadTheDocs? |
mvashishtha
requested changes
Jan 21, 2022
mvashishtha
previously approved these changes
Jan 21, 2022
naren-ponder
commented
Jan 21, 2022
There was a problem hiding this comment.
One change I would propose structurally is moving the "Choosing a Compute Engine + Which engine should I use?" sections right after "Installation" and before "Pandas API Coverage". I think this makes more logical sense since we discuss installing with different engines anyhow.
Additionally, for the sake of simplicity for the README I propose removing the "Advanced Usage" subsection concerning initializing Ray and Dask with custom resource constraints. Resource constrained installations are covered by https://github.com/modin-project/modin/pull/3965/files as part of using_modin_locally in the documentation and I don't see a need for it in the README.
I also suggest retitling the "Full Documentation" section to "More about Modin". I also think we should retitle the "More information and Getting Involved" section at the end to "General Resources and Getting Involved", and adding links there to tutorials, blog posts, and other interesting links that would then be easily accessible directly from the README.
dorisjlee
reviewed
Jan 22, 2022
Signed-off-by: Naren Krishna <naren@ponder.io>
Signed-off-by: Naren Krishna <naren@ponder.io>
Co-authored-by: Mahesh Vashishtha <mvashishtha@users.noreply.github.com>
Signed-off-by: Naren Krishna <naren@ponder.io>
Signed-off-by: Naren Krishna <naren@ponder.io>
Signed-off-by: Naren Krishna <naren@ponder.io>
Signed-off-by: Naren Krishna <naren@ponder.io>
Co-authored-by: Doris Lee <dorisjunglinlee@gmail.com>
Signed-off-by: Naren Krishna <naren@ponder.io>
Co-authored-by: Doris Lee <dorisjunglinlee@gmail.com>
Signed-off-by: Naren Krishna <naren@ponder.io>
Signed-off-by: Naren Krishna <naren@ponder.io>
Signed-off-by: Naren Krishna <naren@ponder.io>
Signed-off-by: Naren Krishna <naren@ponder.io>
Signed-off-by: Naren Krishna <naren@ponder.io>
YarShev
reviewed
Jan 24, 2022
Signed-off-by: Naren Krishna <naren@ponder.io>
Signed-off-by: Naren Krishna <naren@ponder.io>
YarShev
previously approved these changes
Jan 24, 2022
There was a problem hiding this comment.
@naren-ponder, LGTM, thanks! Do not forget to link an issue to be resolved by this PR in the PR description.
Signed-off-by: Naren Krishna <naren@ponder.io>
dorisjlee
approved these changes
Jan 25, 2022
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.
Signed-off-by: Naren Krishna naren@ponder.io
What do these changes do?
Fix links in the Modin README and improve some of the wording in both the FAQ and README. Resolves #3904
flake8 modin/ asv_bench/benchmarks scripts/doc_checker.pyblack --check modin/ asv_bench/benchmarks scripts/doc_checker.pygit commit -sdocs/developer/architecture.rstis up-to-date