Skip to content

Commit 0435457

Browse files
committed
fix(doc): put real URL and more context
1 parent 3ca9dd2 commit 0435457

File tree

2 files changed

+11
-10
lines changed

2 files changed

+11
-10
lines changed

docs/resources/inference_model.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The scaleway_inference_model resource allows you to upload and manage custom inf
1414
```terraform
1515
resource "scaleway_inference_model" "test" {
1616
name = "my-awesome-model"
17-
url = "https://huggingface.co/my-awsome-model"
17+
url = "https://huggingface.co/agentica-org/DeepCoder-14B-Preview"
1818
secret = "my-secret-token"
1919
}
2020
```
@@ -24,13 +24,13 @@ resource "scaleway_inference_model" "test" {
2424
```terraform
2525
resource "scaleway_inference_model" "my_model" {
2626
name = "my-awesome-model"
27-
url = "https://huggingface.co/my-awsome-model"
27+
url = "https://huggingface.co/agentica-org/DeepCoder-14B-Preview"
2828
secret = "my-secret-token"
2929
}
3030
3131
resource "scaleway_inference_deployment" "my_deployment" {
3232
name = "test-inference-deployment-basic"
33-
node_type = "A100-80GB" # replace with your node type
33+
node_type = "H100" # replace with your node type
3434
model_id = scaleway_inference_model.my_model.id
3535
3636
public_endpoint {
@@ -44,8 +44,8 @@ resource "scaleway_inference_deployment" "my_deployment" {
4444
## Argument Reference
4545

4646
- `name` - (Required) The name of the custom model. This must be unique within the project.
47-
- `url` - (Required) The HTTPS URL pointing to your model
48-
- `secret` - (Optional, Sensitive) Secret used to authenticate when pulling the model from a private URL.
47+
- `url` - (Required) The HTTPS source URL from which the model will be downloaded. This is typically a Hugging Face repository URL (e.g., https://huggingface.co/agentica-org/DeepCoder-14B-Preview). The URL must be publicly accessible or require valid credentials via `secret`
48+
- `secret` - (Optional, Sensitive) Authentication token used to pull the model from a private or gated URL (e.g., a Hugging Face access token with read permission).
4949
- `region` - (Defaults to [provider](../index.md#region) `region`) The [region](../guides/regions_and_zones.md#regions) in which the deployment is created.
5050
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the deployment is associated with.
5151

internal/services/inference/model.go

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,18 @@ func ResourceModel() *schema.Resource {
3737
Description: "The name of the model",
3838
},
3939
"url": {
40-
Type: schema.TypeString,
41-
Required: true,
42-
ForceNew: true,
43-
Description: "The URL of the model",
40+
Type: schema.TypeString,
41+
Required: true,
42+
ForceNew: true,
43+
Description: "The HTTPS URL to the model archive or repository. Typically, this is a Hugging Face repository URL (e.g., " +
44+
"`https://huggingface.co/your-org/your-model`). The URL must be publicly accessible or require a valid secret for authentication.",
4445
},
4546
"secret": {
4647
Type: schema.TypeString,
4748
Optional: true,
4849
Sensitive: true,
4950
ForceNew: true,
50-
Description: "The secret to pull a model",
51+
Description: "A token or credential used to authenticate when pulling the model from a private or gated source. For example, a Hugging Face access token with read permissions.",
5152
},
5253
"tags": {
5354
Type: schema.TypeList,

0 commit comments

Comments
 (0)