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

DOCS-#3904: Improving Modin README #3929

Merged
merged 24 commits into from
Jan 25, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
some minor fixes
Signed-off-by: Naren Krishna <naren@ponder.io>
  • Loading branch information
naren-ponder committed Jan 24, 2022
commit 6d44ec76134dfc189ff544e8374fbd759cf3d251
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@ export MODIN_ENGINE=dask # Modin will use Dask
This can also be done within a notebook/interpreter before you import Modin:

```python
import modin.pandas as pd
from modin.config import Engine

Engine.put("ray") # Modin will use Ray
Expand Down Expand Up @@ -163,7 +162,7 @@ for prototyping on a few MBs of data do not scale to tens or hundreds of GBs (de
of your machine). Modin supports operating on data that does not fit in memory, so that you can comfortably
work with hundreds of GBs without worrying about substantial slowdown or memory errors.
With [cluster](https://modin.readthedocs.io/en/latest/getting_started/using_modin/using_modin_cluster.html)
and [out of core](https://modin.readthedocs.io/en/latest/getting_started/out_of_core.html)
and [out of core](https://modin.readthedocs.io/en/latest/getting_started/why_modin/out_of_core.html)
support, Modin is a DataFrame library with both great single-node performance and high
scalability in a cluster.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ import with Modin import:

Which execution engine (Ray or Dask) should I use for Modin?
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""

Modin lets you effortlessly speed up your pandas workflows with either Ray_'s or Dask_'s execution engine.
naren-ponder marked this conversation as resolved.
Show resolved Hide resolved
You don't need to know anything about either engine in order to use it with Modin. If you only have one engine
installed, Modin will automatically detect which engine you have installed and use that for scheduling computation.
Expand All @@ -119,7 +120,6 @@ This can also be done with:

.. code-block:: python

import modin.pandas as pd
from modin.config import Engine

Engine.put("ray") # Modin will use Ray
Expand Down