Skip to content

Commit 9fb1148

Browse files
authored
ML: add link to Grafana Cloud docs to describe hyper params (#1918)
1 parent f15f5bd commit 9fb1148

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

docs/resources/machine_learning_job.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,17 @@ page_title: "grafana_machine_learning_job Resource - terraform-provider-grafana"
44
subcategory: "Machine Learning"
55
description: |-
66
A job defines the queries and model parameters for a machine learning task.
7+
See the Grafana Cloud docs https://grafana.com/docs/grafana-cloud/alerting-and-irm/machine-learning/forecasts/models/ for more information
8+
on available hyperparameters for use in the hyper_params field.
79
---
810

911
# grafana_machine_learning_job (Resource)
1012

1113
A job defines the queries and model parameters for a machine learning task.
1214

15+
See [the Grafana Cloud docs](https://grafana.com/docs/grafana-cloud/alerting-and-irm/machine-learning/forecasts/models/) for more information
16+
on available hyperparameters for use in the `hyper_params` field.
17+
1318
## Example Usage
1419

1520
### Basic Forecast

internal/resources/machinelearning/resource_job.go

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ func resourceJob() *common.Resource {
1818

1919
Description: `
2020
A job defines the queries and model parameters for a machine learning task.
21-
`,
21+
22+
See [the Grafana Cloud docs](https://grafana.com/docs/grafana-cloud/alerting-and-irm/machine-learning/forecasts/models/) for more information
23+
on available hyperparameters for use in the ` + "`hyper_params`" + ` field.`,
2224

2325
CreateContext: checkClient(resourceJobCreate),
2426
ReadContext: checkClient(resourceJobRead),
@@ -77,7 +79,7 @@ A job defines the queries and model parameters for a machine learning task.
7779
Default: 300,
7880
},
7981
"hyper_params": {
80-
Description: "The hyperparameters used to fine tune the algorithm. See https://grafana.com/docs/grafana-cloud/machine-learning/models/ for the full list of available hyperparameters.",
82+
Description: "The hyperparameters used to fine tune the algorithm. See https://grafana.com/docs/grafana-cloud/alerting-and-irm/machine-learning/forecasts/models/ for the full list of available hyperparameters.",
8183
Type: schema.TypeMap,
8284
Optional: true,
8385
Default: map[string]interface{}{},

0 commit comments

Comments
 (0)