Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardize artifact_type typing in _get_v1_dataset, _upload_v1_dataset and _upload_benchmark #212

Closed
mercuryseries opened this issue Oct 30, 2024 · 0 comments · Fixed by #230
Assignees

Comments

@mercuryseries
Copy link
Contributor

Context

In the _get_v1_dataset, _upload_v1_dataset, and _upload_benchmark methods, the artifact_type parameter is typed as ArtifactSubtype, but in many instances, we pass a string instead. This inconsistency can lead to confusion or potential issues.

Description

To improve code consistency and maintainability, the artifact_type parameter should be standardized to consistently use ArtifactSubtype in _get_v1_dataset, _upload_v1_dataset, and _upload_benchmark methods. This will involve refactoring any instances where a string is passed instead of ArtifactSubtype. Additionally, any dependencies, tests, or documentation related to these methods should be reviewed to ensure compatibility and stability.

Acceptance Criteria

  • The artifact_type parameter is consistently typed as ArtifactSubtype in _get_v1_dataset, _upload_v1_dataset, and _upload_benchmark.
  • All instances where a string is passed as artifact_type are updated to ArtifactSubtype.
  • Code and comments are updated to reflect this change.
  • All related tests pass without regression.

Links

@mercuryseries mercuryseries self-assigned this Nov 18, 2024
mercuryseries added a commit that referenced this issue Dec 9, 2024
@mercuryseries mercuryseries mentioned this issue Dec 9, 2024
5 tasks
mercuryseries added a commit that referenced this issue Dec 19, 2024
* start jogging with issue #212

* Replace all occurences of tmpdir with tmp_path

* add comment and fix small typo

* Update list_datasets and list_benchmarks to include support for v2 artifacts.

Co-authored-by: Julien St-Laurent <jstlaurent@users.noreply.github.com>

* Apply review feedback

Co-authored-by: Cas Wognum <cwognum@users.noreply.github.com>

* more changes to cover edge cases

* Refactoring

Co-authored-by: Cas Wognum <cwognum@users.noreply.github.com>

---------

Co-authored-by: Julien St-Laurent <jstlaurent@users.noreply.github.com>
Co-authored-by: Cas Wognum <cwognum@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant