Skip to content
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

Merged
merged 21 commits into from
Jun 14, 2021
Merged

New documentation for 🤗 Hub #71

merged 21 commits into from
Jun 14, 2021

Conversation

osanseviero
Copy link
Member

@osanseviero osanseviero commented Jun 3, 2021

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 :)
Screen Shot 2021-06-09 at 12 00 28 PM

@osanseviero osanseviero marked this pull request as draft June 3, 2021 21:52
@osanseviero osanseviero changed the title [Draft] New documentation for HF Hub New documentation for 🤗 Hub Jun 4, 2021
@osanseviero osanseviero marked this pull request as ready for review June 4, 2021 08:54
Copy link
Member

@julien-c julien-c left a 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?

docs/inference.md Outdated Show resolved Hide resolved
docs/inference.md Outdated Show resolved Hide resolved
docs/main.md Outdated Show resolved Hide resolved
Co-authored-by: Julien Chaumond <julien@huggingface.co>
Copy link
Member

@lewtun lewtun left a 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!

docs/model-repos.md Show resolved Hide resolved
@osanseviero
Copy link
Member Author

Should we also provide a bullet point list of the libraries documentation (transformers, datasets, tokenizers, accelerate) in one of the pages (open-source?)

I think it's already in main navigation no? I'm not sure if adding it here would help considerably.
Screen Shot 2021-06-04 at 3 20 53 PM

Copy link
Member

@LysandreJik LysandreJik left a 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

docs/main.md Outdated Show resolved Hide resolved
docs/main.md Outdated Show resolved Hide resolved
docs/main.md Outdated Show resolved Hide resolved
docs/main.md Outdated Show resolved Hide resolved
docs/model-repos.md Outdated Show resolved Hide resolved
docs/model-repos.md Outdated Show resolved Hide resolved
docs/model-repos.md Outdated Show resolved Hide resolved
docs/inference.md Show resolved Hide resolved
@osanseviero
Copy link
Member Author

osanseviero commented Jun 7, 2021

  • Some of the doc is still transformers-specific, for example in the inference-api page, while it doesn't need to be

I improved this a bit to make it more generic and explain how it works for other libraries

  • 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

The libraries page has a section that links to this repo.

How can I add a new library to the Inference API?
You can find detailed instructions in huggingface_hub.

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
docs/model-repos.md Outdated Show resolved Hide resolved
docs/model-repos.md Outdated Show resolved Hide resolved
docs/model-repos.md Outdated Show resolved Hide resolved
osanseviero and others added 4 commits June 11, 2021 08:41
Co-authored-by: lewtun <lewis.c.tunstall@gmail.com>
Co-authored-by: lewtun <lewis.c.tunstall@gmail.com>
Copy link
Member

@LysandreJik LysandreJik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great!

Copy link
Member

@lewtun lewtun left a 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/inference.md Show resolved Hide resolved
docs/libraries.md Outdated Show resolved Hide resolved
docs/main.md Outdated Show resolved Hide resolved
docs/main.md Outdated Show resolved Hide resolved
docs/main.md Outdated

## What's the origin of 🤗 name?

🤗
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

haha, brilliant :)

osanseviero and others added 5 commits June 14, 2021 10:29
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>
@osanseviero osanseviero merged commit 6c1c071 into main Jun 14, 2021
@osanseviero osanseviero deleted the docs branch June 14, 2021 16:49
@julien-c
Copy link
Member

follow up tweaks in #109

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants