Migrate doc files to Markdown (#1522)

* Migrate doc files to Markdown * remove inference_client.mdx
huggingface · Jun 21, 2023 · 3832f67 · 3832f67
1 parent c368177
commit 3832f67
Show file tree

Hide file tree

Showing 34 changed files with 135 additions and 3 deletions.
diff --git a/docs/source/concepts/git_vs_http.mdx → docs/source/concepts/git_vs_http.md b/docs/source/concepts/git_vs_http.mdx → docs/source/concepts/git_vs_http.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Git vs HTTP paradigm
 
 The `huggingface_hub` library is a library for interacting with the Hugging Face Hub, which is a 

diff --git a/docs/source/guides/community.mdx → docs/source/guides/community.md b/docs/source/guides/community.mdx → docs/source/guides/community.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Interact with Discussions and Pull Requests 
 
 The `huggingface_hub` library provides a Python interface to interact with Pull Requests and Discussions on the Hub.

diff --git a/docs/source/guides/download.mdx → docs/source/guides/download.md b/docs/source/guides/download.mdx → docs/source/guides/download.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Download files from the Hub
 
 The `huggingface_hub` library provides functions to download files from the repositories

diff --git a/docs/source/guides/hf_file_system.mdx → docs/source/guides/hf_file_system.md b/docs/source/guides/hf_file_system.mdx → docs/source/guides/hf_file_system.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Interact with the Hub through the Filesystem API
 
 In addition to the [`HfApi`], the `huggingface_hub` library provides [`HfFileSystem`], a pythonic [fsspec-compatible](https://filesystem-spec.readthedocs.io/en/latest/) file interface to the Hugging Face Hub. The [`HfFileSystem`] builds of top of the [`HfApi`] and offers typical filesystem style operations like `cp`, `mv`, `ls`, `du`, `glob`, `get_file`, and `put_file`.

diff --git a/docs/source/guides/inference.mdx → docs/source/guides/inference.md b/docs/source/guides/inference.mdx → docs/source/guides/inference.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Run Inference on servers
 
 Inference is the process of using a trained model to make predictions on new data. As this process can be compute-intensive,

diff --git a/docs/source/guides/integrations.mdx → docs/source/guides/integrations.md b/docs/source/guides/integrations.mdx → docs/source/guides/integrations.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Integrate any ML framework with the Hub
 
 The Hugging Face Hub makes hosting and sharing models with the community easy. It supports

diff --git a/docs/source/guides/manage-cache.mdx → docs/source/guides/manage-cache.md b/docs/source/guides/manage-cache.mdx → docs/source/guides/manage-cache.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Manage `huggingface_hub` cache-system
 
 ## Understand caching

diff --git a/docs/source/guides/manage-spaces.mdx → docs/source/guides/manage-spaces.md b/docs/source/guides/manage-spaces.mdx → docs/source/guides/manage-spaces.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Manage your Space
 
 In this guide, we will see how to manage your Space runtime

diff --git a/docs/source/guides/model-cards.mdx → docs/source/guides/model-cards.md b/docs/source/guides/model-cards.mdx → docs/source/guides/model-cards.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Create and share Model Cards
 
 The `huggingface_hub` library provides a Python interface to create, share, and update Model Cards.

diff --git a/docs/source/guides/overview.mdx → docs/source/guides/overview.md b/docs/source/guides/overview.mdx → docs/source/guides/overview.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # How-to guides
 
 In this section, you will find practical guides to help you achieve a specific goal.

diff --git a/docs/source/guides/repository.mdx → docs/source/guides/repository.md b/docs/source/guides/repository.mdx → docs/source/guides/repository.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Create and manage a repository
 
 The Hugging Face Hub is a collection of git repositories. [Git](https://git-scm.com/) is a widely used tool in software

diff --git a/docs/source/guides/search.mdx → docs/source/guides/search.md b/docs/source/guides/search.mdx → docs/source/guides/search.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Search the Hub
 
 In this tutorial, you will learn how to search models, datasets and spaces on the Hub using `huggingface_hub`.

diff --git a/docs/source/guides/upload.mdx → docs/source/guides/upload.md b/docs/source/guides/upload.mdx → docs/source/guides/upload.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Upload files to the Hub
 
 Sharing your files and work is an important aspect of the Hub. The `huggingface_hub` offers several options for uploading your files to the Hub. You can use these functions independently or integrate them into your library, making it more convenient for your users to interact with the Hub. This guide will show you how to push files:

diff --git a/docs/source/guides/webhooks_server.mdx → docs/source/guides/webhooks_server.md b/docs/source/guides/webhooks_server.mdx → docs/source/guides/webhooks_server.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Webhooks Server
 
 Webhooks are a foundation for MLOps-related features. They allow you to listen for new changes on specific repos or to

diff --git a/docs/source/index.mdx → docs/source/index.md b/docs/source/index.mdx → docs/source/index.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # 🤗 Hub client library
 
 The `huggingface_hub` library allows you to interact with the [Hugging Face

diff --git a/docs/source/installation.mdx → docs/source/installation.md b/docs/source/installation.mdx → docs/source/installation.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Installation
 
 Before you start, you will need to setup your environment by installing the appropriate packages.

diff --git a/docs/source/package_reference/cache.mdx → docs/source/package_reference/cache.md b/docs/source/package_reference/cache.mdx → docs/source/package_reference/cache.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Cache-system reference
 
 The caching system was updated in v0.8.0 to become the central cache-system shared

diff --git a/docs/source/package_reference/cards.mdx → docs/source/package_reference/cards.md b/docs/source/package_reference/cards.mdx → docs/source/package_reference/cards.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Repository Cards
 
 The huggingface_hub library provides a Python interface to create, share, and update Model/Dataset Cards. 

diff --git a/docs/source/package_reference/community.mdx → docs/source/package_reference/community.md b/docs/source/package_reference/community.mdx → docs/source/package_reference/community.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Interacting with Discussions and Pull Requests
 
 Check the [`HfApi`] documentation page for the reference of methods enabling

diff --git a/...ckage_reference/environment_variables.mdx → ...ackage_reference/environment_variables.md b/...ckage_reference/environment_variables.mdx → ...ackage_reference/environment_variables.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Environment variables
 
 `huggingface_hub` can be configured using environment variables.

diff --git a/...ource/package_reference/file_download.mdx → ...source/package_reference/file_download.md b/...ource/package_reference/file_download.mdx → ...source/package_reference/file_download.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Downloading files
 
 ## Download a single file

diff --git a/docs/source/package_reference/hf_api.mdx → docs/source/package_reference/hf_api.md b/docs/source/package_reference/hf_api.mdx → docs/source/package_reference/hf_api.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # HfApi Client
 
 Below is the documentation for the `HfApi` class, which serves as a Python wrapper for the Hugging Face Hub's API.

diff --git a/...urce/package_reference/hf_file_system.mdx → ...ource/package_reference/hf_file_system.md b/...urce/package_reference/hf_file_system.mdx → ...ource/package_reference/hf_file_system.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Filesystem API
 
 The `HfFileSystem` class provides a pythonic file interface to the Hugging Face Hub based on [`fssepc`](https://filesystem-spec.readthedocs.io/en/latest/).

diff --git a/...ce/package_reference/inference_client.mdx → ...rce/package_reference/inference_client.md b/...ce/package_reference/inference_client.mdx → ...rce/package_reference/inference_client.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Inference
 
 Inference is the process of using a trained model to make predictions on new data. As this process can be compute-intensive,

diff --git a/docs/source/package_reference/login.mdx → docs/source/package_reference/login.md b/docs/source/package_reference/login.mdx → docs/source/package_reference/login.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Login and logout
 
 The `huggingface_hub` library allows users to programmatically login and logout the

diff --git a/docs/source/package_reference/mixins.mdx → docs/source/package_reference/mixins.md b/docs/source/package_reference/mixins.mdx → docs/source/package_reference/mixins.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Mixins & serialization methods
 
 ## Mixins

diff --git a/docs/source/package_reference/overview.md b/docs/source/package_reference/overview.md
@@ -0,0 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
+# Overview
+
+This section contains an exhaustive and technical description of `huggingface_hub` classes and methods.
diff --git a/docs/source/package_reference/overview.mdx b/docs/source/package_reference/overview.mdx
diff --git a/docs/source/package_reference/repository.mdx → docs/source/package_reference/repository.md b/docs/source/package_reference/repository.mdx → docs/source/package_reference/repository.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Managing local and online repositories
 
 The `Repository` class is a helper class that wraps `git` and `git-lfs` commands. It provides tooling adapted

diff --git a/...ource/package_reference/space_runtime.mdx → ...source/package_reference/space_runtime.md b/...ource/package_reference/space_runtime.mdx → ...source/package_reference/space_runtime.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Managing your Space runtime
 
 Check the [`HfApi`] documentation page for the reference of methods to manage your Space on the Hub.

diff --git a/.../source/package_reference/tensorboard.mdx → docs/source/package_reference/tensorboard.md b/.../source/package_reference/tensorboard.mdx → docs/source/package_reference/tensorboard.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # TensorBoard logger
 
 TensorBoard is a visualization toolkit for machine learning experimentation. TensorBoard allows tracking and visualizing

diff --git a/docs/source/package_reference/utilities.mdx → docs/source/package_reference/utilities.md b/docs/source/package_reference/utilities.mdx → docs/source/package_reference/utilities.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Utilities
 
 ## Configure logging

diff --git a/...rce/package_reference/webhooks_server.mdx → ...urce/package_reference/webhooks_server.md b/...rce/package_reference/webhooks_server.mdx → ...urce/package_reference/webhooks_server.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Webhooks Server
 
 Webhooks are a foundation for MLOps-related features. They allow you to listen for new changes on specific repos or to

diff --git a/docs/source/quick-start.mdx → docs/source/quick-start.md b/docs/source/quick-start.mdx → docs/source/quick-start.md
@@ -1,3 +1,7 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
 # Quickstart
 
 The [Hugging Face Hub](https://huggingface.co/) is the go-to place for sharing machine learning