[Feature] Support tag management (create, list, delete) in CLI #2172
Conversation
…huggingface_hub into api-overview-2077
… into cli-tag-2141
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
src/huggingface_hub/commands/tag.py
Outdated
| Usage Examples: | ||
| - Create a tag: | ||
| $ huggingface-cli tag create my-model 1.0 --tag-message "First release" | ||
| $ huggingface-cli tag create my-model 1.0 --tag-message "First release" --revision develop | ||
| $ huggingface-cli tag create my-model 1.0 --tag-message "First release" --type dataset | ||
| - List all tags: | ||
| $ huggingface-cli tag list my-model | ||
| - Delete a tag: | ||
| $ huggingface-cli tag delete my-model 1.0 | ||
| """ |
There was a problem hiding this comment.
Hi @bilgehanertan, thanks for the PR! I haven't thoroughly reviewed it but implementation-wise the structure looks good. Before moving forward, I'd like to suggest some changes in the CLI format. Here is how I'd envision it:
# Tag model
$ huggingface-cli tag username/my-model 1.0
# Tag model with message
$ huggingface-cli tag username/my-model 1.0 -m "First release"
$ huggingface-cli tag username/my-model 1.0 --message "First release"
# Tag model with revision
$ huggingface-cli tag username/my-model 1.0 --revision develop
# Tag dataset
$ huggingface-cli tag username/my-dataset 1.0 --repo-type dataset
# List all model tags
$ huggingface-cli tag -l username/my-model
$ huggingface-cli tag --list username/my-model
# List all dataset tags
$ huggingface-cli tag -l username/my-dataset --repo-type dataset
# Delete model tag
$ huggingface-cli tag -d username/my-model 1.0
$ huggingface-cli tag --delete username/my-model 1.0Main changes are:
- removed
create/delete/listcommands in favor of-l/--listand-d/--deleteto list and delete tags. By default, tag creation is expected. - updated
--typeto--repo-typefor consistency - I think namespace of the repo should always be explicit.
- updated
--tag-messageto--messageor-m
With this format, we would be much closer of the git tag command line that is already well established. What do you think?
There was a problem hiding this comment.
@Wauplin, thanks for the feedback!
I have adjusted it & tested it; it should look better now.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #2172 +/- ##
==========================================
- Coverage 82.93% 82.27% -0.66%
==========================================
Files 103 104 +1
Lines 9703 9823 +120
==========================================
+ Hits 8047 8082 +35
- Misses 1656 1741 +85 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Thanks for the changes @bilgehanertan! API looks good now. Left some comment to simplify a bit + review some messages but overall looks very promising :) Would you mind doing a last iteration on it? Thanks in advance!
@Wauplin all done! |
There was a problem hiding this comment.
Thanks @bilgehanertan! I played with it locally and it's 🔥!! I pushed a few tweaks for consistency with the CLI. PR looks good to me logic-wise now. Before merging, would you mind documenting this new command on this page: https://huggingface.co/docs/huggingface_hub/guides/cli?
You'll need to update this file to document huggingface-cli tag. Section can go between huggingface-cli delete-cache and huggingface-cli env. Usually in the doc guide with put "real examples". If you are looking for repos with tags on the Hub, on can cite the bigcode/the-stack dataset or the Wauplin/gradio-space-ci Space. Thanks in advance!
@Wauplin I have added the necessary guides, hope it looks good! |
There was a problem hiding this comment.
PR's clean and is ready to go I think! Let's wait for the CI to pass and I'll merge. Nice API, nice docs, nice tests, thanks a lot for your contribution and iterations @bilgehanertan! ❤️
Wauplin
changed the title
Resolves #2141
Since I wasn't sure whether to add unit tests about functionalities directly, I have only added parsing tests. Depending on the reviews, I can add tests using the token from constants.
I was also unsure how to handle the token argument
tag.py:120; please verify whether this is the proper way to do so.@Wauplin