Skip to content

Commit

Permalink
Making changes to readme (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
@devin-petersohn @kunalgosar
devin-petersohn authored and kunalgosar committed Jun 24, 2018
1 parent 571abe6 commit 0602b4d
Showing 1 changed file with 23 additions and 3 deletions.
26 changes: 23 additions & 3 deletions README.rst
View file
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!**

0 comments on commit 0602b4d

Please sign in to comment.