# Notebook使用说明 在软件开发领域，随着技术的发展，降低开发者成本和提升开发体验一直是追求的目标。然而，在AI开发阶段，开发者们面临着工具链复杂、资源管理困难等挑战，这与传统软件开发形成了鲜明对比。如何解决这些问题，提升AI开发的效率和体验？ModelArts提供灵活开放的开发环境，通过云原生的资源使用和开发工具链的集成，旨在为不同类型AI开发、探索、教学用户提供更好的云化AI开发体验，降低开发门槛。 ![](https://support.huaweicloud.com/devtool-modelarts/public_sys-resources/warning_3.0-zh-cn.png) Notebook主要用于代码开发与业务调测，不支持长时间稳定运行，不得用于生产类业务。 #### 控制台导航栏说明 为了提升创建Notebook的效率，ModelArts对导航栏进行了一系列的易用性改进。现推出新版导航栏入口样式，旨在简化操作流程并增强界面的直观性。 Notebook导航栏入口： - 新版控制台：在[ModelArts管理控制台](https://console.huaweicloud.com/modelarts/)左侧菜单栏选择"模型开发与训练 \> Notebook"，进入"Notebook"页面。 图1新版控制台入口 ![](https://support.huaweicloud.com/devtool-modelarts/figure/zh-cn_image_0000002556081449.png) - 旧版控制台：在[ModelArts管理控制台](https://console.huaweicloud.com/modelarts/)左侧菜单栏选择"开发空间 \> Notebook"，进入"Notebook"页面。 图2旧版控制台入口 ![](https://support.huaweicloud.com/devtool-modelarts/figure/zh-cn_image_0000002525161496.png) #### Notebook入门案例 ModelArts新版控制台提供了很多Notebook的入门案例，您可以登录ModelArts新版控制台，在左侧导航栏选择"快速入门"，在"开发实践"页签单击案例卡片，了解案例详细说明，也可以在案例卡片中单击"开发"，快速实现对应的功能。 图3快速入门-开发实践 ![](https://support.huaweicloud.com/devtool-modelarts/figure/zh-cn_image_0000002525162234.png "点击放大") #### 使用Notebook **创建Notebook** ModelArts提供了云化版本的Notebook，无需关注安装配置，即开即用，具体参见[创建Notebook实例](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_3495.html)。 **打开Notebook** Notebook支持以下几种使用方式，用于开发基于PyTorch、TensorFlow和MindSpore等引擎的AI模型。 - JupyterLab：支持通过JupyterLab工具在线打开Notebook，具体请参见[通过JupyterLab在线使用Notebook实例](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0011.html)。 图4使用JupyterLab在线开发调试代码 ![](https://support.huaweicloud.com/devtool-modelarts/figure/zh-cn_image_0000002563147741.png "点击放大") - Code Server：[Code Server](https://github.com/coder/code-server)是一个开源项目，它将Visual Studio Code完整运行在远程服务器上，并通过浏览器提供访问能力，具体请参见[使用Code Server进行代码开发](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0014.html)。 - 本地IDE：支持本地IDE的方式开发模型，通过开启SSH连接，用户本地IDE可以远程连接到ModelArts的Notebook开发环境中，调试和运行代码。本地IDE方式不影响用户的编码习惯，并且可以方便快捷地使用云上的Notebook开发环境。 本地IDE当前支持VS Code、SSH工具。VS Code有专门的插件VS Code Toolkit，让远程连接操作更便捷。具体参见[通过VS Code远程使用Notebook实例](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0204.html)、[通过SSH工具远程使用Notebook](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0021.html)。 图5本地IDE远程访问Notebook ![](https://support.huaweicloud.com/devtool-modelarts/figure/zh-cn_image_0000002563164987.png "点击放大") **管理** **Notebook** 在Notebook的使用中，可以快速查找实例，可以在同一个Notebook实例中切换镜像，方便用户灵活调整实例的AI引擎；可以切换节点运行规格，方便用户灵活调整规格资源；可以初期存储使用量较小时选择小存储，可以在创建完成后根据需要扩充EVS容量；使用动态挂载OBS将OBS对象存储模拟成本地文件系统；还可以在Notebook异常时查看实例的事件定位等。 表1Notebook相关操作说明 | 操作 | 说明 | 相关文档 | |:---|:---|:---| | 查看Notebook实例详情 | 查看Notebook实例的详细信息，包括基础信息、存储信息、事件信息等。 | [查看Notebook实例详情](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_3495.html#ZH-CN_TOPIC_0000002354438389__section1261438141113) | | 查找Notebook实例 | Notebook页面展示了所有创建的实例。如果需要查找特定的实例，可根据筛选条件快速查找。 | [查找Notebook实例](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0216.html) | | 接入环境 | 针对创建好的Notebook实例（即状态为"运行中"的实例），可以打开Notebook并在开发环境中启动编码。 | [打开Notebook] | | 保存镜像 | 通过预置镜像创建Notebook实例，在基础镜像上安装对应的自定义软件和依赖，将运行的实例环境以容器镜像的方式保存下来。 | [保存Notebook实例](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0008.html) | | 停止/启动/删除Notebook实例 | 由于运行中的Notebook将一直耗费资源，您可以通过停止操作，停止资源消耗。对于停止状态的Notebook，可通过启动操作重新使用Notebook。 针对不再使用的Notebook实例，可以删除以释放资源。Notebook删除后不可恢复，请谨慎操作。实例删除后，挂载目录下的数据也将一并删除，请谨慎操作。 | [启动/停止/删除Notebook实例](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0006.html) | | 设置自动停止 | 开启后，可设置Notebook实例自动停止方式及对应时长，超出您预设的时长，将自动停止运行 (可能存在2-5分钟的延迟，此过程正常计费)。 | [启动/停止/删除Notebook实例](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0006.html) | | 变更镜像 | ModelArts允许用户在同一个Notebook实例中切换镜像，方便用户灵活调整实例的AI引擎。Notebook实例状态需在"停止"中才可以变更镜像。 | [变更镜像](https://support.huaweicloud.com/devtool-modelarts/modelarts_30_0051.html#ZH-CN_TOPIC_0000001402317016__section57451355175612) | | 变更实例规格 | ModelArts允许用户在同一个Notebook实例中切换节点运行规格，方便用户灵活调整规格资源。只有处于"停止"、"运行中"和"启动失败"的Notebook实例才能变更规格。 | [变更Notebook实例运行规格](https://support.huaweicloud.com/devtool-modelarts/modelarts_30_0051.html#ZH-CN_TOPIC_0000001402317016__section692217222582) | | 节点亲和性调度 | 通过节点亲和性，可以确保Pod被调度到满足特定条件的节点上，从而实现更细粒度的资源管理和优化。 | [设置节点亲和性调度](https://support.huaweicloud.com/devtool-modelarts/modelarts_30_0051.html#ZH-CN_TOPIC_0000001402317016__section13788121675814) | | 配置Notebook SSH远程连接 | ModelArts允许用户在Notebook实例中更改SSH配置信息，Notebook实例状态需在"停止"时才可以修改。"SSH远程开发"开关打开后不可关闭。 | [开启SSH远程开发](https://support.huaweicloud.com/devtool-modelarts/modelarts_30_0051.html#ZH-CN_TOPIC_0000001402317016__section671554385910) | | 编辑标签 | 标签可用于标识、分类、搜索和管理Notebook实例。 | [编辑标签](https://support.huaweicloud.com/devtool-modelarts/modelarts_30_0051.html#ZH-CN_TOPIC_0000001402317016__section16977161712289) | | 动态扩充云硬盘EVS容量 | 在Notebook开发过程中，初期存储使用量较小时， 创建Notebook可以选择小容量EVS， 比如5G大小； 开发完成后，需要大规模数据集训练，此时再将存储容量扩容至当前阶段所需容量，可以节约成本。 | [Notebook动态扩充云硬盘EVS容量](https://support.huaweicloud.com/devtool-modelarts/modelarts_30_0040.html) | | 动态挂载OBS并行文件系统 | 在ModelArts运行态的Notebook容器中，采用动态挂载特性，将OBS对象存储模拟成本地文件系统。 | [Notebook存储挂载方式说明](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0007.html) | | 查看Notebook实例资源使用情况 | 使用Notebook过程中，可以在Notebook详情页了解资源使用情况。 | [查看Notebook实例资源使用情况](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0231.html) | | 查看Notebook实例事件 | 在Notebook的整个生命周期，包括实例的创建、启动、停止、规格变更等关键操作以及实例的运行状态等在后台都有记录，用户可以在Notebook实例详情页中查看具体的事件，通过实例的事件，从而看到实例的运行或者异常等状态详情。 | [查看Notebook实例事件](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0230.html) | | Notebook Cache盘告警上报 | 创建Notebook时，可以根据业务数据量的大小选择CPU、GPU或者Ascend资源，对GPU或Ascend类型的资源，ModelArts会挂载硬盘至"/cache"目录，用户可以使用此目录来储存临时文件。 当前开发环境的Cache盘使用时，没有容量告警，在使用时很容易超过限制，并直接重启Notebook实例。重启后多种配置重置，会导致用户数据丢弃，环境丢失，造成很不好的使用体验。因此需要提供cache盘使用情况的监控和告警，并将数据上报至AOM平台。 | [Notebook Cache盘告警上报](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_03031.html) | | 升级JupyterLab版本 | 为了提高Notebook的易用性，现将JupyterLab升级至4.4.10版本（2025年稳定版），实现从JupyterLab 3.2.3（2021年老版）的跨版本升级。此次升级对Notebook的性能和启动速度进行了优化，重构了编辑器，强化了调试和协作功能，扩展了更稳定的生态系统，并全面改善了交互体验和内存占用。 | [升级JupyterLab版本](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_03032.html) | **上传文件至Notebook** 在AI开发过程中，如何将文件方便快速地上传到Notebook几乎是每个开发者都会遇到的问题。ModelArts提供了多种文件上传方式，在文件上传过程中，可以查看上传进度和速度。 - 将本地文件上传，请参考[支持上传本地文件](https://support.huaweicloud.com/devtool-modelarts/modelarts_30_0043.html)。 - GitHub的开源仓库的文件上传，请参考[支持Clone GitHub开源仓库](https://support.huaweicloud.com/devtool-modelarts/modelarts_30_0048.html)。 - 存放在OBS中的文件上传，请参考[支持上传OBS文件](https://support.huaweicloud.com/devtool-modelarts/modelarts_30_0049.html)。 - 类似开源数据集这样的远端文件上传，请参考[支持上传远端文件](https://support.huaweicloud.com/devtool-modelarts/modelarts_30_0050.html)。 #### CodeLab ModelArts提供了CodeLab功能，一方面，一键进入开发环境，同时预置了免费的算力规格，可直接免费体验Notebook功能；另一方面，针对AI Gallery社区发布的Notebook样例（.ipynb格式文件），可直接在CodeLab中打开，查看他人分享的样例代码，具体请参见[使用CodeLab体验Notebook](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0010.html)。 #### ModelArts CLI ModelArts CLI集成在ModelArts开发环境Notebook中，用于连接ModelArts服务并在ModelArts资源上执行管理命令。ma-cli支持用户在ModelArts Notebook及线下虚拟机中与云端服务交互，使用ma-cli命令可以实现命令自动补全、鉴权、镜像构建、提交ModelArts训练作业、提交DLI Spark作业、OBS数据复制等，具体参见[ModelArts CLI命令参考](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0301.html)。 #### MoXing ModelArts Notebook内置MoXing Framework模块，ModelArts mox.file提供了一套更为方便地访问OBS的API，允许用户通过一系列模仿操作本地文件系统的API来操作OBS文件。具体参见[ModelArts MoXing命令参考](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_3389.html)。 #### 相关文档 - [开发环境计费项](https://support.huaweicloud.com/price-modelarts/price-modelarts-0010.html) - [开发环境最佳实践](https://support.huaweicloud.com/bestpractice-modelarts/modelarts_10_0036.html) - [开发环境故障排除](https://support.huaweicloud.com/trouble-modelarts/modelarts_13_0001.html) - [开发环境常见问题](https://support.huaweicloud.com/trouble-modelarts/modelarts_13_0001.html)