huggingface/datasets

Return the name of the currently loaded file in the load_dataset function.

Open

#5,806 opened on Apr 28, 2023

View on GitHub
 (19 comments) (2 reactions) (1 assignee)Python (18,313 stars) (2,496 forks)batch import
enhancementgood first issue

Description

Feature request

Add an optional parameter return_file_name in the load_dataset function. When it is set to True, the function will include the name of the file corresponding to the current line as a feature in the returned output.

Motivation

When training large language models, machine problems may interrupt the training process. In such cases, it is common to load a previously saved checkpoint to resume training. I would like to be able to obtain the names of the previously trained data shards, so that I can skip these parts of the data during continued training to avoid overfitting and redundant training time.

Your contribution

I currently use a dataset in jsonl format, so I am primarily interested in the json format. I suggest adding the file name to the returned table here https://github.com/huggingface/datasets/blob/main/src/datasets/packaged_modules/json/json.py#L92.

Contributor guide

Tech stack
python
Domain
datamachine learning
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Knowledge of PythonFamiliarity with datasets library
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
The issue requests adding an optional parameter `return file name` to the `load dataset` function that includes the file name for each line. The implementation should modify the JSON parsing module at `src/datasets/packaged modules/json/json.py#L92`. Ensure backward compatibility and handle different input formats. Check the existing comments for any design discussions or preferred approaches.