From 2607c212342286b2972dbd937184404a0a875326 Mon Sep 17 00:00:00 2001 From: Devin Petersohn Date: Sun, 24 Jun 2018 15:51:52 -0700 Subject: [PATCH] Making changes to readme --- README.rst | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 9ff79b471b4..768086acedb 100644 --- a/README.rst +++ b/README.rst @@ -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!**