diff --git a/README.md b/README.md index 08c4712..6e0c03f 100644 --- a/README.md +++ b/README.md @@ -39,22 +39,23 @@ The application can be installed directly from [Looker Marketplace](https://mark ##### Option B: Manual Install - [Fork this GitHub repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository) - - [Create a blank LookML project](https://cloud.google.com/looker/docs/create-projects#creating_a_blank_project) - - [Connect the blank LookML project to the new fork repository](https://cloud.google.com/looker/docs/setting-up-git-connection) + - [Create a blank LookML project](https://cloud.google.com/looker/docs/create-projects#creating_a_blank_project) named `marketplace_bqml_ext` + IMPORTANT: The LookML project must be named **marketplace_bqml_ext** + - [Connect the new LookML project to the forked repository](https://cloud.google.com/looker/docs/setting-up-git-connection) - Update the value of the CONNECTION_NAME constant in the `manifest.lkml` file - [Commit and deploy changes to production](https://cloud.google.com/looker/docs/version-control-and-deploying-changes#getting_your_changes_to_production) #### 5. Configure Application with User Attributes -The application uses three [Looker user attributes](https://cloud.google.com/looker/docs/admin-panel-users-user-attributes) to store its configuration settings. The following user attributes are required for the application to work properly. Each user attribute needs to be named exactly as listed below with a data type of `String` and user access set to `None`. +The application uses three [Looker user attributes](https://cloud.google.com/looker/docs/admin-panel-users-user-attributes) to store its configuration settings. The following user attributes are required for the application to work properly. Each user attribute needs to be named exactly as listed below with a data type of `String`. The recommended setting for user access is `None`. -The application should be configured using each of the user attribute's default values. +Create the following user attributes and set their default values. - | **Required User Attribute Name** | **Default Value Description** | - |---------------------------------------------------|-----------------------------------------------------------| - | app_ml_accelerator_bigquery_connection_name | Connection name chosen in Step 1 | - | app_ml_accelerator_gcp_project | Projectd ID for connection chosen in Step 1 | - | app_ml_accelerator_bqml_model_dataset_name | BigQuery dataset created in Step 3 (e.g., `looker_bqml` | + | **Required User Attribute Name** | **Default Value Description** | + |-----------------------------------------------------------------|-------------------------------------------------------------------| + | marketplace_bqml_ext_ml_accelerator_bigquery_connection_name | Connection name chosen in Step 1 | + | marketplace_bqml_ext_ml_accelerator_gcp_project | Projectd ID of the BigQuery dataset created in Step 3 | + | marketplace_bqml_ext_ml_accelerator_bqml_model_dataset_name | Name of BigQuery dataset created in Step 3 (e.g., `looker_bqml`) | #### 6. Create a Looker Role to Manage User Access diff --git a/manifest.lkml b/manifest.lkml index 950e6bc..367ab0e 100644 --- a/manifest.lkml +++ b/manifest.lkml @@ -1,4 +1,4 @@ -project_name: "app-ml-accelerator" +project_name: "marketplace_bqml_ext" application: ml-accelerator { label: "Machine Learning Accelerator" @@ -31,7 +31,7 @@ application: ml-accelerator { } constant: CONNECTION_NAME { - value: "ml_accelerator" + value: "ml-accelerator" export: override_required } diff --git a/marketplace.json b/marketplace.json index 8eca356..ea8165e 100644 --- a/marketplace.json +++ b/marketplace.json @@ -1,5 +1,5 @@ { - "label": "Looker Machine Learning Extension App", + "label": "Machine Learning Accelerator", "category_label": "Applications", "branding": { "image_uri": "https://marketplace-api.looker.com/app-icons/bqml-ext.png", @@ -8,24 +8,26 @@ }, "constants": { "CONNECTION_NAME": { - "label": "BigQuery Connection Name", - "description": "The BigQuery connection the application will be allowed to use.", + "label": "LookML Constant: BigQuery Connection Name", + "description": "The BigQuery connection the application will be allowed to use. Must be the same connection as chosen below.", "value_constraint": "connection" } }, "user_attributes": { - "marketplace_bqml_ext_ml_accelerator_bigquery_connection_name": { - "label": "Machine Learning Accelerator App: BigQuery Connection Name", - "description": "The BigQuery connection the application will be allowed to use.", + "bigquery_connection_name": { + "label": "Machine Learning Accelerator Setting: BigQuery Connection Name", + "description": "The BigQuery connection the application will be allowed to use. Must be the same connection as chosen above.", "type": "string", "required": true, "value_is_hidden": false, "user_can_view": false, "user_can_edit": false, - "default_value": "" + "default_value": "", + "value_constraint": "connection" }, - "marketplace_bqml_ext_ml_accelerator_bqml_model_dataset_name": { - "label": "Machine Learning Accelerator App: BQML Model Dataset Name", + "gcp_project": { + "label": "Machine Learning Accelerator Setting: GCP Project ID", + "description": "The GCP project ID for the BigQuery dataset where ML models will be saved.", "type": "string", "required": true, "value_is_hidden": false, @@ -33,8 +35,9 @@ "user_can_edit": false, "default_value": "" }, - "marketplace_bqml_ext_ml_accelerator_gcp_project": { - "label": "Machine Learning Accelerator App: GCP Project Name", + "bqml_model_dataset_name": { + "label": "Machine Learning Accelerator Setting: BQML Model Dataset Name", + "description": "The dataset where ML models will be saved. Create a new dataset for BQML models (recommended) or choose the same dataset used for Looker PDTs.", "type": "string", "required": true, "value_is_hidden": false,