Help Center> ModelArts> DevEnviron> Managing Notebook Instances> Creating a Notebook Instance
Updated on 2024-06-12 GMT+08:00

Creating a Notebook Instance

Before developing a model, create a notebook instance and access it for coding.

Constraints and Limitations

  • Only running notebook instances can be accessed or stopped.
  • A maximum of 10 notebook instances can be created under one account.

Procedure

  1. Log in to the ModelArts management console. In the navigation pane, choose Settings and check whether the access authorization has been configured. If not, configure access authorization. For details, see "Configuring Access Authorization".
    Figure 1 Configuring authorization
  2. Log in to the ModelArts management console. In the navigation pane on the left, choose DevEnviron > Notebook.
  3. Click Create in the upper right corner. On the Create Notebook page, configure parameters.
    1. Configure basic information of the notebook instance, including its name, description, and auto stop status. For details, see Table 1.
      Table 1 Basic parameters

      Parameter

      Description

      Name

      Name of the notebook instance, which is automatically generated by the system. You can rename it based on service requirements. A name consists of a maximum of 128 characters and cannot be empty. It can contain only digits, letters, underscores (_), and hyphens (-).

      Description

      Brief description of the notebook instance

      Auto Stop

      Automatically stops the notebook instance at a specified time. This function is enabled by default. The default value is 1 hour, indicating that the notebook instance automatically stops after running for 1 hour. The options are 1 hour, 2 hours, 4 hours, 6 hours, and Custom. You can select Custom to specify any integer from 1 to 24 hours.

      • Stop as scheduled: If this option is enabled, the notebook instance automatically stops when the running duration exceeds the specified duration.
      NOTE:

      To protect in-progress jobs, a notebook instance does not automatically stop immediately at the auto stop time. Instead, there is a period of 2 to 5 minutes provided for you to renew the auto stop time.

    2. Configure notebook parameters, such as the image and instance flavor. For details, see Table 2.
      Table 2 Notebook instance parameters

      Parameter

      Description

      Image

      Public and private images are supported.

      • Public images are the AI engines built in ModelArts.
      • Private images can be created using an instance that is created using a public image.

      An image corresponds to an AI engine. When you select an image during instance creation, the AI engine is specified accordingly. Select an image as required. Enter a keyword of the image name in the search box on the right to quickly search for the image.

      You can change an image on a stopped notebook instance.

      Resource Type

      Select a resource pool as required.

      Type

      Chip type, which can be CPU or GPU.

      The chips vary depending on the selected image.

      Flavor

      The flavor of your notebook instance. Select a flavor based on your needs.

      Storage

      The storage varies depending on the selected resource type and flavor.

      All the storage paths of EVS and SFS are mounted to /home/ma-user/work. All read and write operations on files in the notebook instance are stored in this directory, not in OBS.

      The data is retained in /home/ma-user/work, even if the notebook instance is stopped or restarted.

      When a notebook instance is deleted, the EVS storage is released and the stored data is not retained. SFS can be mounted to a new notebook instance and data can be retained.

      Remote SSH

      • After you enable this function, you can remotely access the development environment of the notebook instance from your local development environment.
      • When a notebook instance is stopped, you can update the SSH configuration on the instance details page.
      NOTE:

      The notebook instances with remote SSH enabled have VS Code plug-ins (such as Python and Jupyter) and the VS Code server package pre-installed, which occupy about 1 GB persistent storage space.

      Key Pair

      Set a key pair after remote SSH is enabled.

      Select an existing key pair.

      Alternatively, click Create on the right of the text box to create one on the DEW console. To do so, choose Key Pair Service > Private Key Pairs and click Create Key Pair.

      After a notebook instance is created, you can change the key pair on the instance details page.

      CAUTION:

      Download the created key pair and properly keep it. When you use a local IDE to remotely access the notebook development environment, the key pair is required for authentication.

      Whitelist

      Set a whitelist after remote SSH is enabled. This parameter is optional.

      Add the IP addresses for remotely accessing the notebook instance to the whitelist, for example, the IP address of your local PC or the public IP address of the source device. A maximum of five IP addresses can be added and separated by commas (,). If the parameter is left blank, all IP addresses will be allowed for remote SSH access.

      If your source device and ModelArts are isolated from each other in network, obtain the public IP address of your source device using a mainstream search engine, for example, by entering "IP address lookup", but not by running ipconfig or ifconfig/ip locally.

      After a notebook instance is created, you can change the whitelist IP addresses on the instance details page.

  4. Click Next.
  5. After confirming the parameter settings, click Submit.

    Switch to the notebook instance list. The notebook instance is being created. It will take several minutes when its status changes to Running. Then, the notebook instance is created.

  6. In the notebook instance list, click the instance name. On the instance details page that is displayed, view the instance configuration.

    If Remote SSH is enabled, you can click the modification icon on the right of the whitelist to modify it. You can click the modification icon on the right of Authentication to update the key pair of a stopped notebook instance.

    If an EVS disk is used, click Expansion on the right of Storage Capacity to dynamically expand the EVS disk capacity. For details, see Dynamically Expanding EVS Disk Capacity.