DOC: document missing save_infos and max_depth parameters#8223
Open
kratos0718 wants to merge 1 commit into
Open
DOC: document missing save_infos and max_depth parameters#8223kratos0718 wants to merge 1 commit into
kratos0718 wants to merge 1 commit into
Conversation
Two undocumented parameters in public API functions: 1. load_dataset() was missing save_infos from its Args section. When save_infos=True, verification_mode is forced to ALL_CHECKS to run full checksums/size/splits verification. 2. Dataset.flatten() was missing max_depth from its Args section. Controls how many nesting levels are flattened; defaults to 16.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this fixes
Two public API functions were missing parameters from their docstrings:
1.
load_dataset()— missingsave_infosThe
save_infosparameter has been in the function signature but was absent from theArgssection of the docstring. Whensave_infos=True, it overridesverification_modeand forces it toVerificationMode.ALL_CHECKS, running full checksums/size/splits verification.2.
Dataset.flatten()— missingmax_depthThe
max_depthparameter (default16) controls how many nesting levels are flattened, but was not documented in theArgssection.Files changed
src/datasets/load.py— addedsave_infostoload_datasetdocstringsrc/datasets/arrow_dataset.py— addedmax_depthtoDataset.flattendocstring