更新时间:2022-04-12 GMT+08:00
分享

配置本地IDE(VSCode ToolKit连接)

本节介绍如何在本地安装Microsoft Visual Studio Code(简称VSCode)软件及ModelArts提供了一个VSCode插件工具,协助用户完成SSH远程连接Notebook。

前提条件

  • 下载并安装VSCode。

    Windows用户直接单击此处下载:https://update.code.visualstudio.com/1.57.1/win32-x64-user/stable

    其他系统用户的下载地址: https://code.visualstudio.com/updates/v1_57
    图1 VSCode的下载位置

    VSCode版本要求:建议用户使用VSCode 1.57.1版本或者最新版本进行远程连接。

    图2 VSCode安装指导
  • 设置禁止自动升级VSCode版本。
    1. 执行Ctrl+Shift+P
    2. 搜Open Settings(JSON)
    3. 在配置文件settings.json中添加如下参数

      "update.mode": "manual",

  • 用户本地PC或服务器的操作系统中建议先安装Python环境,详见VSCode官方指导
  • 准备好密钥对。

    密钥对在用户第一次创建时,自动下载,之后使用相同的密钥时不会再有下载界面(用户一定要保存好),或者每次都使用新的密钥对。

Step1 下载VSCode插件

VSCode的插件工具包VSCode-ToolKit集成在ModelArts管理控制台中,请先下载并安装VSCode插件工具包,下载链接

Step2 安装VSCode插件

  1. 在本地的VSCode开发环境中,如图3所示,选择本地的VSCode插件并单击“安装”
    图3 安装VSCode插件
  2. 安装过程预计1~2分钟,如图4所示,请耐心等待。
    图4 安装过程
  3. 安装完成后,系统右下角提示安装完成,导航左侧出现ModelArts图标和SSH远程连接图标,表示VSCode插件安装完成。
    当前网络不佳时SSH远程连接插件可能未安装成功,此时无需操作,之后在实例连接时点击Install and Reload即可.
    图5 Install and Reload
    图6 安装完成提示
    图7 安装完成

Step3 登录VSCode插件

  1. 在本地的VSCode开发环境中,单击ModelArts图标,单击“User Settings”,配置用户登录信息。
    图8 登录插件
  2. 输入如下用户登录信息,单击“登录”
    • Name:自定义用户名,仅用于VSCode页面展示,不与任何华为云用户关联。
    • AK、SK:在华为云帐号中心 > 我的凭证 > 访问密钥中创建访问密钥,获取AK、SK(参考链接)。
    • 选择站点:此处的站点必须和远程连接的Notebook在同一个站点,否则会导致连接失败。

    也可以切换登录方式,采用如下图所示方式输入用户信息后,Ctrl+S保存。

    图9 配置用户登录信息
  3. 登录成功后显示Notebook实例列表。
    图10 登录成功

Step4 创建Notebook实例

创建一个Notebook实例,并开启远程SSH开发,具体参见创建Notebook实例

Step5 连接Notebook实例

  1. 在本地的VSCode开发环境中,右键单击实例名称,单击“Connect to Instance”,启动并连接Notebook实例。

    Notebook实例状态处于“运行中”“停止”状态都可以,如果Notebook实例是停止状态,连接Notebook时,VSCode插件会先启动实例再去连接。

    图11 连接Notebook实例
    或者单击实例名称,在VSCode开发环境中显示Notebook实例详情页,单击“连接”,系统自动启动该Notebook实例并进行远程连接。
    图12 查看Notebook实例详情页
  2. 第一次连接Notebook时,系统右下角会提示需要先配置密钥文件。选择本地密钥pem文件(放在用户家目录下的.ssh文件夹下),根据系统提示单击“OK”
    图13 配置密钥文件
  3. 单击“确定”后,插件自动连接远端Notebook实例。首次连接大约耗时1~2分钟,取决于本地的网络情况。VSCode环境左下角显示类似下图即为连接成功。
    图14 连接成功

Step6 上传本地代码到云端开发环境

  1. 在VSCode界面,单击File > OpenFolder打开云端路径。
    图15 Open Floder
  2. 选择要打开的路径,单击“OK”
    图16 选择文件路径
  3. 此时,会在IDE左侧出现该开发环境下的目录结构,把想要上传的代码及其他文件直接拖拽至对应得文件夹内即完成本地代码上传至云端。

Step7 远程调试代码

在VSCode中打开要执行的代码文件,在执行代码之前需要选择合适的Python版本路径,单击下方默认的Python版本路径,此时在上方会出现该远程环境上所有的python版本,选择自己需要的版本即可。

图17 选择Python版本
  • 对于打开的代码文件,单击run按钮,即可执行,可以在下方的Terminal中看到代码输出信息。
  • 如果要对代码进行debug调试,步骤如下:
    1. 单击左侧Run > Run and Debug
    2. 选择当前打开的默认的python代码文件进行调试。
    3. 对当前代码进行打断点,即在代码左侧进行单击,就会出现小红点。
    4. 此时,即可按照正常的代码调试步骤对代码调试,在界面左边会显示debug信息,代码上方有相应的调试步骤。

相关操作

卸载VSCode插件操作如图18所示。

图18 卸载VSCode插件
分享:

    相关文档

    相关产品

close