Skip to content

Commit 00bf2b6

Browse files
authored
Update provider registration instructions for org plans (#1853)
* Update provider registration instructions for org plans Clarifies that organizations must be upgraded to a Team or Enterprise plan to proceed with provider registration, improving guidance for enterprise users. * this is done no @SBrandeis? * update wording * move to a better spot
1 parent a3505d4 commit 00bf2b6

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

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

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ First step is to use the Model Mapping API to register which HF models are suppo
129129

130130
<Tip>
131131

132-
To proceed with this step, we have to enable your account server-side. Make sure you have an organization on the Hub for your enterprise.
132+
To proceed with this step, we have to enable your account server-side. Make sure you have an organization on the Hub for your company, and upgrade it to a Team or Enterprise plan.
133133

134134
</Tip>
135135

@@ -152,10 +152,23 @@ Create a new mapping item, with the following body (JSON-encoded):
152152
- `task`, also known as `pipeline_tag` in the HF ecosystem, is the type of model / type of API
153153
(examples: "text-to-image", "text-generation", but you should use "conversational" for chat models)
154154
- `hfModel` is the model id on the Hub's side.
155-
- `providerModel` is the model id on your side (can be the same or different).
155+
- `providerModel` is the model id on your side (can be the same or different. In general, we encourage you to use the HF model ids on your side as well, but this is up to you).
156156

157157
The output of this route is a mapping ID that you can later use to update the mapping's status or delete it.
158158

159+
#### Authentication
160+
161+
You need to be in the _provider_ Hub organization (e.g. https://huggingface.co/togethercomputer
162+
for TogetherAI) with **Write** permissions to be able to access this endpoint.
163+
164+
#### Validation
165+
166+
The endpoint validates that:
167+
- `hfModel` is indeed of `pipeline_tag == task` OR `task` is "conversational" and the model is
168+
compatible (i.e. the `pipeline_tag` is either "text-generation" or "image-text-to-text" AND the model is tagged as "conversational").
169+
- After the mapping creation (asynchronously) we automatically test whether the Partner API correctly handles huggingface.js/inference calls for the relevant task, ensuring the API specifications are valid. See the [Automatic validation](#automatic-validation) section below.
170+
171+
159172
### Using a tag-filter to map several HF models to a single inference endpoint
160173

161174
We also support mapping HF models based on their `tags`. Using tag filters, you can automatically map multiple HF models to a single inference endpoint on your side.
@@ -194,19 +207,6 @@ Create a new mapping item, with the following body (JSON-encoded):
194207

195208
The output of this route is a mapping ID that you can later use to update the mapping's status or delete it.
196209

197-
#### Authentication
198-
199-
You need to be in the _provider_ Hub organization (e.g. https://huggingface.co/togethercomputer
200-
for TogetherAI) with **Write** permissions to be able to access this endpoint.
201-
202-
#### Validation
203-
204-
The endpoint validates that:
205-
- `hfModel` is indeed of `pipeline_tag == task` OR `task` is "conversational" and the model is
206-
compatible (i.e. the `pipeline_tag` is either "text-generation" or "image-text-to-text" AND the model is tagged as "conversational").
207-
- (in the future) we auto-test that the Partner's API successfully responds to a
208-
huggingface.js/inference call of the corresponding task i.e. the API specs are valid.
209-
210210
### Delete a mapping item
211211

212212
```http

0 commit comments

Comments
 (0)