AWS braket documentation change
Summary
Restructured documentation for creating Braket notebooks with improved step-by-step instructions, added details about inactivity manager settings, and clarified advanced configuration options.
Security assessment
Changes focus on improving clarity and structure of setup instructions. While there are mentions of IAM roles, encryption keys, and network access settings, these are standard configuration options rather than new security features or vulnerability fixes. The inactivity manager changes relate to cost management rather than security controls.
Diff
diff --git a/braket/latest/developerguide/braket-get-started-create-notebook.md b/braket/latest/developerguide/braket-get-started-create-notebook.md index 2f7cd59a7..a22f7c5cd 100644 --- a//braket/latest/developerguide/braket-get-started-create-notebook.md +++ b//braket/latest/developerguide/braket-get-started-create-notebook.md @@ -11 +11 @@ -Amazon Braket provides fully-managed Jupyter notebooks to get you started. The Amazon Braket notebook instances are based on [Amazon SageMaker AI notebook instances](https://docs.aws.amazon.com/sagemaker/latest/dg/nbi.html). The following instructions outline the steps required to create a new notebook instance for new and existing customers. +Amazon Braket provides fully managed Jupyter notebooks to get you started. The Amazon Braket notebook instances are based on [Amazon SageMaker AI notebook instances](https://docs.aws.amazon.com/sagemaker/latest/dg/nbi.html). The following steps outline how to create a new notebook instance for new and existing customers. @@ -13 +13 @@ Amazon Braket provides fully-managed Jupyter notebooks to get you started. The A -**New Amazon Braket customers** +**New Amazon Braket customers:** @@ -17 +17 @@ Amazon Braket provides fully-managed Jupyter notebooks to get you started. The A - 2. Click **Get Started** on the **Welcome to Amazon Braket** modal, located in the center of your dashboard page, to provide a notebook name. This will create a default Jupyter notebook. + 2. Click **Get Started** on the **Welcome to Amazon Braket** modal in the center of your dashboard page. Provide a notebook name to create a default Jupyter notebook. @@ -19 +19 @@ Amazon Braket provides fully-managed Jupyter notebooks to get you started. The A - 3. It can take several minutes to create your notebook. Your notebook will be listed on the **Notebooks** page with a status of **Pending**. When your notebook instance is ready to use, the status changes to **InService**. You might need to refresh the page to display the updated status for the notebook. + 1. It may take several minutes to create your notebook. @@ -20,0 +21 @@ Amazon Braket provides fully-managed Jupyter notebooks to get you started. The A + 2. Your notebook will be listed on the **Notebooks** page with a status of **Pending**. @@ -21,0 +23 @@ Amazon Braket provides fully-managed Jupyter notebooks to get you started. The A + 3. When your notebook instance is ready to use, the status changes to **InService**. @@ -22,0 +25 @@ Amazon Braket provides fully-managed Jupyter notebooks to get you started. The A + 4. Refresh the page to display the updated status for the notebook. @@ -24 +26,0 @@ Amazon Braket provides fully-managed Jupyter notebooks to get you started. The A -**Existing Amazon Braket customers** @@ -26 +27,0 @@ Amazon Braket provides fully-managed Jupyter notebooks to get you started. The A - 1. Open the Amazon Braket console, select **Notebooks** in the left pane, choose **Create notebook instance**. If you have zero notebooks, select the **Standard setup** to create a default Jupyter notebook and enter a **Notebook instance name** using only alphanumeric and hyphen characters and select your preferred visual mode. Then, enable or disable the inactivity manager for your notebook. @@ -28 +28,0 @@ Amazon Braket provides fully-managed Jupyter notebooks to get you started. The A - 1. If enabled, select the desired idle duration time before the notebook is reset. When a notebook is reset the compute charges will stop incurring, but the storage charges will continue. @@ -30 +30,15 @@ Amazon Braket provides fully-managed Jupyter notebooks to get you started. The A - 2. To view the remaining idle time in your notebook instance, navigate to the command bar and select the **Braket** tab, followed by the **Inactivity Manager** tab. +**Existing Amazon Braket customers:** + + 1. Open the [Amazon Braket console](https://console.aws.amazon.com/braket/home) and select **Notebooks** in the left pane. + + 2. Select **Create notebook instance**. + + 1. If you have zero notebooks, select the **Standard setup** to create a default Jupyter notebook. + + 3. Enter a **Notebook instance name** , using only alphanumeric and hyphen characters, and select your preferred **Visual Mode**. + + 4. Enable or disable the **Notebook inactivity manager** for your notebook. + + 1. If enabled, select the desired idle duration time before the notebook is reset. When a notebook is reset, the compute charges stop incurring, but the storage charges will continue. + + 2. To check how much idle time remains for your notebook instance, navigate to the command bar, select the **Braket** tab, and then the **Inactivity Manager** tab. @@ -34 +48,5 @@ Amazon Braket provides fully-managed Jupyter notebooks to get you started. The A -To save your work from being lost consider [integrating your SageMaker AI notebook instance with a git repository](https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). As an alternative, moving your work outside of the `/Braket Algorithms` and `/Braket Examples` folders will prevent the file from being overwritten by the notebook instance restarting. +To save your work, integrate your [SageMaker AI notebook instance with a Git repository](https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). Alternately, move your work outside of the `/Braket Algorithms` and `/Braket Examples` folders so they are not overwritten by the notebook instance restarting. + + 5. (Optional) With **Advanced setup** , you can create a notebook with access permissions, additional configurations, and network access settings: + + 1. In **Notebook configuration** choose your instance type. @@ -36 +54 @@ To save your work from being lost consider [integrating your SageMaker AI notebo - 2. (Optional) With **Advanced setup** you can create a notebook with access permissions, additional configurations, and network access settings: + 1. The standard, cost-effective instance type, **ml.t3.medium** is chosen by default. To learn more about instance pricing, see [Amazon SageMaker AI pricing](https://aws.amazon.com/sagemaker/pricing/). @@ -38 +56 @@ To save your work from being lost consider [integrating your SageMaker AI notebo - 1. In **Notebook configuration** choose your instance type. The standard, cost-effective instance type, **ml.t3.medium** is chosen by default. To learn more about instance pricing, see [Amazon SageMaker AI pricing](https://aws.amazon.com/sagemaker/pricing/). If you want to associate a public Github repository with your notebook instance, click on the **Git repository** dropdown and select **Clone a public git repository from url** from the **Repository** dropdown menu. Enter the URL of the repo in the **Git repository URL** text bar. + 2. To associate a public Github repository with your notebook instance, click on the **Git repository** dropdown and select **Clone a public git repository from url** from the **Repository** dropdown menu. Enter the URL of the repo in the **Git repository URL** text bar. @@ -40 +58 @@ To save your work from being lost consider [integrating your SageMaker AI notebo - 2. In **Permissions** , configure any optional IAM roles, root access, and encryption keys. + 3. In **Access permissions** , configure any optional IAM roles, root access, and encryption keys. @@ -42 +60 @@ To save your work from being lost consider [integrating your SageMaker AI notebo - 3. In **Network** , configure custom network and access settings for your Jupyter Notebook instance. + 4. In **Network access** , configure custom network and access settings for your Jupyter Notebook instance. @@ -44 +62 @@ To save your work from being lost consider [integrating your SageMaker AI notebo - 3. Review your settings, set any tags to identify your notebook instance, and click **Launch**. + 6. Review your settings, and set any tags to identify your notebook instance. Click **Launch**. @@ -51 +69 @@ To save your work from being lost consider [integrating your SageMaker AI notebo -You can view and manage your Amazon Braket notebook instances in the Amazon Braket and Amazon SageMaker AI consoles. Additional Amazon Braket notebook settings are available through the [SageMaker console](https://console.aws.amazon.com/sagemaker/). +View and manage your Amazon Braket notebook instances in the Amazon Braket and Amazon SageMaker AI consoles. Additional Amazon Braket notebook settings are available through the [SageMaker console](https://console.aws.amazon.com/sagemaker/). @@ -53 +71 @@ You can view and manage your Amazon Braket notebook instances in the Amazon Brak -If you’re working in the Amazon Braket console within AWS the Amazon Braket SDK and plugins are preloaded in the notebooks you created. If you want to run on your own machine, you can install the SDK and plugins when you run the command `pip install amazon-braket-sdk` or when you run the command `pip install amazon-braket-pennylane-plugin` for use with PennyLane plugins. +If you are working in the Amazon Braket console within AWS the Amazon Braket SDK and plugins are preloaded in the notebooks you created. To run on your own machine, install the SDK and plugins when you run the command `pip install amazon-braket-sdk` or when you run the command `pip install amazon-braket-pennylane-plugin` for PennyLane plugins.