Skip to content

Commit 417b805

Browse files
authored
README: add list of advantages + screenshots (#4)
* README: add list of advantages * more improvements * Update README.md * screenshots of integration on the website
1 parent adb1284 commit 417b805

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,14 @@
1515
> **Do you have an open source ML library?**
1616
> We're looking to partner with a small number of other cool open source ML libraries to provide model hosting + versioning.
1717
> https://twitter.com/julien_c/status/1336374565157679104 https://twitter.com/mnlpariente/status/1336277058062852096
18-
> Let us know if interested 😎
18+
>
19+
> Advantages are:
20+
> - versioning is built-in (as hosting is built around git and git-lfs), no lock-in, you can just `git clone` away.
21+
> - anyone can upload a new model for your library, just need to add the corresponding tag for the model to be discoverable – no more need for a hardcoded list in your code
22+
> - Fast downloads! We use Cloudfront (a CDN) to geo-replicate downloads so they're blazing fast from anywhere on the globe
23+
> - Usage stats and more features to come
24+
>
25+
> Ping us if interested 😎
1926
2027
<br>
2128

@@ -24,6 +31,7 @@
2431
- http://github.com/asteroid-team/asteroid [[initial PR 👀](https://github.com/asteroid-team/asteroid/pull/377)]
2532
- https://github.com/pyannote/pyannote-audio [[initial PR 👀](https://github.com/pyannote/pyannote-audio/pull/549)]
2633
- https://github.com/flairNLP/flair [[work-in-progress, initial PR 👀](https://github.com/flairNLP/flair/pull/1974)]
34+
- ESPNet [coming soon]
2735

2836
<br>
2937

@@ -69,10 +77,16 @@ Uploading a model to the hub is super simple too:
6977

7078
> 👀 To see an example of how we document the model sharing process in `transformers`, check out https://huggingface.co/transformers/model_sharing.html
7179
80+
Users add tags into their README.md model cards (e.g. your `library_name`, a domain tag like `audio`, etc.) to make sure their models are discoverable.
81+
82+
**Documentation about the model hub itself is at https://huggingface.co/docs**
83+
7284
### API utilities in `hf_api.py`
7385

7486
You don't need them for the standard publishing workflow, however, if you need a programmatic way of creating a repo, deleting it (`⚠️ caution`), or listing models from the hub, you'll find helpers in `hf_api.py`.
7587

88+
We also have an API to query models by specific tags (e.g. if you want to list models compatible to your library)
89+
7690
### `huggingface-cli`
7791

7892
Those API utilities are also exposed through a CLI:
@@ -98,4 +112,24 @@ This should be executed once for each model repo that contains a model file >5GB
98112

99113
Finally, there's a `huggingface-cli lfs-multipart-upload` command but that one is internal (called by lfs directly) and is not meant to be called by the user.
100114

115+
<br>
116+
117+
## Visual integration into the huggingface.co hub
118+
119+
Finally, we'll implement a few tweaks to improve the UX for your models on the website – let's use [Asteroid](https://github.com/asteroid-team/asteroid) as an example:
120+
121+
![asteroid-model](https://cdn-media.huggingface.co/huggingface_hub/asteroid-model.png)
122+
123+
Model authors add an `asteroid` tag to their model card and they get the advantages of model versioning built-in
124+
125+
![use-in-asteroid](https://cdn-media.huggingface.co/huggingface_hub/use-in-asteroid.png)
126+
127+
We add a custom "Use in Asteroid" button.
128+
129+
![asteroid-code-sample](https://cdn-media.huggingface.co/huggingface_hub/asteroid-code-sample.png)
130+
131+
When clicked you get a library-specific code sample that you'll be able to specify. 🔥
132+
133+
<br>
134+
101135
## Feedback (feature requests, bugs, etc.) is super welcome 💙💚💛💜♥️🧡

0 commit comments

Comments
 (0)