selective Rename of api-inference => inference-providers

.github/workflows/api_inference_build_documentation.yml

@@ -3,7 +3,7 @@ name: Build Inference API documentation
 on:
   push:
     paths:
-      - "docs/api-inference/**"
+      - "docs/inference-providers/**"
     branches:
       - main
 
@@ -13,8 +13,8 @@ jobs:
     with:
       commit_sha: ${{ github.sha }}
       package: hub-docs
-      package_name: api-inference
-      path_to_docs: hub-docs/docs/api-inference/
+      package_name: inference-providers
+      path_to_docs: hub-docs/docs/inference-providers/
       additional_args: --not_python_module
     secrets:
       hf_token: ${{ secrets.HF_DOC_BUILD_PUSH }}

.github/workflows/api_inference_build_pr_documentation.yml

@@ -3,7 +3,7 @@ name: Build Inference API PR Documentation
 on:
   pull_request:
     paths:
-      - "docs/api-inference/**"
+      - "docs/inference-providers/**"
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
@@ -16,6 +16,6 @@ jobs:
       commit_sha: ${{ github.event.pull_request.head.sha }}
       pr_number: ${{ github.event.number }}
       package: hub-docs
-      package_name: api-inference
-      path_to_docs: hub-docs/docs/api-inference/
+      package_name: inference-providers
+      path_to_docs: hub-docs/docs/inference-providers/
       additional_args: --not_python_module

.github/workflows/api_inference_generate_documentation.yml

@@ -23,23 +23,23 @@ jobs:
         with:
           run_install: |
             - recursive: true
-              cwd: ./scripts/api-inference
+              cwd: ./scripts/inference-providers
               args: [--frozen-lockfile]
-          package_json_file: ./scripts/api-inference/package.json
+          package_json_file: ./scripts/inference-providers/package.json
       - name: Update huggingface/tasks package
-        working-directory: ./scripts/api-inference
+        working-directory: ./scripts/inference-providers
         run: |
           pnpm update @huggingface/tasks@latest
       # Generate
       - name: Generate API inference documentation
         run: pnpm run generate
-        working-directory: ./scripts/api-inference
+        working-directory: ./scripts/inference-providers
 
       # Check changes
       - name: Check changes
         run: |
           git diff --name-only > changed_files.txt
-          if grep -v -E "^(scripts/api-inference/package.json|scripts/api-inference/pnpm-lock.yaml)$" changed_files.txt | grep -q '.'; then
+          if grep -v -E "^(scripts/inference-providers/package.json|scripts/inference-providers/pnpm-lock.yaml)$" changed_files.txt | grep -q '.'; then
             echo "changes_detected=true" >> $GITHUB_ENV
           else
             echo "changes_detected=false" >> $GITHUB_ENV
@@ -58,13 +58,13 @@ jobs:
         with:
           token: ${{ secrets.TOKEN_INFERENCE_SYNC_BOT }}
           commit-message: Update API inference documentation (automated)
-          branch: update-api-inference-docs-automated-pr
+          branch: update-inference-providers-docs-automated-pr
           delete-branch: true
           title: "[Bot] Update API inference documentation"
           body: |
             This PR automatically upgrades the `@huggingface/tasks` package and regenerates the API inference documentation by running:
             ```sh
-            cd scripts/api-inference
+            cd scripts/inference-providers
             pnpm update @huggingface/tasks@latest
             pnpm run generate
             ```

.github/workflows/api_inference_upload_pr_documentation.yml

@@ -10,7 +10,7 @@ jobs:
   build:
     uses: huggingface/doc-builder/.github/workflows/upload_pr_documentation.yml@main
     with:
-      package_name: api-inference
+      package_name: inference-providers
     secrets:
       hf_token: ${{ secrets.HF_DOC_BUILD_PUSH }}
       comment_bot_token: ${{ secrets.COMMENT_BOT_TOKEN }}

docs/hub/billing.md

@@ -48,7 +48,7 @@ It is billed with the renewal invoices of your PRO or Enterprise Hub subscriptio
 
 ## Compute Services on the Hub
 
