Dataset / agree on what `load_by_name` does
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 459
- Forks
- 359
- Avg merge
- 3d 6h
- Merged PRs (30d)
- 73
Description
In the new dataset, several people have already been bugged by the facts that
- An experiment and a run can have any non-unique name
load_experiment_by_nameexpects a unique name
(see e.g. #991)
I think we have an API in conflict with itself, which I suggest that we change. There are two obvious ways to go (with the first way branching into two ways). Either
- An experiment and a run are forced to have a unique name (in one of two ways)
- This happens by raising an error when a name i reused
- This happens by automatically changing the name to a unique one (prepending a number or so)
load_experiment_by_nameexpects a unique name
or
- An experiment and a run can have any non-unique name
load_experiment_by_nameloads all experiments/runs that match the given name
So, which one do you prefer? 1a, 1b, or 2?
@QCoDeS/core @jana-d @majacassidy
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the dataset API entry point for load_experiment_by_name and the related context in #991; the issue names no file or test. This issue is not ready for implementation until the project chooses among 1a, 1b, and 2 and defines the expected behavior for duplicate names.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100