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
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
fix faq links
Signed-off-by: Naren Krishna <naren@ponder.io>
  • Loading branch information
naren-ponder committed Jan 24, 2022
commit 3d7b5a8fd498aedf7df3d6c49c68ab428966d0b6
22 changes: 11 additions & 11 deletions docs/getting_started/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The :py:class:`~modin.pandas.dataframe.DataFrame` is a highly
scalable, parallel DataFrame. Modin transparently distributes the data and computation so
that you can continue using the same pandas API while being able to work with more data faster.
Modin lets you use all the CPU cores on your machine, and because it is lightweight, it
often has less memory overhead than pandas. See this :doc:`page </getting_started/pandas>` to
often has less memory overhead than pandas. See this :doc:`page <getting_started/why_modin/pandas>` to
learn more about how Modin is different from pandas.

Why not just improve pandas?
Expand Down Expand Up @@ -54,12 +54,12 @@ with dataframes that don't fit into the available memory. As a result, pandas wo
for prototyping on a few MBs of data do not scale to tens or hundreds of GBs (depending on the size
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. For more information,
see :doc:`out-of-memory support <getting_started/out_of_core>` for Modin.
see :doc:`out-of-memory support <getting_started/why_modin/out_of_core>` for Modin.

How does Modin compare to Dask DataFrame and Koalas?
""""""""""""""""""""""""""""""""""""""""""""""""""""

Check out this :doc:`page <getting_started/modin_vs_dask_vs_koalas>` detailing the differences!
Check out this :doc:`page <getting_started/why_modin/modin_vs_dask_vs_koalas>` detailing the differences!
naren-ponder marked this conversation as resolved.
Show resolved Hide resolved
naren-ponder marked this conversation as resolved.
Show resolved Hide resolved

How does Modin work under the hood?
"""""""""""""""""""""""""""""""""""
Expand All @@ -73,7 +73,7 @@ The Modin Core DataFrame is our efficient DataFrame implementation that utilizes
which allows for distributing tasks and queries. From here, the Modin DataFrame works with engines like
Ray or Dask to execute computation, and then return the results to the user.

For more details, take a look at our system :doc:`architecture </development/architecture>`.
For more details, take a look at our system :doc:`architecture <development/architecture>`.

FAQs: How to use Modin?
-----------------------
Expand Down Expand Up @@ -123,7 +123,7 @@ This can also be done with:
from modin.config import Engine

Engine.put("ray") # Modin will use Ray
Engine.put("dask") # Modin will use Dask
Engine.put("dask") # Modin will use Dask

We also have an experimental OmniSciDB-based engine of Modin you can read about :doc:`here </development/using_omnisci>`.
We plan to support more execution engines in future. If you have a specific request,
Expand Down Expand Up @@ -170,16 +170,16 @@ How can I contribute to Modin?

**Modin is currently under active development. Requests and contributions are welcome!**

If you are interested in contributing please check out the :doc:`Getting Started</getting_started/index>`
guide then refer to the :doc:`Development Documentation</development/index>` section,
If you are interested in contributing please check out the :doc:`Contributing Guide<development/contributing>`
and then refer to the :doc:`Development Documentation</development/index>`,
where you can find system architecture, internal implementation details, and other useful information.
Also check out the `Github`_ to view open issues and make contributions.

.. _issue: https://github.com/modin-project/modin/issues
.. _Slack: https://modin.org/slack.html
.. _Slack: https://join.slack.com/t/modin-project/shared_invite/zt-yvk5hr3b-f08p_ulbuRWsAfg9rMY3uA
.. _Github: https://github.com/modin-project/modin
.. _Ray: https://github.com/ray-project/ray/
.. _Dask: https://dask.org/
.. _papers: https://arxiv.org/abs/2001.00888
.. _guide: https://modin.readthedocs.io/en/stable/installation.html?#installing-on-google-colab
.. _Dask: https://github.com/dask/dask
.. _papers: https://people.eecs.berkeley.edu/~totemtang/paper/Modin.pdf
.. _guide: https://modin.readthedocs.io/en/latest/getting_started/installation.html#installing-on-google-colab
.. _tutorial: https://github.com/modin-project/modin/tree/master/examples/tutorial