ML: add link to Grafana Cloud docs to describe hyper params (#1918)

grafana · Nov 21, 2024 · 9fb1148 · 9fb1148
1 parent f15f5bd
commit 9fb1148
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/docs/resources/machine_learning_job.md b/docs/resources/machine_learning_job.md
@@ -4,12 +4,17 @@ page_title: "grafana_machine_learning_job Resource - terraform-provider-grafana"
 subcategory: "Machine Learning"
 description: |-
   A job defines the queries and model parameters for a machine learning task.
+  See the Grafana Cloud docs https://grafana.com/docs/grafana-cloud/alerting-and-irm/machine-learning/forecasts/models/ for more information
+  on available hyperparameters for use in the hyper_params field.
 ---
 
 # grafana_machine_learning_job (Resource)
 
 A job defines the queries and model parameters for a machine learning task.
 
+See [the Grafana Cloud docs](https://grafana.com/docs/grafana-cloud/alerting-and-irm/machine-learning/forecasts/models/) for more information
+on available hyperparameters for use in the `hyper_params` field.
+
 ## Example Usage
 
 ### Basic Forecast

diff --git a/internal/resources/machinelearning/resource_job.go b/internal/resources/machinelearning/resource_job.go
@@ -18,7 +18,9 @@ func resourceJob() *common.Resource {
 
 		Description: `
 A job defines the queries and model parameters for a machine learning task.
-`,
+
+See [the Grafana Cloud docs](https://grafana.com/docs/grafana-cloud/alerting-and-irm/machine-learning/forecasts/models/) for more information
+on available hyperparameters for use in the ` + "`hyper_params`" + ` field.`,
 
 		CreateContext: checkClient(resourceJobCreate),
 		ReadContext:   checkClient(resourceJobRead),
@@ -77,7 +79,7 @@ A job defines the queries and model parameters for a machine learning task.
 				Default:     300,
 			},
 			"hyper_params": {
-				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.",
+				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.",
 				Type:        schema.TypeMap,
 				Optional:    true,
 				Default:     map[string]interface{}{},