-We also directly provide compute services with [Spaces](./spaces), [Inference Endpoints](https://huggingface.co/docs/inference-endpoints/index) and the [Serverless Inference API](https://huggingface.co/docs/api-inference/index).
+We also directly provide compute services with [Spaces](./spaces), [Inference Endpoints](https://huggingface.co/docs/inference-endpoints/index) and the [Serverless Inference API](https://huggingface.co/docs/inference-providers/index).
 
 While most of our compute services have a comprehensive free tier, users and organizations can pay to access more powerful hardware accelerators.
 

docs/hub/models-inference.md

@@ -1,6 +1,6 @@
 # Serverless Inference API
 
-Please refer to [Serverless Inference API Documentation](https://huggingface.co/docs/api-inference) for detailed information.
+Please refer to [Serverless Inference API Documentation](https://huggingface.co/docs/inference-providers) for detailed information.
 
 
 ## What technology do you use to power the Serverless Inference API?

docs/hub/models-widgets.md

@@ -170,7 +170,7 @@ Here are some links to examples:
 
 ## How can I control my model's widget Inference API parameters?
 
-Generally, the Inference API for a model uses the default pipeline settings associated with each task. But if you'd like to change the pipeline's default settings and specify additional inference parameters, you can configure the parameters directly through the model card metadata. Refer [here](https://huggingface.co/docs/api-inference/detailed_parameters) for some of the most commonly used parameters associated with each task.
+Generally, the Inference API for a model uses the default pipeline settings associated with each task. But if you'd like to change the pipeline's default settings and specify additional inference parameters, you can configure the parameters directly through the model card metadata. Refer [here](https://huggingface.co/docs/inference-providers/detailed_parameters) for some of the most commonly used parameters associated with each task.
 
 For example, if you want to specify an aggregation strategy for a NER task in the widget:
 

docs/hub/oauth.md

@@ -35,7 +35,7 @@ The currently supported scopes are:
 - `read-repos`: Get read access to the user's personal repos.
 - `write-repos`: Get write/read access to the user's personal repos.
 - `manage-repos`: Get full access to the user's personal repos. Also grants repo creation and deletion.
-- `inference-api`: Get access to the [Inference API](https://huggingface.co/docs/api-inference/index), you will be able to make inference requests on behalf of the user.
+- `inference-api`: Get access to the [Inference API](https://huggingface.co/docs/inference-providers/index), you will be able to make inference requests on behalf of the user.
 - `write-discussions`: Open discussions and Pull Requests on behalf of the user as well as interact with discussions (including reactions, posting/editing comments, closing discussions, ...). To open Pull Requests on private repos, you need to request the `read-repos` scope as well.
 
 All other information is available in the [OpenID metadata](https://huggingface.co/.well-known/openid-configuration).

docs/hub/spaces-oauth.md

@@ -81,7 +81,7 @@ Those scopes are optional and can be added by setting `hf_oauth_scopes` in your
 - `read-repos`: Get read access to the user's personal repos.
 - `write-repos`: Get write/read access to the user's personal repos.
 - `manage-repos`: Get full access to the user's personal repos. Also grants repo creation and deletion.
-- `inference-api`: Get access to the [Inference API](https://huggingface.co/docs/api-inference/index), you will be able to make inference requests on behalf of the user.
+- `inference-api`: Get access to the [Inference API](https://huggingface.co/docs/inference-providers/index), you will be able to make inference requests on behalf of the user.
 - `write-discussions`: Open discussions and Pull Requests on behalf of the user as well as interact with discussions (including reactions, posting/editing comments, closing discussions, ...). To open Pull Requests on private repos, you need to request the `read-repos` scope as well.
 
 ## Accessing organization resources

docs/hub/spaces-sdks-docker-langfuse.md

@@ -79,7 +79,7 @@ Langfuse maintains native integrations with many popular LLM frameworks, includi
 
 ### Example 1: Trace Calls to HF Serverless API
 
-As a simple example, here's how to trace LLM calls to the [HF Serverless API](https://huggingface.co/docs/api-inference/en/index) using the Langfuse Python SDK.
+As a simple example, here's how to trace LLM calls to the [HF Serverless API](https://huggingface.co/docs/inference-providers/en/index) using the Langfuse Python SDK.
 
 Be sure to first configure your `LANGFUSE_HOST`, `LANGFUSE_PUBLIC_KEY` and `LANGFUSE_SECRET_KEY` environment variables, and make sure you've [authenticated with your Hugging Face account](https://huggingface.co/docs/huggingface_hub/en/quick-start#authentication).
 

docs/api-inference/tasks/audio-classification.md → docs/inference-providers/tasks/audio-classification.md

@@ -1,8 +1,8 @@
 <!---
 This markdown file has been generated from a script. Please do not edit it directly.
 For more details, check out:
-- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/api-inference/scripts/generate.ts
-- the task template defining the sections in the page: https://github.com/huggingface/hub-docs/tree/main/scripts/api-inference/templates/task/audio-classification.handlebars
+- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/inference-providers/scripts/generate.ts
+- the task template defining the sections in the page: https://github.com/huggingface/hub-docs/tree/main/scripts/inference-providers/templates/task/audio-classification.handlebars
 - the input jsonschema specifications used to generate the input markdown table: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/tasks/audio-classification/spec/input.json
 - the output jsonschema specifications used to generate the output markdown table: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/tasks/audio-classification/spec/output.json
 - the snippets used to generate the example:

docs/api-inference/tasks/automatic-speech-recognition.md → docs/inference-providers/tasks/automatic-speech-recognition.md

@@ -1,8 +1,8 @@
 <!---
 This markdown file has been generated from a script. Please do not edit it directly.
 For more details, check out:
-- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/api-inference/scripts/generate.ts
-- the task template defining the sections in the page: https://github.com/huggingface/hub-docs/tree/main/scripts/api-inference/templates/task/automatic-speech-recognition.handlebars
+- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/inference-providers/scripts/generate.ts
+- the task template defining the sections in the page: https://github.com/huggingface/hub-docs/tree/main/scripts/inference-providers/templates/task/automatic-speech-recognition.handlebars
 - the input jsonschema specifications used to generate the input markdown table: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/tasks/automatic-speech-recognition/spec/input.json
 - the output jsonschema specifications used to generate the output markdown table: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/tasks/automatic-speech-recognition/spec/output.json
 - the snippets used to generate the example:

docs/api-inference/tasks/chat-completion.md → docs/inference-providers/tasks/chat-completion.md

@@ -1,8 +1,8 @@
 <!---
 This markdown file has been generated from a script. Please do not edit it directly.
 For more details, check out:
-- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/api-inference/scripts/generate.ts
-- the task template defining the sections in the page: https://github.com/huggingface/hub-docs/tree/main/scripts/api-inference/templates/task/chat-completion.handlebars
+- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/inference-providers/scripts/generate.ts
+- the task template defining the sections in the page: https://github.com/huggingface/hub-docs/tree/main/scripts/inference-providers/templates/task/chat-completion.handlebars
 - the input jsonschema specifications used to generate the input markdown table: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/tasks/chat-completion/spec/input.json
 - the output jsonschema specifications used to generate the output markdown table: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/tasks/chat-completion/spec/output.json
 - the snippets used to generate the example:
@@ -15,7 +15,7 @@ For more details, check out:
 ## Chat Completion
 
 Generate a response given a list of messages in a conversational context, supporting both conversational Language Models (LLMs) and conversational Vision-Language Models (VLMs).
-This is a subtask of [`text-generation`](https://huggingface.co/docs/api-inference/tasks/text-generation) and [`image-text-to-text`](https://huggingface.co/docs/api-inference/tasks/image-text-to-text).
+This is a subtask of [`text-generation`](https://huggingface.co/docs/inference-providers/tasks/text-generation) and [`image-text-to-text`](https://huggingface.co/docs/inference-providers/tasks/image-text-to-text).
 
 ### Recommended models
 

docs/api-inference/tasks/feature-extraction.md → docs/inference-providers/tasks/feature-extraction.md

@@ -1,8 +1,8 @@
 <!---
 This markdown file has been generated from a script. Please do not edit it directly.
 For more details, check out:
-- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/api-inference/scripts/generate.ts
-- the task template defining the sections in the page: https://github.com/huggingface/hub-docs/tree/main/scripts/api-inference/templates/task/feature-extraction.handlebars
+- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/inference-providers/scripts/generate.ts
+- the task template defining the sections in the page: https://github.com/huggingface/hub-docs/tree/main/scripts/inference-providers/templates/task/feature-extraction.handlebars
 - the input jsonschema specifications used to generate the input markdown table: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/tasks/feature-extraction/spec/input.json
 - the output jsonschema specifications used to generate the output markdown table: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/tasks/feature-extraction/spec/output.json
 - the snippets used to generate the example:

docs/api-inference/tasks/fill-mask.md → docs/inference-providers/tasks/fill-mask.md

@@ -1,8 +1,8 @@
 <!---
 This markdown file has been generated from a script. Please do not edit it directly.
 For more details, check out:
-- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/api-inference/scripts/generate.ts
-- the task template defining the sections in the page: https://github.com/huggingface/hub-docs/tree/main/scripts/api-inference/templates/task/fill-mask.handlebars
+- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/inference-providers/scripts/generate.ts
+- the task template defining the sections in the page: https://github.com/huggingface/hub-docs/tree/main/scripts/inference-providers/templates/task/fill-mask.handlebars
 - the input jsonschema specifications used to generate the input markdown table: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/tasks/fill-mask/spec/input.json
 - the output jsonschema specifications used to generate the output markdown table: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/tasks/fill-mask/spec/output.json
 - the snippets used to generate the example:

docs/api-inference/tasks/image-classification.md → docs/inference-providers/tasks/image-classification.md

@@ -1,8 +1,8 @@
 <!---
 This markdown file has been generated from a script. Please do not edit it directly.
 For more details, check out:
-- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/api-inference/scripts/generate.ts
-- the task template defining the sections in the page: https://github.com/huggingface/hub-docs/tree/main/scripts/api-inference/templates/task/image-classification.handlebars
+- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/inference-providers/scripts/generate.ts
+- the task template defining the sections in the page: https://github.com/huggingface/hub-docs/tree/main/scripts/inference-providers/templates/task/image-classification.handlebars
 - the input jsonschema specifications used to generate the input markdown table: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/tasks/image-classification/spec/input.json
 - the output jsonschema specifications used to generate the output markdown table: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/tasks/image-classification/spec/output.json
 - the snippets used to generate the example:

docs/api-inference/tasks/image-segmentation.md → docs/inference-providers/tasks/image-segmentation.md

@@ -1,8 +1,8 @@
 <!---
 This markdown file has been generated from a script. Please do not edit it directly.
 For more details, check out:
-- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/api-inference/scripts/generate.ts
-- the task template defining the sections in the page: https://github.com/huggingface/hub-docs/tree/main/scripts/api-inference/templates/task/image-segmentation.handlebars
+- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/inference-providers/scripts/generate.ts
+- the task template defining the sections in the page: https://github.com/huggingface/hub-docs/tree/main/scripts/inference-providers/templates/task/image-segmentation.handlebars
 - the input jsonschema specifications used to generate the input markdown table: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/tasks/image-segmentation/spec/input.json
 - the output jsonschema specifications used to generate the output markdown table: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/tasks/image-segmentation/spec/output.json
 - the snippets used to generate the example:

docs/api-inference/tasks/image-to-image.md → docs/inference-providers/tasks/image-to-image.md

@@ -1,8 +1,8 @@
 <!---
 This markdown file has been generated from a script. Please do not edit it directly.
 For more details, check out:
-- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/api-inference/scripts/generate.ts
-- the task template defining the sections in the page: https://github.com/huggingface/hub-docs/tree/main/scripts/api-inference/templates/task/image-to-image.handlebars
+- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/inference-providers/scripts/generate.ts
+- the task template defining the sections in the page: https://github.com/huggingface/hub-docs/tree/main/scripts/inference-providers/templates/task/image-to-image.handlebars
 - the input jsonschema specifications used to generate the input markdown table: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/tasks/image-to-image/spec/input.json
 - the output jsonschema specifications used to generate the output markdown table: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/tasks/image-to-image/spec/output.json
 - the snippets used to generate the example:

docs/api-inference/tasks/object-detection.md → docs/inference-providers/tasks/object-detection.md

@@ -1,8 +1,8 @@
 <!---
 This markdown file has been generated from a script. Please do not edit it directly.
 For more details, check out:
-- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/api-inference/scripts/generate.ts
-- the task template defining the sections in the page: https://github.com/huggingface/hub-docs/tree/main/scripts/api-inference/templates/task/object-detection.handlebars
+- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/inference-providers/scripts/generate.ts
+- the task template defining the sections in the page: https://github.com/huggingface/hub-docs/tree/main/scripts/inference-providers/templates/task/object-detection.handlebars
 - the input jsonschema specifications used to generate the input markdown table: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/tasks/object-detection/spec/input.json
 - the output jsonschema specifications used to generate the output markdown table: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/tasks/object-detection/spec/output.json
 - the snippets used to generate the example: