Skip to content

Commit 6e89659

Browse files
[Inference Providers] add instructions for provider documentation (#1734)
* add instructions for provider documentation * suggestions from code review Co-authored-by: Julien Chaumond <[email protected]> * simplify logo step --------- Co-authored-by: Julien Chaumond <[email protected]>
1 parent cd40326 commit 6e89659

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/inference-providers/register-as-a-provider.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -457,6 +457,24 @@ class MyNewProviderTaskProviderHelper(TaskProviderHelper):
457457
- Go to [tests/test_inference_providers.py](https://github.com/huggingface/huggingface_hub/blob/main/tests/test_inference_providers.py) and add static tests for overridden methods.
458458

459459

460+
## 6. Add provider documentation
461+
462+
Create a dedicated documentation page for your provider within the Hugging Face documentation. This page should contain a concise description of your provider services, highlight the benefits for users, set expectations regarding performance or features, and include any relevant details such as pricing models or data retention policies. Essentially, provide any information that would be valuable to end users.
463+
464+
Here's how to add your documentation page:
465+
466+
- Provide Your Logo: You can send your logo files (separate light and dark mode versions) directly to us. This is often the simplest way. Alternatively, if you prefer, you can open a PR in the [huggingface/documentation-images](https://huggingface.co/datasets/huggingface/documentation-images/tree/main/inference-providers/logos) repository. If you choose to open a PR:
467+
* Logos must be in `.png` format.
468+
* Name them `{provider-name}-light.png` and `{provider-name}-dark.png`.
469+
* Please ping `@Wauplin` and `@celinah` on the PR.
470+
- Create the Documentation File:
471+
* Use an existing provider page as a template. For example, check out the template for [Fal AI](https://github.com/huggingface/hub-docs/blob/main/scripts/inference-providers/templates/providers/fal-ai.handlebars).
472+
* The file should be located under `scripts/inference-providers/templates/providers/{your-provider-name}.handlebars`.
473+
- Submit the Documentation PR:
474+
* Add your new `{provider-name}.handlebars` file.
475+
* Update the [partners table](./index#partners) to include your company or product.
476+
477+
460478
## FAQ
461479

462480
**Question:** By default, in which order do we list providers in the settings page?

0 commit comments

Comments
 (0)