Documentation Revamp

.github/workflows/build_documentation.yml

@@ -0,0 +1,20 @@
+name: Build documentation
+
+on:
+  push:
+    paths:
+      - "docs/hub/**"
+    branches:
+      - main
+
+jobs:
+   build:
+    uses: huggingface/doc-builder/.github/workflows/build_main_documentation.yml@main
+    with:
+      commit_sha: ${{ github.sha }}
+      package: hub-docs
+      package_name: hub
+      path_to_docs: hub-docs/docs/hub/
+      additional_args: --not_python_module
+    secrets:
+      token: ${{ secrets.HUGGINGFACE_PUSH }}

.github/workflows/build_pr_documentation.yml

@@ -0,0 +1,19 @@
+name: Build PR Documentation
+
+on:
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    uses: huggingface/doc-builder/.github/workflows/build_pr_documentation.yml@main
+    with:
+      commit_sha: ${{ github.event.pull_request.head.sha }}
+      pr_number: ${{ github.event.number }}
+      package: hub-docs
+      package_name: hub
+      path_to_docs: hub-docs/docs/hub/
+      additional_args: --not_python_module

.github/workflows/delete_doc_comment.yml

@@ -0,0 +1,13 @@
+name: Delete dev documentation
+
+on:
+  pull_request:
+    types: [ closed ]
+
+
+jobs:
+  delete:
+    uses: huggingface/doc-builder/.github/workflows/delete_doc_comment.yml@main
+    with:
+      pr_number: ${{ github.event.number }}
+      package: hub-docs

.gitignore

@@ -1,4 +1,5 @@
 node_modules/
 .vscode/
+.idea/
 
 .DS_Store

docs/hub/_toctree.yml

@@ -0,0 +1,138 @@
+- local: index
+  title: 🤗 Hugging Face Hub
+- local: repositories
+  title: Repositories
+  sections:
+  - local: repositories-getting-started
+    title: Getting Started with Repositories
+  - local: repositories-settings
+    title: Repository Settings
+  - local: repositories-pull-requests-discussions
+    title: Pull Requests & Discussions
+  - local: repositories-next-steps
+    title: Next Steps    
+  - local: repositories-licenses
+    title: Licenses    
+- title: Models
+  local: models
+  sections:
+  - local: models-the-hub
+    title: The Model Hub
+  - local: models-cards
+    title: Model Cards
+    sections:
+    - local: models-cards-co2
+      title: Carbon Emissions
+  - local: models-libraries
+    title: Libraries
+    sections:
+      - local: spacy
+        title: SpaCy
+      - local: transformers
+        title: transformers
+      - local: adapter-transformers
+        title: adapter-transformers
+      - local: allennlp
+        title: AllenNLP
+      - local: asteroid
+        title: Asteroid
+      - local: espnet
+        title: ESPnet
+      - local: fastai
+        title: FastAI
+      - local: keras
+        title: Keras
+      - local: sentence-transformers
+        title: Sentence Transformers
+      - local: stanza
+        title: Stanza
+      - local: speechbrain
+        title: SpeechBrain
+      - local: tensorboard
+        title: TensorBoard
+  - local: models-uploading
+    title: Uploading Models
+  - local: models-downloading
+    title: Downloading Models
+  - local: models-widgets
+    title: Model Widgets
+  - local: models-inference
+    title: Inference API docs
+  - local: models-faq
+    title: Frequently Asked Questions
+  - local: models-advanced
+    title: Advanced Topics
+    sections:
+      - local: models-adding-libraries
+        title: Integrate a library with the Hub
+      - local: models-tasks
+        title: Tasks
+- title: Datasets
+  local: datasets
+  sections:
+  - local: datasets-overview
+    title: Datasets Overview
+  - local: datasets-cards
+    title: Dataset Cards
+  - local: datasets-gated
+    title: Gated Datasets
+  - local: datasets-usage
+    title: Using Datasets
+  - local: datasets-adding
+    title: Adding New Datasets
+- local: spaces
+  title: Spaces
+  sections:
+  - local: spaces-overview
+    title: Spaces Overview
+    sections:
+    - local: spaces-dependencies
+      title: Handling Spaces Dependencies
+    - local: spaces-settings
+      title: Spaces Settings
+    - local: spaces-using-opencv
+      title: Using OpenCV in Spaces
+    - local: spaces-organization-cards
+      title: Using Spaces for Organization Cards
+    - local: spaces-more-ways-to-create
+      title: More ways to create Spaces
+    - local: spaces-github-actions
+      title: Managing Spaces with Github Actions      
+  - local: spaces-sdks-gradio
+    title: Gradio Spaces
+  - local: spaces-sdks-streamlit
+    title: Streamlit Spaces
+  - local: spaces-sdks-static
+    title: Static HTML Spaces
+  - local: spaces-sdks-python
+    title: Custom Python Spaces
+  - local: spaces-config-reference
+    title: Spaces Configuration Reference
+  - local: spaces-changelog
+    title: Spaces Changelog
+- local: other
+  title: Other
+  sections:    
+  - local: organizations
+    title: Organizations
+    sections:
+    - local: organizations-managing
+      title: Managing Organizations
+    - local: organizations-cards
+      title: Organization Cards
+    - local: organizations-security
+      title: Access control in organizations
+  - local: security
+    title: Security
+    sections:
+    - local: security-tokens
+      title: User Access Tokens
+    - local: security-gpg
+      title: Signing commits with GPG
+    - local: security-malware
+      title: Malware Scanning
+  - local: api
+    title: Hub API Endpoints
+    sections:
+    - local: api-webhook
+      title: Webhook

