Skip to content

Commit

Permalink
Documentation: Update for Reservoir Sampling (#919)
Browse files Browse the repository at this point in the history
* update option for reservoir sampling

* update for clarity rendering
  • Loading branch information
taylorfturner authored Jun 27, 2023
1 parent 46a62c5 commit 5a254f4
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/source/data_readers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,11 @@ be specified using the options dict parameter.
Possible `options`:

* delimiter - Must be a string, for example `"delimiter": ","`
* data_format - must be a string, possible choices: "dataframe", "records"
* selected_columns - columns being selected from the entire dataset, must be a
* data_format - Must be a string, possible choices: "dataframe", "records"
* selected_columns - Columns being selected from the entire dataset, must be a
list `["column 1", "ssn"]`
* sample_nrows - Reservoir sampling to sample `"n"` rows out of a total of `"M"` rows.
Specified for how many rows to sample, default None.
* header - Define the header, for example

* `"header": 'auto'` for auto detection
Expand Down

0 comments on commit 5a254f4

Please sign in to comment.