Skip to content

Documentation: Update for Reservoir Sampling #919

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JGSweets merged 2 commits into from
Jun 27, 2023
Merged

Documentation: Update for Reservoir Sampling #919

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
47d7b27
update option for reservoir sampling
taylorfturner Jun 27, 2023
44405ee
update for clarity rendering
taylorfturner Jun 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/source/data_readers.rst
View file
Open in desktop
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