DOC readme expansion #80
Conversation
| At the moment, it includes the following features: | ||
|
|
||
| - ``skops.hub_utils``: tools to create a model repository to be stored on | ||
| `Hugging Face Hub <https://hf.co/models>`__, mainly through |
There was a problem hiding this comment.
mainly through
skops.hub_utils.initandskops.hub_utils.push.
I think this doesn't add much for the reader. I think the added value (apart from storing and sharing) rather comes from the inference widget. WDYT?
| - ``skops.hub_utils``: tools to create a model repository to be stored on | ||
| `Hugging Face Hub <https://hf.co/models>`__, mainly through | ||
| ``skops.hub_utils.init`` and ``skops.hub_utils.push``. | ||
| - ``skops.card``: tools to create a model card explaining what the model does |
There was a problem hiding this comment.
How about adding something along the lines of "automatically populating" the model card? I know not everything is populated automatically, but some stuff is, which saves the user time.
|
Does this look better now? |
|
Yes, I think it's much easier now for users to understand the benefit. Ideally, we can later get someone who doesn't know anything about skops to read it and give their feedback, since all of us are already biased. I can merge now if or wait for @merveenoyan to review. |
|
I think you could merge, not a big change here I think. |
A bit of more README
fixes #77