文档首页/ AI开发平台ModelArts/ ModelArts用户指南（Standard）/ 使用Notebook进行AI开发调试/ 通过PyCharm远程使用Notebook实例/ 使用PyCharm手动连接Notebook
更新时间：2024-10-24 GMT+08:00
查看PDF
分享

使用PyCharm手动连接Notebook

本地IDE环境支持PyCharm和VS Code。通过简单配置，即可用本地IDE远程连接到ModelArts的Notebook开发环境中，调试和运行代码。

本章节介绍基于PyCharm环境访问Notebook的方式。

前提条件

  • 本地已安装2019.2及以上版本的PyCharm专业版。SSH远程调试功能只限PyCharm专业版。
  • 创建一个Notebook实例，并开启远程SSH开发。该实例状态必须处于“运行中”，具体参见创建Notebook实例章节。
  • 在Notebook实例详情页面获取开发环境IP地址和端口号。
    图1 Notebook实例详情页面
  • 准备好密钥对。

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

Step1 配置SSH

  1. 在本地的PyCharm开发环境中，单击File -> Settings -> Tools -> SSH Configurations，单击+号，增加一个SSH连接配置。
    • Host：云上开发环境的IP地址，即在开发环境实例页面远程访问模块获取的IP地址。
    • Port：云上开发环境的端口，即在开发环境实例页面远程访问模块获取的端口号。
    • User name：固定为ma-user。
    • Authentication type：Key pair方式。
    • Private key file：存放在本地的云上开发环境私钥文件，即在创建开发环境实例时创建并保存的密钥对文件。
  2. 单击将连接重命名，可以自定义一个便于识别的名字，单击OK。
  3. 配置完成后，单击Test Connection测试连通性。
  4. 选择Yes，显示Successfully connected表示网络可以连通，单击OK。
  5. 在最下方再单击OK保存配置。
图2 配置SSH

Step2 获取开发环境预置虚拟环境路径

  1. 单击“Tools > Start SSH Session”，则可连接到云端开发环境内。
  2. 执行如下命令可在/home/ma-user/下面的README文件查看当前环境内置的Python虚拟环境。 
    cat /home/ma-user/README
  3. 执行source命令可以切换到具体的Python环境中。
  4. 执行which python查看python路径并复制出来，以备后续配置云上Python Interpreter使用。
图3 获取开发环境预置虚拟环境路径

Step3 配置云上Python Interpreter

  1. 单击“File > Settings > Project：PythonProject > Python Interpreter”，单击设置图标，再单击“Add”，添加一个新的interpreter。
  2. 选择“Existing server configuration”，在下拉菜单中选择上一步配置好的SSH configuration，单击“Next”。
  3. 配置Python Interpreter
    • Interpreter：填写第一步复制的python路径，例如：/home/ma-user/anaconda3/envs/Pytorch-1.0.0/bin/python

      如果路径为~/anaconda3/envs/Pytorch-1.0.0/bin/python，把~替换为/home/ma-user即可。

    • Sync folders: 需要配置本地的工程目录文件同步到云上开发环境中的某个目录，推荐配置为/home/ma-user下的某个目录中（其他目录可能没有访问权限），例如/home/ma-user/work/projects。
  4. 单击右侧文件夹图标，勾选上“Automatically upload”选项，以便于本地修改的文件自动上传到容器环境中。
  5. 单击“Finish”，结束配置。

    可以看到本地的工程文件已经自动往云上环境上传了。后续本地的文件每修改一次，都会自动的同步到云上的环境中。

    右下角可以看到当前的Interpreter为Remote Interpreter。

    图4 配置云上Python Interpreter

Step4 云上环境依赖库安装

在进入开发环境后，可以使用不同的虚拟环境，例如TensorFlow、PyTorch等，但是实际开发中，通常还需要安装其他依赖包，此时可以通过Terminal连接到环境里操作。

单击工具栏“Tools >Start SSH session”，选择SSH Configuration中配置的开发环境。可以执行pip install安装所需要的包。

Step5 在开发环境中调试代码

由于已经连接至云端开发环境，此时可以方便的在本地PyCharm中编码、调测并运行。实际运行环境为云上开发环境，资源为云上昇腾AI处理器资源。可以做到本地编写修改代码，直接在云上环境运行。

像本地运行代码一样，直接单击运行按钮运行代码即可，此时虽然是在本地IDE单击的运行按钮，实际上运行的是云端开发环境里的代码，日志可以回显在本地的日志窗口。

图5 调试代码

也可以单击右上角的Run/Debug Configuration来设置运行的参数。

图6 设置运行参数

当需要调试代码时，可以直接打断点，然后使用debug方式运行程序。

图7 代码打断点
图8 Debug方式调试

此时可以进入debug模式，代码运行暂停在该行，且可以查看变量的值。

图9 Debug模式

使用debug方式调试代码的前提是本地的代码和云端的代码是完全一致的，如果不一致可能会导致在本地打断点的行和实际运行时该行的代码并不一样，会出现意想不到的错误。

因此在配置云上Python Interpreter时，推荐选择Automatically upload选项，以保证本地的文件修改能自动上传到云端。如果没有选择自动上传，则本地代码修改完后，也可以参考Step6 同步上传本地文件至Notebook手动上传目录或代码。