docs/hub/adapter-transformers.md

@@ -0,0 +1,67 @@
+# Using Adapter Transformers at Hugging Face
+
+`adapter-transformers` is a library that extends 🤗 `transformers` by allowing to integrate, train and use Adapters and other efficient fine-tuning methods. The library is fully compatible with 🤗 `transformers`. Adapters are small learnt layers inserted within each layer of a pre-trained model. You can learn more about this in the [original paper](https://arxiv.org/abs/2007.07779). 
+
+## Exploring adapter-transformers in the Hub
+
+You can find over a hundred `adapter-transformer` models by filtering at the left of the [models page](https://huggingface.co/models?library=adapter-transformers&sort=download). Some adapter models can be found in the Adapter Hub [repository](https://github.com/adapter-hub/hub). Models from both sources are then aggregated in the [AdapterHub](https://adapterhub.ml/explore/).
+
+
+## Using existing models
+
+For a full guide on loading pre-trained adapters, we recommend checking out the [official guide](https://docs.adapterhub.ml/loading.html). 
+
+As a brief summary, once you load a model with the usual `*Model` classes from 🤗`transformers`, you can use the `load_adapter` method to load and activate the Adapter (remember `adapter-transformers` extends 🤗`transformers`.).
+
+```py
+from transformers import AutoModelWithHeads
+
+model = AutoModelWithHeads.from_pretrained("bert-base-uncased")
+adapter_name = model.load_adapter("AdapterHub/bert-base-uncased-pf-imdb", source="hf")
+model.active_adapters = adapter_name
+```
+
+You can also use `list_adapters` to find all Adapter Models programmatically
+
+```py
+from transformers import list_adapters
+
+# source can be "ah" (AdapterHub), "hf" (hf.co) or None (for both, default)
+adapter_infos = list_adapters(source="hf", model_name="bert-base-uncased")
+```
+
+If you want to see how to load a specific model, you can click `Use in Adapter Transformers` and you will be given a working snippet that you can load it! 
+
+<div class="flex justify-center">
+<img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/libraries-adapter_transformers_snippet1.png"/>
+<img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/libraries-adapter_transformers-snippet1-dark.png"/>
+</div>
+
+<div class="flex justify-center">
+<img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/libraries-adapter_transformers_snippet2.png"/>
+<img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/libraries-adapter_transformers-snippet2-dark.png"/>
+</div>
+
+## Sharing your models
+
+For a full guide on sharing models with `adapter-transformers`, we recommend checking out the [official guide](https://docs.adapterhub.ml/huggingface_hub.html#uploading-to-the-hub). 
+
+You can share your Adapter by using the `push_adapter_to_hub` method from a model that already contains an adapter.
+
+```py
+model.push_adapter_to_hub(
+    "my-awesome-adapter",
+    "awesome_adapter",
+    adapterhub_tag="sentiment/imdb",
+    datasets_tag="imdb"
+)
+```
+
+This command creates a repository with an automatically generated model card and all necessary metadata.
+
+
+## Additional resources
+
+* Adapter Transformers [library]((https://github.com/adapter-hub/adapter-transformers).
+* Adapter Transformers [docs](https://docs.adapterhub.ml/index.html).
+* Integration with Hub [docs](https://docs.adapterhub.ml/huggingface_hub.html).