Skip to content

Commit cbc36bc

Browse files
authored
Update README.md (#2250)
changes by Stefana Raileanu
1 parent 82977b1 commit cbc36bc

File tree

1 file changed

+23
-17
lines changed
  • AI-and-Analytics/Getting-Started-Samples/IntelModin_Vs_Pandas

1 file changed

+23
-17
lines changed

AI-and-Analytics/Getting-Started-Samples/IntelModin_Vs_Pandas/README.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# `Intel® Modin* Vs. Pandas Performance` Sample
1+
# Modin Vs. Pandas Performance Sample
22

3-
The `Intel® Modin* Vs. Pandas Performance` code illustrates how to use Modin* to replace the Pandas API. The sample compares the performance of Intel® Distribution of Modin* and the performance of Pandas for specific dataframe operations.
3+
The `Modin Vs. Pandas Performance` code illustrates how to use Modin* to replace the Pandas API. The sample compares the performance of Modin and the performance of Pandas for specific dataframe operations.
44

55
| Area | Description
66
|:--- |:---
7-
| What you will learn | How to accelerate the Pandas API using Intel® Distribution of Modin*.
8-
| Time to complete | Less than 10 minutes
97
| Category | Concepts and Functionality
8+
| What you will learn | How to accelerate the Pandas API using Modin.
9+
| Time to complete | Less than 10 minutes
1010

1111
## Purpose
1212

13-
Intel® Distribution of Modin* accelerates Pandas operations using Ray or Dask execution engine. The distribution provides compatibility and integration with the existing Pandas code. The sample code demonstrates how to perform some basic dataframe operations using Pandas and Intel® Distribution of Modin*. You will be able to compare the performance difference between the two methods.
13+
Modin accelerates Pandas operations using Ray or Dask execution engine. The distribution provides compatibility and integration with the existing Pandas code. The sample code demonstrates how to perform some basic dataframe operations using Pandas and Modin. You will be able to compare the performance difference between the two methods.
1414
You can run the sample locally or in Google Colaboratory (Colab).
1515

1616
## Prerequisites
@@ -25,25 +25,25 @@ You can run the sample locally or in Google Colaboratory (Colab).
2525

2626
This code sample is implemented for CPU using Python programming language. The sample requires NumPy, Pandas, Modin libraries, and the time module in Python.
2727

28-
## Run the `Intel® Modin Vs Pandas Performance` Sample Locally
28+
## Environment Setup
2929

30-
If you want to run the sample on a local system using a command-line interface (CLI), you must install the Intel® Distribution of Modin* in a new Conda* environment first.
30+
If you want to run the sample on a local system using a command-line interface (CLI), you must install the Modin in a new Conda* environment first.
3131

32-
### Install the Intel® Distribution of Modin*
32+
### Install Modin
3333

3434
1. Create a Conda environment.
3535
```
36-
conda create --name aikit-modin
36+
conda create --name modin
3737
```
3838
2. Activate the Conda environment.
3939
```
40-
source activate aikit-modin
40+
source activate modin
4141
```
4242
3. Remove existing versions of Modin* (if any exist).
4343
```
4444
conda remove modin --y
4545
```
46-
4. Install Intel® Distribution of Modin* (v0.12.1 or newer).
46+
4. Install Modin (v0.12.1 or newer).
4747
```
4848
pip install modin[all]==0.12.1
4949
```
@@ -58,24 +58,24 @@ If you want to run the sample on a local system using a command-line interface (
5858
```
5959
### Run the Sample
6060

61-
1. Change to the directory containing the `IntelModin_Vs_Pandas.ipynb` notebook file on your local system.
61+
1. Change to the directory containing the `Modin_Vs_Pandas.ipynb` notebook file on your local system.
6262

6363
2. Run the sample notebook.
6464
```
65-
ipython IntelModin_Vs_Pandas.ipynb
65+
ipython Modin_Vs_Pandas.ipynb
6666
```
6767

68-
## Run the `Intel® Modin Vs Pandas Performance` Sample in Google Colaboratory
68+
## Run the `Modin Vs Pandas Performance` Sample in Google Colaboratory
6969

70-
1. Change to the directory containing the `IntelModin_Vs_Pandas.ipynb` notebook file on your local system.
70+
1. Change to the directory containing the `Modin_Vs_Pandas.ipynb` notebook file on your local system.
7171

7272
2. Open the notebook file, and remove the prepended number sign (#) symbol from the following lines:
7373
```
7474
#!pip install modin[all]==0.12.1
7575
#!pip install numpy
7676
#!pip install pandas
7777
```
78-
These changes will install the Intel® Distribution of Modin* and the NumPy and Pandas libraries when run in the Colab notebook.
78+
These changes will install the Modin and the NumPy and Pandas libraries when run in the Colab notebook.
7979

8080
3. Save your changes.
8181

@@ -100,11 +100,17 @@ CPU times: user 8.47 s, sys: 132 ms, total: 8.6 s
100100
Wall time: 8.57 s
101101
```
102102

103-
Example expected cell output is included in `IntelModin_Vs_Pandas.ipynb`.
103+
Example expected cell output is included in `Modin_Vs_Pandas.ipynb`.
104+
105+
## Related Samples
106+
107+
* [Modin Get Started Sample](https://github.com/oneapi-src/oneAPI-samples/tree/master/AI-and-Analytics/Getting-Started-Samples/Modin_GettingStarted)
104108

105109
## License
106110

107111
Code samples are licensed under the MIT license. See
108112
[License.txt](https://github.com/oneapi-src/oneAPI-samples/blob/master/License.txt) for details.
109113

110114
Third party program licenses are at [third-party-programs.txt](https://github.com/oneapi-src/oneAPI-samples/blob/master/third-party-programs.txt).
115+
116+
*Other names and brands may be claimed as the property of others. [Trademarks](https://www.intel.com/content/www/us/en/legal/trademarks.html)

0 commit comments

Comments
 (0)