Document Collection API #973
Conversation
|
The documentation is not available anymore as the PR was closed or merged. |
| This is equivalent to `huggingface_hub.whoami()`. |
There was a problem hiding this comment.
It may be nice to add a link to it :)
| This is equivalent to `huggingface_hub.whoami()`. | |
| This is equivalent to [`huggingface_hub.whoami`]. |
There was a problem hiding this comment.
It would be better but auto-generated links won't work here as it's not in the same docs (hub-docs vs huggingface_hub docs). So for now I suggest we keep it like this.
(same below)
| ``` | ||
|
|
||
| This is equivalent to `huggingface_hub.update_collection_metadata()`. |
There was a problem hiding this comment.
| This is equivalent to `huggingface_hub.update_collection_metadata()`. | |
| This is equivalent to [`huggingface_hub.update_collection_metadata`]. |
| Return a collection. This is a non-revertible operation. A deleted collection cannot be restored. | ||
|
|
||
| This is equivalent to `huggingface_hub.delete_collection()`. |
There was a problem hiding this comment.
| This is equivalent to `huggingface_hub.delete_collection()`. | |
| This is equivalent to [`huggingface_hub.delete_collection`]. |
| ``` | ||
|
|
||
| This is equivalent to `huggingface_hub.add_collection_item()`. |
There was a problem hiding this comment.
| This is equivalent to `huggingface_hub.add_collection_item()`. | |
| This is equivalent to [`huggingface_hub.add_collection_item`]. |
| ``` | ||
|
|
||
| This is equivalent to `huggingface_hub.update_collection_item()`. |
There was a problem hiding this comment.
| This is equivalent to `huggingface_hub.update_collection_item()`. | |
| This is equivalent to [`huggingface_hub.update_collection_item`]. |
| Remove an item from a collection. You must know the item object id which is different from the repo_id/paper_id provided when adding the item to the collection. The `item_id` can be retrieved by fetching the collection. | ||
|
|
||
| This is equivalent to `huggingface_hub.delete_collection_item()`. |
There was a problem hiding this comment.
| This is equivalent to `huggingface_hub.delete_collection_item()`. | |
| This is equivalent to [`huggingface_hub.delete_collection_item`]. |
docs/hub/api.md
Outdated
| This is equivalent to `huggingface_hub.delete_collection()`. | ||
|
|
||
| ### POST /api/collections/{namespace}/{slug}-{id}/items |
There was a problem hiding this comment.
those endpoints don't accept just {id}, they also require the slug?
There was a problem hiding this comment.
Not at the moment no.
You can do:
- https://huggingface.co/api/collections/TheBloke/recent-models-64f9a55bb3115b4f513ec026
- https://huggingface.co/api/collections/TheBloke/abcdef-64f9a55bb3115b4f513ec026
But not:
There was a problem hiding this comment.
maybe we can implem that server side (in a future PR) if it improves DX significantly (maybe not worth it?)
There was a problem hiding this comment.
Not sure it'll help much. In any case the user will have to copy paste something right? (and copy-pasting username/slug-id from a URL is easier than copy-pasting username and id separately). And if not copy-pasting then it'll be programmatically done and in that case the server returns the full version (username/slug-id).
(but yeah, wouldn't cost must to support it)
There was a problem hiding this comment.
good point about the copy-pasting
| ### POST /api/collections | ||
|
|
||
| Create a new collection on the Hub with a title, a description (optional) and a first item (optional). An item is defined by a type (`model`, `dataset`, `space` or `paper`) and an id (repo_id or paper_id on the Hub). |
There was a problem hiding this comment.
it's weird to me that you can create a collection with a first item (but not several items, i assume?) vs. creating a collection then adding an item from a differnt call.
(this comment is about the API design, not really about the documentation)
There was a problem hiding this comment.
Yes I agree. I assume this mostly comes from the fact that on the Hub we can create a collection from a model page (which means creating it with a single item).
FYI, what I did in huggingface_hub is to not support creating a collection with an item directly. Users have to create collection and then add items to it.
There was a problem hiding this comment.
ah ok, perfect if you did that in hfh then
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> Co-authored-by: Julien Chaumond <julien@huggingface.co>
Follow-up after the revamp of the endpoints documentation (#962).
This PR:
hub-docs/api.md) #962 (comment)). Should make it clearer in the TOC.Updated page: https://moon-ci-docs.huggingface.co/docs/hub/pr_973/en/api.
EDIT: generated docs seems broken to me 😕 Same for you? Will investigate that.