DOC user guide on the hub #64
Conversation
|
Ready for review @skops-dev/maintainers |
|
Also wondering what @osanseviero thinks about this. |
Okay, I'll wait before merging then. |
There was a problem hiding this comment.
Looks good! I just left minor suggestions. It would be great if @merveenoyan could take a quick look on Monday as well unless we're in a hurry to merge this
|
Very friendly ping @merveenoyan as I realized last ping was during holidays+before weekend, so I wanted to resurface this. |
docs/hf_hub.rst
Outdated
| - Inference API to get model output through REST calls | ||
| - A widget to try the model directly in the browser | ||
| - Metadata tags for better discoverability of the model | ||
| - Collaborating with others on a model |
There was a problem hiding this comment.
it's a bit vague, maybe add "Collaboration with others on a model through xyz" would be nice
There was a problem hiding this comment.
through what? I'm not sure how to finish the sentence
There was a problem hiding this comment.
Having repositories on Hub in general and pull requests + discussions. feel free to ignore if you don't agree
| metadata in the ``README.md`` file. The metadata in ``README.md`` is used by | ||
| the Hub's backend to understand the type of the model and the kind of task | ||
| which the model tries to solve. An example of a task can be | ||
| ``"tabular-classification"`` or ``"text-regression"``. |
There was a problem hiding this comment.
Until we add the documentation on available tasks, feel free to give reference to https://github.com/huggingface/hub-docs/blob/main/js/src/lib/interfaces/Types.ts if you wish to do so.
There was a problem hiding this comment.
I don't want to refer users to source code, especially python coders to a typescript bit of code. If necessary, rather document what we have here, which seems to be what we need to do.
| - ``task``: The task of the model. | ||
|
|
||
| You almost never need to create or touch this file manually, and it's created | ||
| when you call :func:`skops.hub_utils.init`. |
There was a problem hiding this comment.
Maybe an emphasis on this with bold font would be noice but LGTM 😅 it's one of the main value propositions of skops that's why
A little bit of user guide and improvements to docs.