From 7b607c62a78d25b8eac688a403970134c2419441 Mon Sep 17 00:00:00 2001 From: Nima Boscarino Date: Fri, 1 Apr 2022 17:54:15 -0700 Subject: [PATCH 1/6] Create Hugging Face Hub main doc page WIP: More content and structure needed Original main page not removed --- docs/hub/_sections.yml | 3 +++ docs/hub/hugging-face-hub.md | 51 ++++++++++++++++++++++++++++++++++++ 2 files changed, 54 insertions(+) create mode 100644 docs/hub/hugging-face-hub.md diff --git a/docs/hub/_sections.yml b/docs/hub/_sections.yml index 91cbb6b75..49445d6b1 100644 --- a/docs/hub/_sections.yml +++ b/docs/hub/_sections.yml @@ -1,3 +1,6 @@ +- local: hugging-face-hub + title: Hugging Face Hub + - local: main title: Hub documentation diff --git a/docs/hub/hugging-face-hub.md b/docs/hub/hugging-face-hub.md new file mode 100644 index 000000000..d1e17f27e --- /dev/null +++ b/docs/hub/hugging-face-hub.md @@ -0,0 +1,51 @@ +--- +title: Hugging Face Hub +--- + +

Hugging Face Hub documentation

+ +## What's the Hugging Face Hub? + +We are helping the community work together towards the goal of advancing Artificial Intelligence 🔥. + +Not one company, even the Tech Titans, will be able to “solve AI” by themselves – the only way we'll achieve this is by sharing knowledge and resources. On the Hugging Face Hub we are building the largest collection of models, datasets and metrics in order to democratize and advance AI for everyone 🚀. The Hugging Face Hub works as a central place where anyone can share and explore models and datasets. + +## What can you find on the Hub? + +The Hugging Face Hub hosts Git-based repositories which are storage spaces that can contain all your files 💾. + +On it, you'll be able to upload and discover... + +* Models +* Datasets +* Spaces, *which are ML demo apps* + +Unlike other hosting solutions, the Hub offers **versioning, commit history, diffs, branches, over a dozen library integrations**! You can learn more about the features that all repositories share over in the **Repositories documentation**. + +## Models +Models on the Hugging Face Hub allow for simple discovery and usage to maximize model impact. Model repos provide useful [metadata](/docs/hub/model-repos#model-card-metadata) about info such as their tasks, languages, and metrics, with training metrics charts even included if the repository contains [TensorBoard traces](https://huggingface.co/models?filter=tensorboard). It's also easy to add an **inference widget** to your model, allowing anyone to play with the model directly in the browser! For production settings, an API is provided to **instantly serve your model**. + +To upload models to the Hub, or download models and integrate them into your work, explore the **Models documentation**, or choose from [over a dozen frameworks](/docs/hub/libraries) such as 🤗 Transformers, Asteroid and ESPnet supporting the Hugging Face Hub. + +## Datasets +The Hugging Face Hub is home to over 11,000 datasets in 100 languages that can be used for a broad range of tasks across NLP and Computer Vision. + +[TODO: Fill this out] + +## Spaces +[Spaces are a simple way to host ML demo apps on the Hub](https://huggingface.co/spaces). They allow you to create your ML portfolio, showcase your projects at conferences or to stakeholders, and work collaboratively with other people in the ML ecosystem. + +We support two awesome SDKs that let you build cool apps in Python in a matter of minutes: **[Streamlit](https://streamlit.io/)** and **[Gradio](https://gradio.app/)**. + +After you've explored a few Spaces [TODO: CHOOSE SOME SPACES TO LINK], dive into the **Spaces documentation** to learn all about how you can create your own Space. + + +## Organizations +[TODO: Fill this out] + +## Security +The Hugging Face Hub supports security and access control features, to give you the peace of mind that your code, models, and data are safe. Visit the **Security** section in these docs to learn about: +* User Access Tokens +* Access Control for Organizations +* Signing commits with GPG +* Malware scanning \ No newline at end of file From bd62cae15303f1f9dd08be082eef74468d208ea5 Mon Sep 17 00:00:00 2001 From: Nima Boscarino Date: Mon, 4 Apr 2022 11:55:44 -0700 Subject: [PATCH 2/6] Add content for datasets and organizations --- docs/hub/hugging-face-hub.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/hub/hugging-face-hub.md b/docs/hub/hugging-face-hub.md index d1e17f27e..dc5aee979 100644 --- a/docs/hub/hugging-face-hub.md +++ b/docs/hub/hugging-face-hub.md @@ -25,23 +25,25 @@ Unlike other hosting solutions, the Hub offers **versioning, commit history, dif ## Models Models on the Hugging Face Hub allow for simple discovery and usage to maximize model impact. Model repos provide useful [metadata](/docs/hub/model-repos#model-card-metadata) about info such as their tasks, languages, and metrics, with training metrics charts even included if the repository contains [TensorBoard traces](https://huggingface.co/models?filter=tensorboard). It's also easy to add an **inference widget** to your model, allowing anyone to play with the model directly in the browser! For production settings, an API is provided to **instantly serve your model**. -To upload models to the Hub, or download models and integrate them into your work, explore the **Models documentation**, or choose from [over a dozen frameworks](/docs/hub/libraries) such as 🤗 Transformers, Asteroid and ESPnet supporting the Hugging Face Hub. +To upload models to the Hub, or download models and integrate them into your work, explore the **Models documentation**, or choose from [**over a dozen frameworks**](/docs/hub/libraries) such as 🤗 Transformers, Asteroid and ESPnet supporting the Hugging Face Hub. ## Datasets -The Hugging Face Hub is home to over 11,000 datasets in 100 languages that can be used for a broad range of tasks across NLP and Computer Vision. +The Hugging Face Hub is home to over 11,000 datasets in more than 100 languages that can be used for a broad range of tasks across NLP and Computer Vision. The Hub makes it simple to find, download, and upload datasets. Datasets are accompanied by extensive documentation in the form of **Dataset Cards**, and an accompanying **Dataset Preview** to let you explore the data directly in your browser. While many datasets are public, **organizations** and individuals have the ability to create private datasets to comply with licensing or privacy issues. You can learn more about **Datasets here on Hugging Face Hub documentation.** -[TODO: Fill this out] +The [**datasets Python library**](https://huggingface.co/docs/datasets/index) allows you to programmatically interact with the datasets, so you can easily use datasets from the Hub in your projects. ## Spaces [Spaces are a simple way to host ML demo apps on the Hub](https://huggingface.co/spaces). They allow you to create your ML portfolio, showcase your projects at conferences or to stakeholders, and work collaboratively with other people in the ML ecosystem. We support two awesome SDKs that let you build cool apps in Python in a matter of minutes: **[Streamlit](https://streamlit.io/)** and **[Gradio](https://gradio.app/)**. -After you've explored a few Spaces [TODO: CHOOSE SOME SPACES TO LINK], dive into the **Spaces documentation** to learn all about how you can create your own Space. +After you've explored a few Spaces (take a look at our [Space of the Week!](https://huggingface.co/spaces)), dive into the **Spaces documentation** to learn all about how you can create your own Space. ## Organizations -[TODO: Fill this out] +Companies, universities and non-profits are an essential part of the Hugging Face community! The Hugging Face Hub offers **Organizations**, which can be used to group accounts and manage datasets, models, and spaces. An organization's repositories will be featured on the organization’s page and every member of the organization will have the ability to contribute to the repository. In addition to conveniently grouping all of an organization's work, the Hub allows admins to set roles to **control access to repositories**, and [manage their organization's subscription](https://huggingface.co/pricing). + +[Explore existing organizations](https://huggingface.co/organizations), create a new organization [here](https://huggingface.co/organizations/new), and then visit the **Organizations documentation** to learn more. ## Security The Hugging Face Hub supports security and access control features, to give you the peace of mind that your code, models, and data are safe. Visit the **Security** section in these docs to learn about: From 73ce513b6824fd3fc9a9fba344b8f96b67959d98 Mon Sep 17 00:00:00 2001 From: Nima Boscarino Date: Mon, 4 Apr 2022 17:46:33 -0700 Subject: [PATCH 3/6] Apply copy fixes from Steven's code review Mostly grammar and and phrasing adjustments. Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> --- docs/hub/hugging-face-hub.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/hub/hugging-face-hub.md b/docs/hub/hugging-face-hub.md index dc5aee979..2cd146719 100644 --- a/docs/hub/hugging-face-hub.md +++ b/docs/hub/hugging-face-hub.md @@ -8,11 +8,11 @@ title: Hugging Face Hub We are helping the community work together towards the goal of advancing Artificial Intelligence 🔥. -Not one company, even the Tech Titans, will be able to “solve AI” by themselves – the only way we'll achieve this is by sharing knowledge and resources. On the Hugging Face Hub we are building the largest collection of models, datasets and metrics in order to democratize and advance AI for everyone 🚀. The Hugging Face Hub works as a central place where anyone can share and explore models and datasets. +Not one company, even the Tech Titans, will be able to “solve AI” by themselves – the only way we'll achieve this is by sharing knowledge and resources. We are building the largest open-source collection of models, datasets, and metrics on the Hugging Face Hub to democratize and advance AI for everyone 🚀. The Hugging Face Hub works as a central place where anyone can share and explore models and datasets. ## What can you find on the Hub? -The Hugging Face Hub hosts Git-based repositories which are storage spaces that can contain all your files 💾. +The Hugging Face Hub hosts Git-based repositories, which are storage spaces that can contain all your files. 💾. On it, you'll be able to upload and discover... @@ -20,20 +20,20 @@ On it, you'll be able to upload and discover... * Datasets * Spaces, *which are ML demo apps* -Unlike other hosting solutions, the Hub offers **versioning, commit history, diffs, branches, over a dozen library integrations**! You can learn more about the features that all repositories share over in the **Repositories documentation**. +Unlike other hosting solutions, the Hub offers **versioning, commit history, diffs, branches, and over a dozen library integrations**! You can learn more about the features that all repositories share in the **Repositories documentation**. ## Models Models on the Hugging Face Hub allow for simple discovery and usage to maximize model impact. Model repos provide useful [metadata](/docs/hub/model-repos#model-card-metadata) about info such as their tasks, languages, and metrics, with training metrics charts even included if the repository contains [TensorBoard traces](https://huggingface.co/models?filter=tensorboard). It's also easy to add an **inference widget** to your model, allowing anyone to play with the model directly in the browser! For production settings, an API is provided to **instantly serve your model**. -To upload models to the Hub, or download models and integrate them into your work, explore the **Models documentation**, or choose from [**over a dozen frameworks**](/docs/hub/libraries) such as 🤗 Transformers, Asteroid and ESPnet supporting the Hugging Face Hub. +To upload models to the Hub, or download models and integrate them into your work, explore the **Models documentation**. You can also choose from [**over a dozen frameworks**](/docs/hub/libraries) such as 🤗 Transformers, Asteroid, and ESPnet that support the Hugging Face Hub. ## Datasets -The Hugging Face Hub is home to over 11,000 datasets in more than 100 languages that can be used for a broad range of tasks across NLP and Computer Vision. The Hub makes it simple to find, download, and upload datasets. Datasets are accompanied by extensive documentation in the form of **Dataset Cards**, and an accompanying **Dataset Preview** to let you explore the data directly in your browser. While many datasets are public, **organizations** and individuals have the ability to create private datasets to comply with licensing or privacy issues. You can learn more about **Datasets here on Hugging Face Hub documentation.** +The Hugging Face Hub is home to over 11,000 datasets in more than 100 languages that can be used for a broad range of tasks across NLP, Computer Vision, and Audio. The Hub makes it simple to find, download, and upload datasets. Datasets are accompanied by extensive documentation in the form of **Dataset Cards** and **Dataset Preview** to let you explore the data directly in your browser. While many datasets are public, **organizations** and individuals can create private datasets to comply with licensing or privacy issues. You can learn more about **Datasets here on Hugging Face Hub documentation**. -The [**datasets Python library**](https://huggingface.co/docs/datasets/index) allows you to programmatically interact with the datasets, so you can easily use datasets from the Hub in your projects. +The [Datasets](https://huggingface.co/docs/datasets/index) library allows you to programmatically interact with the datasets, so you can easily use datasets from the Hub in your projects. ## Spaces -[Spaces are a simple way to host ML demo apps on the Hub](https://huggingface.co/spaces). They allow you to create your ML portfolio, showcase your projects at conferences or to stakeholders, and work collaboratively with other people in the ML ecosystem. +[Spaces](https://huggingface.co/spaces) is a simple way to host ML demo apps on the Hub. They allow you to create your ML portfolio, showcase your projects at conferences or to stakeholders, and work collaboratively with other people in the ML ecosystem. We support two awesome SDKs that let you build cool apps in Python in a matter of minutes: **[Streamlit](https://streamlit.io/)** and **[Gradio](https://gradio.app/)**. @@ -41,12 +41,12 @@ After you've explored a few Spaces (take a look at our [Space of the Week!](http ## Organizations -Companies, universities and non-profits are an essential part of the Hugging Face community! The Hugging Face Hub offers **Organizations**, which can be used to group accounts and manage datasets, models, and spaces. An organization's repositories will be featured on the organization’s page and every member of the organization will have the ability to contribute to the repository. In addition to conveniently grouping all of an organization's work, the Hub allows admins to set roles to **control access to repositories**, and [manage their organization's subscription](https://huggingface.co/pricing). +Companies, universities and non-profits are an essential part of the Hugging Face community! The Hugging Face Hub offers **Organizations**, which can be used to group accounts and manage datasets, models, and Spaces. An organization's repositories will be featured on the organization’s page and every member of the organization will have the ability to contribute to the repository. In addition to conveniently grouping all of an organization's work, the Hub allows admins to set roles to **control access to repositories**, and manage their organization's [subscription](https://huggingface.co/pricing). [Explore existing organizations](https://huggingface.co/organizations), create a new organization [here](https://huggingface.co/organizations/new), and then visit the **Organizations documentation** to learn more. ## Security -The Hugging Face Hub supports security and access control features, to give you the peace of mind that your code, models, and data are safe. Visit the **Security** section in these docs to learn about: +The Hugging Face Hub supports security and access control features to give you the peace of mind that your code, models, and data are safe. Visit the **Security** section in these docs to learn about: * User Access Tokens * Access Control for Organizations * Signing commits with GPG From 0d4550ee18e9199bceee58cd25f1a8ccfe30d06f Mon Sep 17 00:00:00 2001 From: Nima Boscarino Date: Mon, 4 Apr 2022 18:01:25 -0700 Subject: [PATCH 4/6] Add description to model/datasets/spaces list items --- docs/hub/hugging-face-hub.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/hub/hugging-face-hub.md b/docs/hub/hugging-face-hub.md index 2cd146719..171c3c632 100644 --- a/docs/hub/hugging-face-hub.md +++ b/docs/hub/hugging-face-hub.md @@ -12,13 +12,13 @@ Not one company, even the Tech Titans, will be able to “solve AI” by themsel ## What can you find on the Hub? -The Hugging Face Hub hosts Git-based repositories, which are storage spaces that can contain all your files. 💾. +The Hugging Face Hub hosts Git-based repositories, which are storage spaces that can contain all your files. 💾 On it, you'll be able to upload and discover... -* Models -* Datasets -* Spaces, *which are ML demo apps* +* Models, *hosting the latest state-of-the-art models for NLP, vision, and audio tasks* +* Datasets, *featuring a wide variety of data for different domains and modalities* +* Spaces, *interactive apps for demonstrating ML models directly in your browser* Unlike other hosting solutions, the Hub offers **versioning, commit history, diffs, branches, and over a dozen library integrations**! You can learn more about the features that all repositories share in the **Repositories documentation**. From 69646cd78ab96bf2b6068c3ea0ddd6be5e1007b9 Mon Sep 17 00:00:00 2001 From: Nima Boscarino Date: Mon, 4 Apr 2022 18:01:54 -0700 Subject: [PATCH 5/6] Explicitly include Model Cards in theModels section --- docs/hub/hugging-face-hub.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/hub/hugging-face-hub.md b/docs/hub/hugging-face-hub.md index 171c3c632..68dc75ebe 100644 --- a/docs/hub/hugging-face-hub.md +++ b/docs/hub/hugging-face-hub.md @@ -23,7 +23,7 @@ On it, you'll be able to upload and discover... Unlike other hosting solutions, the Hub offers **versioning, commit history, diffs, branches, and over a dozen library integrations**! You can learn more about the features that all repositories share in the **Repositories documentation**. ## Models -Models on the Hugging Face Hub allow for simple discovery and usage to maximize model impact. Model repos provide useful [metadata](/docs/hub/model-repos#model-card-metadata) about info such as their tasks, languages, and metrics, with training metrics charts even included if the repository contains [TensorBoard traces](https://huggingface.co/models?filter=tensorboard). It's also easy to add an **inference widget** to your model, allowing anyone to play with the model directly in the browser! For production settings, an API is provided to **instantly serve your model**. +Models on the Hugging Face Hub allow for simple discovery and usage to maximize model impact. To promote responsible model usage and development, Model repos are equipped with [Model Cards](https://arxiv.org/abs/1810.03993) to inform users of each model's limitations and biases. Additional [metadata](/docs/hub/model-repos#model-card-metadata) about info such as their tasks, languages, and metrics can be included, with training metrics charts even added if the repository contains [TensorBoard traces](https://huggingface.co/models?filter=tensorboard). It's also easy to add an **inference widget** to your model, allowing anyone to play with the model directly in the browser! For production settings, an API is provided to **instantly serve your model**. To upload models to the Hub, or download models and integrate them into your work, explore the **Models documentation**. You can also choose from [**over a dozen frameworks**](/docs/hub/libraries) such as 🤗 Transformers, Asteroid, and ESPnet that support the Hugging Face Hub. From 20c26595c52414dcd67e0c145f71318833295215 Mon Sep 17 00:00:00 2001 From: Nima Boscarino Date: Tue, 5 Apr 2022 17:48:24 -0700 Subject: [PATCH 6/6] Apply PR review suggestions Fix incorrect info and rephrase for clarity. --- docs/hub/hugging-face-hub.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/hub/hugging-face-hub.md b/docs/hub/hugging-face-hub.md index 68dc75ebe..8629c6bce 100644 --- a/docs/hub/hugging-face-hub.md +++ b/docs/hub/hugging-face-hub.md @@ -6,13 +6,14 @@ title: Hugging Face Hub ## What's the Hugging Face Hub? -We are helping the community work together towards the goal of advancing Artificial Intelligence 🔥. +We are helping the community work together towards the goal of advancing Machine Learning 🔥. -Not one company, even the Tech Titans, will be able to “solve AI” by themselves – the only way we'll achieve this is by sharing knowledge and resources. We are building the largest open-source collection of models, datasets, and metrics on the Hugging Face Hub to democratize and advance AI for everyone 🚀. The Hugging Face Hub works as a central place where anyone can share and explore models and datasets. +The Hugging Face Hub is a platform with over 30K models, 3K datasets, and 2K demos in which people can easily collaborate in their ML workflows. The Hub works as a central place where anyone can share, explore, discover, and experiment with open-source Machine Learning. +No single company, including the Tech Titans, will be able to “solve AI” by themselves – the only way we'll achieve this is by sharing knowledge and resources in a community-centric approach. We are building the largest open-source collection of models, datasets, demos and metrics on the Hugging Face Hub to democratize and advance AI for everyone 🚀. ## What can you find on the Hub? -The Hugging Face Hub hosts Git-based repositories, which are storage spaces that can contain all your files. 💾 +The Hugging Face Hub hosts Git-based repositories, which are version-controlled spaces that can contain all your files. 💾 On it, you'll be able to upload and discover... @@ -23,19 +24,19 @@ On it, you'll be able to upload and discover... Unlike other hosting solutions, the Hub offers **versioning, commit history, diffs, branches, and over a dozen library integrations**! You can learn more about the features that all repositories share in the **Repositories documentation**. ## Models -Models on the Hugging Face Hub allow for simple discovery and usage to maximize model impact. To promote responsible model usage and development, Model repos are equipped with [Model Cards](https://arxiv.org/abs/1810.03993) to inform users of each model's limitations and biases. Additional [metadata](/docs/hub/model-repos#model-card-metadata) about info such as their tasks, languages, and metrics can be included, with training metrics charts even added if the repository contains [TensorBoard traces](https://huggingface.co/models?filter=tensorboard). It's also easy to add an **inference widget** to your model, allowing anyone to play with the model directly in the browser! For production settings, an API is provided to **instantly serve your model**. +Models on the Hugging Face Hub allow for simple discovery and usage to maximize model impact. To promote responsible model usage and development, model repos are equipped with [Model Cards](TODO) to inform users of each model's limitations and biases. Additional [metadata](/docs/hub/model-repos#model-card-metadata) about info such as their tasks, languages, and metrics can be included, with training metrics charts even added if the repository contains [TensorBoard traces](https://huggingface.co/models?filter=tensorboard). It's also easy to add an **inference widget** to your model, allowing anyone to play with the model directly in the browser! For production settings, an API is provided to **instantly serve your model**. To upload models to the Hub, or download models and integrate them into your work, explore the **Models documentation**. You can also choose from [**over a dozen frameworks**](/docs/hub/libraries) such as 🤗 Transformers, Asteroid, and ESPnet that support the Hugging Face Hub. ## Datasets -The Hugging Face Hub is home to over 11,000 datasets in more than 100 languages that can be used for a broad range of tasks across NLP, Computer Vision, and Audio. The Hub makes it simple to find, download, and upload datasets. Datasets are accompanied by extensive documentation in the form of **Dataset Cards** and **Dataset Preview** to let you explore the data directly in your browser. While many datasets are public, **organizations** and individuals can create private datasets to comply with licensing or privacy issues. You can learn more about **Datasets here on Hugging Face Hub documentation**. +The Hugging Face Hub is home to over 3,000 datasets in more than 100 languages that can be used for a broad range of tasks across NLP, Computer Vision, and Audio. The Hub makes it simple to find, download, and upload datasets. Datasets are accompanied by extensive documentation in the form of **Dataset Cards** and **Dataset Preview** to let you explore the data directly in your browser. While many datasets are public, **organizations** and individuals can create private datasets to comply with licensing or privacy issues. You can learn more about **Datasets here on Hugging Face Hub documentation**. -The [Datasets](https://huggingface.co/docs/datasets/index) library allows you to programmatically interact with the datasets, so you can easily use datasets from the Hub in your projects. +[🤗 `datasets`](https://huggingface.co/docs/datasets/index) allows you to programmatically interact with the datasets, so you can easily use datasets from the Hub in your projects. ## Spaces [Spaces](https://huggingface.co/spaces) is a simple way to host ML demo apps on the Hub. They allow you to create your ML portfolio, showcase your projects at conferences or to stakeholders, and work collaboratively with other people in the ML ecosystem. -We support two awesome SDKs that let you build cool apps in Python in a matter of minutes: **[Streamlit](https://streamlit.io/)** and **[Gradio](https://gradio.app/)**. +We currently support two awesome SDKs (**[Gradio](https://gradio.app/)** and **[Streamlit](https://streamlit.io/)**) that let you build cool apps in Python in a matter of minutes, with more ways to build coming soon. After you've explored a few Spaces (take a look at our [Space of the Week!](https://huggingface.co/spaces)), dive into the **Spaces documentation** to learn all about how you can create your own Space.