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

Making changes to readme #7

Merged
merged 1 commit into from
Jun 24, 2018
Merged
Changes from all commits
Commits
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
26 changes: 23 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,33 @@ Modin
.. image:: https://travis-ci.com/modin-project/modin.svg?branch=master
:target: https://travis-ci.com/modin-project/modin

.. image:: //readthedocs.org/projects/modin/badge/?version=latest
.. image:: https://readthedocs.org/projects/modin/badge/?version=latest
:target: https://modin.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

|

*Modin is the parent project of Pandas on Ray*

Modin can be installed with pip: ``pip install modin``

Pandas on Ray
-------------

Make your pandas code faster by changing only one line of code.
*Pandas on Ray is a project designed to effortlessly scale your pandas code requiring a change of only a single line of code*

+----------------------------------------------+-------------------------------------------------+
| **pandas** | **Pandas on Ray** |
+----------------------------------------------+-------------------------------------------------+
|.. code-block:: python |.. code-block:: python |
| | |
| # Normal pandas import | # Pandas on Ray import |
| import pandas as pd | import modin.dataframe as pd |
| | |
| df = pd.DataFrame({'col1': [1, 2, 3], | df = pd.DataFrame({'col1': [1, 2, 3], |
| 'col2': [1.0, 2.0, 3.0]}) | 'col2': [1.0, 2.0, 3.0]}) |
| | |
| df.sum() | df.sum() |
| ... | ... |
+----------------------------------------------+-------------------------------------------------+

**Pandas on Ray is currently for experimental use only. Requests and contributions are welcome!**