Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updating pbp and weekly imports to reflect addition of downcast feature
  • Loading branch information
cooperdff authored Aug 2, 2021
1 parent e77401c commit 999c416
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,16 @@ import nfl_data_py as nfl

**Working with play-by-play data**
```python
nfl.import_pbp_data(years, columns)
nfl.import_pbp_data(years, columns, downcast=True)
```
Returns play-by-play data for the years and columns specified

years
: required, list of years to pull data for (earliest available is 1999)
columns
: optional, list of columns to pull data for
downcast
: converts float64 columns to float32, reducing memory usage by ~30%. Will slow down initial load speed ~50%

```python
nfl.see_pbp_cols()
Expand All @@ -36,14 +38,16 @@ returns list of columns available in play-by-play dataset

**Working with weekly data**
```python
nfl.import_weekly_data(years, columns)
nfl.import_weekly_data(years, columns, downcast)
```
Returns weekly data for the years and columns specified

years
: required, list of years to pull data for (earliest available is 1999)
columns
: optional, list of columns to pull data for
downcast
: converts float64 columns to float32, reducing memory usage by ~30%. Will slow down initial load speed ~50%

```python
nfl.see_weekly_cols()
Expand Down

0 comments on commit 999c416

Please sign in to comment.