Skip to content

Commit 7c03938

Browse files
authored
Added direction for locally cached dataset in task_guide.md (#691)
Added direction for the user to add their locally cached dataset.
1 parent 7de55df commit 7c03938

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/task_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Task naming + registration:
2121
Dataset configuration options:
2222
- **dataset_path** (`str`) — The name of the dataset as listed by HF in the datasets Hub.
2323
- **dataset_name** (`str`, *optional*, defaults to None) — The name of what HF calls a `config` or `subset` of the benchmark. If your task does not contain any data instances, just leave this to default to None. (If you're familiar with the HF `datasets.load_dataset` function, these are just the first 2 arguments to it.)
24-
- **dataset_kwargs** (`dict`, *optional*) — Auxiliary arguments that `datasets.load_dataset` accepts. This can be used to specify arguments such as `data_files` or `data_dir` if you want to use local datafiles such as json or csv.
24+
- **dataset_kwargs** (`dict`, *optional*) — Auxiliary arguments that `datasets.load_dataset` accepts. This can be used to specify arguments such as `data_files` or `data_dir` if you want to use local datafiles such as json or csv. If you wish to use a locally cached dataset, set the cache_dir parameter to the parent directory of the Hugging Face dataset cache. Specifically, this should be the directory containing the datasets--<organization>--<dataset_name> folder (i.e., one level above the actual cached dataset directory).
2525
- **test_split** (`str`, *optional*) — Split in the dataset to use as the test split. This is required for denoting the `split` of the HF dataset.
2626
- **training_split** (`str`, *optional*) — Split in the dataset to use as the training split.
2727
- **validation_split** (`str`, *optional*) — Split in the dataset to use as the validation split.

0 commit comments

Comments
 (0)