-
Notifications
You must be signed in to change notification settings - Fork 456
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
New documentation for 🤗 Hub #71
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks neat so far – any other subject we should document here? maybe a page about git/git-lfs and how it applies to all repo types (models, datasets, possible upcoming ones...)?
Should we also provide a bullet point list of the libraries documentation (transformers, datasets, tokenizers, accelerate) in one of the pages (open-source?)
Finally that would also be a good place to add a doc page aboutAutoNLP for end users?
Co-authored-by: Julien Chaumond <julien@huggingface.co>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The table looks amazing and the docs are super nice!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool, great job on the documentation! I think a lot of things are clearer, and the added table is a big plus.
I think there are still some aspects that are not necessarily linked to your PR that can be improved:
- Some of the doc is still transformers-specific, for example in the inference-api page, while it doesn't need to be
- It isn't super clear how one would add support for a library. Especially now that everything's merged into this repo, let's think of a way to centralize all information and make it super easy
Co-authored-by: Lysandre Debut <lysandre@huggingface.co>
I improved this a bit to make it more generic and explain how it works for other libraries
The libraries page has a section that links to this repo.
I don't think we should document how to add a new library in the Hub documentation. Instead, I think we need to work on improving the documentation within this repo and provide tools/clear guides on adding new libraries/pipelines. I think that should be a separate effort from this PR. |
- Add AllenNLP - Remove reference to widget page - Add reference to add a library guide
Co-authored-by: lewtun <lewis.c.tunstall@gmail.com>
Co-authored-by: lewtun <lewis.c.tunstall@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! I left a few nits, but otherwise it's awesome 🎉
docs/main.md
Outdated
|
||
## What's the origin of 🤗 name? | ||
|
||
🤗 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
haha, brilliant :)
Co-authored-by: lewtun <lewis.c.tunstall@gmail.com>
Co-authored-by: lewtun <lewis.c.tunstall@gmail.com>
Co-authored-by: lewtun <lewis.c.tunstall@gmail.com>
follow up tweaks in #109 |
This is a new proposal for documentation. It won't be submitted until the course release so we keep similar design with it.
FYI @lewtun in case you want to add ideas :)