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.

Sign up for GitHub

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

Jump to bottom

feat: Artifact Versioning #272

Open
wants to merge 23 commits into
base: main
Choose a base branch
from
Open

feat: Artifact Versioning #272

wants to merge 23 commits into from
+181 −75

Conversation

roselynh100
Copy link

@roselynh100 roselynh100 commented Feb 25, 2025 •
edited
Loading

Changelogs

⭐ Hub changes here!

  • Artifact Model:
    • Added version fields artifact_version and artifact_changelog to datasets and benchmarks
    • Created a slug field_validator to accept a slug from the Hub (if passed), otherwise slugifys the name
    • Modified the urn_for method to use a new function build_urn
  • Uploading new versions: parent_artifact_id (owner/slug) can be specified in dataset/benchmark upload_to_hub, upload_dataset, or upload_benchmark functions
    • This will attempt to upload the new artifact as the direct child of the parent
  • Name → Slug: Replaced many instances of name with slug (e.g. in get_artifact, etc)
  • Documentation: Wrote docstrings explaining artifact_version, artifact_changelog, and parent_artifact_id. Also mentioned how to upload a new version (at the end of Create a Dataset and Create a Benchmark tutorials)
    Preview

Checklist:

  • Was this PR discussed in an issue? It is recommended to first discuss a new feature into a GitHub issue before opening a PR.
  • Add tests to cover the fixed bug(s) or the newly introduced feature(s) (if appropriate).
  • Update the API documentation if a new function is added, or an existing one is deleted.
  • Write concise and explanatory changelogs above.
  • If possible, assign one of the following labels to the PR: feature, fix, chore, documentation or test (or ask a maintainer to do it for you).

roselynh100 and others added 22 commits January 22, 2025 14:32
@roselynh100
Add versioning fields to dataset, uploading v1 dataset has version
f0b75ce
@roselynh100
Move no-changelog error to Hub service code
8da6a75
@roselynh100
logger.info if there's a more recent dataset-v1 to load
d372195
@roselynh100
build_urn function, to upload to buckets by slug
ca3bcb6
@roselynh100
remove later version check in load_dataset, for now
b4f9900
@roselynh100
Remove artifact_version from BaseDataset
6f010a7
@roselynh100
Add artifact_version back to BaseDataset
468831e
@roselynh100
dataset.slug??
5f39c2a
@roselynh100
rename get_dataset arg: name -> slug
62a1dea
@roselynh100
validate slug (fixed)
0db7a4f
@roselynh100
_upload_v2_dataset
b79f7f6
@roselynh100
Reformat dataset upload success message
2e476b6
@roselynh100
change model_validator to field_validator for slug
8d631a6
@roselynh100
remove unused import
6fe96e5
@roselynh100
comment about when slug could be None
39370cb
@roselynh100
Merge branch 'main' into feat/artifact-versioning
836e0db
@roselynh100
remove comment
671c3f0
@roselynh100
lint
b9cc33e
@roselynh100
format
144a41b
@roselynh100
fix slugifying None name
d2cbf6f
@roselynh100
feat: Artifact Versioning - upload benchmark (#270)
ced1f8a 
* benchmark-v1 uploadAsNewVersion

* get_benchmark name -> slug

* upload_as_new_version for benchmark-v2

* parent_slug instead of upload_as_new_version

* parent_slug -> parent_artifact_id

* add parent_artifact_id to upload_to_hub functions

* update documentation with parent_artifact_id

* add comments
@roselynh100
Merge branch 'main' into feat/artifact-versioning
a12a80c
@roselynh100 roselynh100 self-assigned this Feb 25, 2025
@roselynh100 roselynh100 added the feature Annotates any PR that adds new features; Used in the release process label Feb 25, 2025
@roselynh100 roselynh100 marked this pull request as ready for review February 26, 2025 19:04
@roselynh100 roselynh100 requested a review from cwognum as a code owner February 26, 2025 19:04
jstlaurent
jstlaurent approved these changes Feb 27, 2025
View reviewed changes
Copy link
Contributor

@jstlaurent jstlaurent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice! 😄

mercuryseries
mercuryseries approved these changes Feb 27, 2025
View reviewed changes
Copy link
Contributor

@mercuryseries mercuryseries left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! Thanks, @roselynh100!

PS: I forgot to mention this in my Hub PR message (better late than never, right?), but I really appreciate the attention to detail with the PR description, the GIF, and all the little touches 💅!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jstlaurent jstlaurent jstlaurent approved these changes

@mercuryseries mercuryseries mercuryseries approved these changes

@cwognum cwognum Awaiting requested review from cwognum cwognum is a code owner

Assignees

@roselynh100 roselynh100

Labels
feature Annotates any PR that adds new features; Used in the release process
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@roselynh100 @jstlaurent @mercuryseries