Skip to content

Commit 7ffd180

Browse files
authored
Update README.md
1 parent 870c956 commit 7ffd180

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,10 @@ An easy to use library to speed up computation (by parallelizing on multi CPUs)
5050
```
5151

5252
## Examples
53-
An example of each API is available in [examples.ipynb](https://github.com/nalepae/pandarallel/blob/master/examples.ipynb).
53+
An example of each API is available [here](https://github.com/nalepae/pandarallel/blob/master/docs/examples.ipynb).
5454

5555
## Benchmark
56-
For the `Dataframe.apply` example in [examples.ipynb](https://github.com/nalepae/pandarallel/blob/master/examples.ipynb), here is the comparative benchmark with "standard" `apply` and with `progress_apply` (error bars are too small to be displayed).
56+
For the `Dataframe.apply` example [here](https://github.com/nalepae/pandarallel/blob/master/docs/examples.ipynb), here is the comparative benchmark with "standard" `apply` and with `parallel_apply` (error bars are too small to be displayed).
5757
Computer used for this benchmark:
5858
- OS: Linux Ubuntu 16.04
5959
- Hardware: Intel Core i7 @ 3.40 GHz (4 cores)
@@ -65,16 +65,18 @@ An easy to use library to speed up computation (by parallelizing on multi CPUs)
6565

6666

6767
## API
68-
First, you have to import `pandarallel` (don't forget the double _l_):
68+
First, you have to import `pandarallel`:
6969
```python
7070
from pandarallel import pandarallel
7171
```
7272

73-
| Without parallelisation | With parallelisation |
74-
| --------------------------------- | ----------------------------------------- |
75-
| `df.apply(func, axis=1)` | `df.parallel_apply(func, axis=1)` |
76-
| `series.map(func)` | `series.parallel_apply(func)` |
77-
| `df.groupby(colname).apply(func)` | `df.groupby(colname).parallel_apply(func)` |
73+
With `df` a pandas DataFrame, `series` a pandas Series, `col_name` the name of a pandas Dataframe column & `func` a function to apply/map,
74+
75+
| Without parallelisation | With parallelisation |
76+
| ---------------------------------- | ------------------------------------------- |
77+
| `df.apply(func, axis=1)` | `df.parallel_apply(func, axis=1)` |
78+
| `series.map(func)` | `series.parallel_apply(func)` |
79+
| `df.groupby(col_name).apply(func)` | `df.groupby(col_name).parallel_apply(func)` |
7880

7981
_Note: ``apply`` on DataFrane with ``axis=0`` is not yet implemented._
8082

0 commit comments

Comments
 (0)