Skip to content

Commit 32efb54

Browse files
committed
selective rename
1 parent 47b3ffa commit 32efb54

32 files changed

+62
-62
lines changed

.github/workflows/api_inference_build_documentation.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Build Inference API documentation
33
on:
44
push:
55
paths:
6-
- "docs/api-inference/**"
6+
- "docs/inference-providers/**"
77
branches:
88
- main
99

@@ -13,8 +13,8 @@ jobs:
1313
with:
1414
commit_sha: ${{ github.sha }}
1515
package: hub-docs
16-
package_name: api-inference
17-
path_to_docs: hub-docs/docs/api-inference/
16+
package_name: inference-providers
17+
path_to_docs: hub-docs/docs/inference-providers/
1818
additional_args: --not_python_module
1919
secrets:
2020
hf_token: ${{ secrets.HF_DOC_BUILD_PUSH }}

.github/workflows/api_inference_build_pr_documentation.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Build Inference API PR Documentation
33
on:
44
pull_request:
55
paths:
6-
- "docs/api-inference/**"
6+
- "docs/inference-providers/**"
77

88
concurrency:
99
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
@@ -16,6 +16,6 @@ jobs:
1616
commit_sha: ${{ github.event.pull_request.head.sha }}
1717
pr_number: ${{ github.event.number }}
1818
package: hub-docs
19-
package_name: api-inference
20-
path_to_docs: hub-docs/docs/api-inference/
19+
package_name: inference-providers
20+
path_to_docs: hub-docs/docs/inference-providers/
2121
additional_args: --not_python_module

.github/workflows/api_inference_generate_documentation.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,23 +23,23 @@ jobs:
2323
with:
2424
run_install: |
2525
- recursive: true
26-
cwd: ./scripts/api-inference
26+
cwd: ./scripts/inference-providers
2727
args: [--frozen-lockfile]
28-
package_json_file: ./scripts/api-inference/package.json
28+
package_json_file: ./scripts/inference-providers/package.json
2929
- name: Update huggingface/tasks package
30-
working-directory: ./scripts/api-inference
30+
working-directory: ./scripts/inference-providers
3131
run: |
3232
pnpm update @huggingface/tasks@latest
3333
# Generate
3434
- name: Generate API inference documentation
3535
run: pnpm run generate
36-
working-directory: ./scripts/api-inference
36+
working-directory: ./scripts/inference-providers
3737

3838
# Check changes
3939
- name: Check changes
4040
run: |
4141
git diff --name-only > changed_files.txt
42-
if grep -v -E "^(scripts/api-inference/package.json|scripts/api-inference/pnpm-lock.yaml)$" changed_files.txt | grep -q '.'; then
42+
if grep -v -E "^(scripts/inference-providers/package.json|scripts/inference-providers/pnpm-lock.yaml)$" changed_files.txt | grep -q '.'; then
4343
echo "changes_detected=true" >> $GITHUB_ENV
4444
else
4545
echo "changes_detected=false" >> $GITHUB_ENV
@@ -58,13 +58,13 @@ jobs:
5858
with:
5959
token: ${{ secrets.TOKEN_INFERENCE_SYNC_BOT }}
6060
commit-message: Update API inference documentation (automated)
61-
branch: update-api-inference-docs-automated-pr
61+
branch: update-inference-providers-docs-automated-pr
6262
delete-branch: true
6363
title: "[Bot] Update API inference documentation"
6464
body: |
6565
This PR automatically upgrades the `@huggingface/tasks` package and regenerates the API inference documentation by running:
6666
```sh
67-
cd scripts/api-inference
67+
cd scripts/inference-providers
6868
pnpm update @huggingface/tasks@latest
6969
pnpm run generate
7070
```

.github/workflows/api_inference_upload_pr_documentation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
build:
1111
uses: huggingface/doc-builder/.github/workflows/upload_pr_documentation.yml@main
1212
with:
13-
package_name: api-inference
13+
package_name: inference-providers
1414
secrets:
1515
hf_token: ${{ secrets.HF_DOC_BUILD_PUSH }}
1616
comment_bot_token: ${{ secrets.COMMENT_BOT_TOKEN }}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!---
22
This markdown file has been generated from a script. Please do not edit it directly.
33
For more details, check out:
4-
- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/api-inference/scripts/generate.ts
5-
- 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
4+
- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/inference-providers/scripts/generate.ts
5+
- 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
66
- 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
77
- 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
88
- the snippets used to generate the example:

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!---
22
This markdown file has been generated from a script. Please do not edit it directly.
33
For more details, check out:
4-
- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/api-inference/scripts/generate.ts
5-
- 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
4+
- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/inference-providers/scripts/generate.ts
5+
- 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
66
- 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
77
- 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
88
- the snippets used to generate the example:

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!---
22
This markdown file has been generated from a script. Please do not edit it directly.
33
For more details, check out:
4-
- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/api-inference/scripts/generate.ts
5-
- 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
4+
- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/inference-providers/scripts/generate.ts
5+
- 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
66
- 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
77
- 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
88
- the snippets used to generate the example:
@@ -15,7 +15,7 @@ For more details, check out:
1515
## Chat Completion
1616

1717
Generate a response given a list of messages in a conversational context, supporting both conversational Language Models (LLMs) and conversational Vision-Language Models (VLMs).
18-
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).
18+
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).
1919

2020
### Recommended models
2121

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!---
22
This markdown file has been generated from a script. Please do not edit it directly.
33
For more details, check out:
4-
- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/api-inference/scripts/generate.ts
5-
- 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
4+
- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/inference-providers/scripts/generate.ts
5+
- 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
66
- 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
77
- 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
88
- the snippets used to generate the example:

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!---
22
This markdown file has been generated from a script. Please do not edit it directly.
33
For more details, check out:
4-
- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/api-inference/scripts/generate.ts
5-
- 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
4+
- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/inference-providers/scripts/generate.ts
5+
- 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
66
- 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
77
- 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
88
- the snippets used to generate the example:

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!---
22
This markdown file has been generated from a script. Please do not edit it directly.
33
For more details, check out:
4-
- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/api-inference/scripts/generate.ts
5-
- 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
4+
- the `generate.ts` script: https://github.com/huggingface/hub-docs/blob/main/scripts/inference-providers/scripts/generate.ts
5+
- 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
66
- 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
77
- 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
88
- the snippets used to generate the example:

0 commit comments

Comments
 (0)