MLMI2-CSSI / MLMI2-CSSI/foundry

Dataset with splits

Open
#401 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
88
Forks
17
PR merge metrics
No merged PRs in 30d

Description

As a foundry dataset user I want to manage splits in a dataset so I don't have to download the entire dataset

Description

The DatasetCache class will need to manage splits alongside datasets.
The Dataset class will have a split_labels method to return the list of valid split labels.

Assumptions

  1. The DatasetCache class' download_dataset method will be renamed download_dataset_split
  2. The as_pandas accepts a split label argument.
  3. split labels will be received from search metadata

Acceptance Criteria

f = Foundry()
datsets = f.search("DOI123/445")
labels = datasets[0].split_labels()
df = datasets[0].as_pandas(split=labels[0])
f = Foundry()
datsets = f.search("DOI123/445")
df = datasets[0].as_pandas(split="doesnotexist")

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating DatasetCache.download_dataset, Dataset.split_labels, Dataset.as_pandas, and the search metadata handling. Trace how datasets and cached downloads currently flow, then check the existing tests around these entry points. Done means split labels are exposed, split downloads and pandas loading accept a split, and the documented missing-label case has defined behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.