diff --git a/docs/L0/Python/readme.md b/docs/L0/Python/readme.md index 4f0dee9a8..87707116e 100644 --- a/docs/L0/Python/readme.md +++ b/docs/L0/Python/readme.md @@ -12,7 +12,7 @@ - VScode中的Python Debug - Python基础语法 -**学习完成后，完成由两个任务经过助教批改视为闯关成功**。 +**学习完成后，完成以下两个任务并经过助教批改视为闯关成功**。 | 任务类型 | 任务内容 | 预计耗时 | | --- |---| ---| |闯关任务|Leetcode 383| 15mins| @@ -52,8 +52,11 @@ conda list conda env remove myenv ``` ## 1.3 安装虚拟环境到指定目录 + 有时我们会遇到想将整个虚拟环境保存到制定目录来共享，比如在局域网内，或者在InternStudio的团队开发机间共享。此时我们可以把conda的虚拟环境创建到指定目录下。 + 只需要在创建环境时使用`--prefix`参数制定环境所在的文件夹即可，比如我们想在/root/envs/路径下创建刚刚我们创建过得myenv（只做演示，不用操作）。 + ```shell conda create --prefix /root/envs/myenv python=3.9 ``` @@ -65,16 +68,16 @@ myenv这个文件夹里包含了整个虚拟环境，所以理论上将他直接 # Ch2: 使用pip安装Python三方依赖包 + 在Python开发中，安装和管理第三方包是日常任务。pip是Python官方的包管理工具，全称为“Python Package Installer”，用于方便地安装、升级和管理Python包。 + ## 2.1 使用pip安装包 注意在使用conda的时候，我们需要先激活我们要用的虚拟环境，再在激活的虚拟环境中，使用pip来安装包。pip安装包的命令为`pip install`。 ```shell -pip install somepackages -#比如我想安装pandas和numpy -pip install pandas numpy -#我们也可以指定安装的版本 -pip install numpy==2.0 -#除了==外，还可以用>,<,>=,>=来指定一个版本的范围 +pip install # 安装单个包，替换成你要安装的包名 +pip install pandas numpy # 安装多个包，如panda和numpy +pip install numpy==2.0 # 指定版本安装 +pip install numpy>=1.19,<2.0 # 使用版本范围安装 ``` ## 2.2 安装requirement.txt @@ -94,18 +97,25 @@ triton>=2.1.0,<=2.3.1; ``` ## 2.3 安装到指定目录 + 为了节省大家的存储空间，本次实战营可以直接使用share目录下的conda环境，但share目录只有读权限，所以要安装额外的包时我们不能直接使用pip将包安装到对应环境中，需要安装到我们自己的目录下。 -这时我们在使用pip的时候可以使用--target或-t参数来指定安装目录，此时pip会将你需要安装的包安装到你指定的目录下。 + +这时我们在使用pip的时候可以使用`--target`或`-t`参数来指定安装目录，此时pip会将你需要安装的包安装到你指定的目录下。 + 这里我们用本次实战营最常用的环境`/root/share/pre_envs/pytorch2.1.2cu12.1`来举例。 + ```shell -#首先激活环境 +# 首先激活环境 conda activate /root/share/pre_envs/pytorch2.1.2cu12.1 -#我们可以创建一个目录/root/myenvs，并将包安装到这个目录下 -mkdir /root/myenvs -pip install somepackage --target /root/myenvs -#注意这里也可以使用-r来安装requirements.txt + +# 创建一个目录/root/myenvs，并将包安装到这个目录下 +mkdir -p /root/myenvs +pip install --target /root/myenvs + +# 注意这里也可以使用-r来安装requirements.txt pip install -r requirements.txt --target /root/myenvs ``` + 要使用安装在指定目录的python包，可以在python脚本开头临时动态地将该路径加入python环境变量中去 ```python import sys @@ -124,92 +134,99 @@ if your_directory not in sys.path: # Ch3 **使用本地Vscode连接InternStudio开发机** ## 3.1 使用SSH连接开发机 + VSCode是由微软开发一款轻量级但功能强大的代码编辑器，开源且完全免费。它拥有丰富的插件生态系统、跨平台支持、以及内置的Git控制功能，为开发者提供了高效便捷的编码体验。 VScode下载地址：[Visual Studio Code - Code Editing. Redefined](https://code.visualstudio.com/) -首先需要安装Remote-SSH插件 - -
- Description of the image -
- - -安装完成后进入Remote Explorer,在ssh目录下新建一个ssh链接 - - -
- Description of the image -
- -此时会有弹窗提示输入ssh链接命令，回车后还会让我们选择要更新那个ssh配置文件，默认就选择第一个就行（如果你有其他需要的话也可以新建一个ssh配置文件）。 - -
- Description of the image -
- -
- Description of the image -
- - -开发机的链接命令可以在开发机控制台对应开发机"SSH连接"找到，复制登录命令到vscode的弹窗中然后回车，vscode就会开始链接InternStudio的服务器，记得此时切回去复制一下ssh的密码，待会会用到。 - -
- Description of the image -
- -在新的弹窗中将ssh密码粘贴进去然后回车。随后会弹窗让选择远程终端的类型，这边我们的开发机是linux系统，所以选择linux就好。 - -
- Description of the image -
- -首次连接会进行一些初始化的设置，可能会比较慢，还请耐心等待。后面打开文件夹的时候可能会再需要输入密码，可以一直开着开发机的控制台不要关掉以备不时之需。 - - -看到左下角远程连接已经显示ssh连接地址`SSH:ssh.intern-ai.org.cn`，说明我们已经连接成功了。然后我们就可以像在本地使用vscode一样愉快的使用vscode在开发机上进行任何操作了。 - -
- Description of the image -
- -连接成功后我们打开远程连接的vscode的extensions，在远程开发机上安装好python的插件，后面python debug会用到。也可以一键把我们本地vscode的插件安装到开发机上。 - -
- Description of the image -
- -
- Description of the image -
+首先需要安装`Remote-SSH`插件，安装完成后进入`Remote Explorer`，在ssh目录下新建一个ssh链接。 + + + + + + + + + + + +
+ Description of the image + + Description of the image +
+ 安装Remote-SSH + + 进入Remote Explorer +
+ + +点击`+`号，此时会有弹窗提示输入**SSH链接命令（具体请看下文）**，回车后选择要更新的SSH配置文件，默认选择第一个即可（如有需要也可新建一个SSH配置文件）。 + + + + + + + + + + +
+ Description of the image + + Description of the image +
+ 输入链接命令 + + 选择默认配置文件 +
+ + +开发机的**链接命令**可以在开发机控制台对应开发机"SSH连接"找到，复制登录命令到vscode的弹窗中然后回车，vscode就会开始链接InternStudio的服务器，记得此时切回去复制一下ssh的密码，待会会用到。 + + + + + +
+ Description of the image +
+ +在新的弹窗中将SSH密码粘贴进去然后回车。随后会弹窗让选择远程终端的类型，选择`Linux`即可，因为我们的开发机是`Linux`系统。 + +首次连接会进行一些初始化设置，可能会比较慢，请耐心等待。后续打开文件夹时可能会再次需要输入密码，建议保持开发机的控制台开启以备不时之需。 + +当界面**左下角**显示远程连接地址`SSH:ssh.intern-ai.org.cn`时，说明连接成功。此时，我们可以像在本地使用VSCode一样，在开发机上进行各种操作。 + +连接成功后我们打开远程连接的vscode的extensions，在**远程开发机(SSH:SSH.INTERN-AI.ORG.CN)** 上安装好python的插件，后面python debug会用到。也可以一键把我们本地vscode的插件安装到开发机上。 + + + + + + + + + +
+ Description of the image +
+ Description of the image +
## 3.2如何在Vscode中打开终端 +可以有两种常用的方法打开终端： +1. 单击VSCode页面底部状态栏中的“终端”图标（通常显示为两个图标一个`X`和一个`！`），可以快速打开VSCode的终端面板。 +2. 使用快捷键**Ctrl+`**（反引号，tab键上面那一个），也可以快速打开VSCode的终端面板。 -单击vscode页面下方有一个X和！的位置可以快速打开vscode的控制台，然后进入TERMINAL。 - -
- Description of the image -
- - - -`TIPS`：右上方的+可以新建一个TERMINAL。 - - -4. Debug -4.1 使用VSCode进行Python Debug - - +`TIPS`：终端面板右上方的`+`可以新建一个TERMINAL。 # Ch4 使用vscode连接开发机进行python debug -VSCode是由微软开发一款轻量级但功能强大的代码编辑器，开源且完全免费。它拥有丰富的插件生态系统、跨平台支持、以及内置的Git控制功能，为开发者提供了高效便捷的编码体验。 - -VScode下载地址：[Visual Studio Code - Code Editing. Redefined](https://code.visualstudio.com/) - ## 4.1 什么是debug？ 当你刚开始学习Python编程时，可能会遇到代码不按预期运行的情况。这时，你就需要用到“debug”了。简单来说，“debug”就是能再程序中设置中断点并支持一行一行地运行代码，观测程序中变量的变化，然后找出并修正代码中的错误。而VSCode提供了一个非常方便的debug工具，可以帮助你更容易地找到和修复错误。 @@ -236,64 +253,91 @@ if __name__ =="__main__": - 打开你的Python文件，点击左侧活动栏的“运行和调试”图标。 - 首次debug需要配置以下，点击“create a launch.json file”，选择python debugger后选择“Python File” config。 -
- Description of the image -
+ + + + + +
+ Description of the image +
- 可以直接编辑生成的launch.json文件，配置调试参数，比如添加config（Add Configuration）等。 -
- Description of the image -
-新建python文件后我们如果想要运行，首先需要选择解释器。单击右下角的select interpreter，vsconde会自动扫描开发机上所有的python环境中的解释器。 + + + + +
+ Description of the image +
+ +新建python文件后我们如果想要运行，首先需要选择解释器。单击右下角的select interpreter，vsconde会自动扫描开发机上所有的python环境中的解释器。 **Step3.设置断点** -在代码行号旁边点击，可以添加一个红点，这就是断点（如果不能添加红点需要检查一下python extension是否已经正确安装）。当代码运行到这里时，它会停下来，这样你就可以检查变量的值、执行步骤等。该函数的核心代码在第6行，所以接下来我们在第四行这打上断点。 +在代码行号旁边点击，可以添加一个红点，这就是断点（如果不能添加红点需要检查一下Python扩展是否已经正确安装）。当代码运行到这里时，它会停下来，这样你就可以检查变量的值、执行步骤等。接下来，我们在第4行的核心代码处打上断点。 -
- Description of the image -
+ + + + +
+ Description of the image +
**Step4.启动debug** -点击VSCode侧边栏的“Run and Debug”（运行和调试），选择debug配置后点击绿色箭头（开始调试）按钮，或者按F5键。 +点击VSCode侧边栏的“Run and Debug”（运行和调试），选择调试配置后，点击绿色箭头（开始调试）按钮，或者按F5键。 -
- Description of the image -
+ + + + +
+ Description of the image +
**Step5.查看变量** 当代码在断点处停下来时，你可以查看和修改变量的值。在“Run and Debug”侧边栏的“Variables”（变量）部分，你可以看到当前作用域内的所有变量及其值。 -
- Description of the image -
+ + + + +
+ Description of the image +
**Step6.单步执行代码** 你可以使用顶部的debug面板的按钮来单步执行代码。这样，你可以逐行运行代码，并查看每行代码执行后的效果。 -
- Description of the image -
+ + + + +
+ Description of the image +
+ debug面板各按钮功能介绍： -* `1`: continue: 继续运行到下一个断点 +1. `continue`: 继续运行到下一个断点。 -* `2`: step over：跳过，可以理解为运行当前行代码，不进入具体的函数或者方法。 +2. `step over`: 单步跳过，可以理解为运行当前行代码，不进入具体的函数或者方法。 -* `3`: step into: 进入函数或者方法。如果当行代码存在函数或者方法时，进入代码该函数或者方法。如果当行代码没有函数或者方法，则等价于step over。 +3. `step into`: 单步进入。如果当前行代码存在函数调用，则进入该函数内部。如果当前行代码没有函数调用，则等价于`step over`。 -* `4`: step out：退出函数或者方法, 返回上一层。 +4. `step out`: 单步退出函数，返回到调用该函数的上一层代码。 -* `5`: restart：重新启动debug +5. `restart`: 重新启动调试。 -* `6`: stop：终止debug +6. `stop`: 终止调试。 **Step7.修复错误并重新运行** @@ -302,90 +346,119 @@ debug面板各按钮功能介绍： 通过遵循以上步骤，你可以使用VSCode的debug功能来更容易地找到和修复你Python代码中的错误。可以自己编写一个简单的python脚本，并尝试使用debug来更好的理解代码的运行逻辑。记住，debug是编程中非常重要的一部分，所以不要怕花时间在这上面。随着时间的推移，你会变得越来越擅长它！ ### 4.2.2 不同的断点 + 在调试（Debug）过程中，断点（Breakpoint）允许程序员在程序的执行流程中设置暂停点。当程序运行到这些断点时，执行会暂时中断，使得我们可以检查此时程序的状态，包括变量的值、内存的内容等。断点为我们提供了一个观察程序运行细节的机会，从而帮助我们定位和解决程序中的错误或问题。在VSCode中，我们还可以设置条件断点，这样断点只有在满足特定条件时才会触发。 1. 普通断点：在代码行号左侧点击，添加断点。 -2. 条件断点：在断点标记上右键，选择条件断点（conditional breakpoint）。Vscode中单个程序常用的条件断点主要有三种类型。 -* 1. Expression 表达式：输入一个python表达式，每次触发断点时运行该表达式，当表达式的值为True时vscode会暂停执行。如x==10 -* 2. Hit count 触发计数：断点触发计数达到输入值的时候才会暂停运行 -* 3. Log Message 记录日志：触发该断点的时候在Debug console中输出指定信息，其实就是logpoint。需要输入要输出的信息，如果要用到表达式的话，可以使用{}将表达式括起来。比如每一次都要记录变量i的值可以写x={i}。 +2. 条件断点：在断点标记上右键，选择条件断点（conditional breakpoint）。VSCode 中常用的条件断点主要有三种类型： + 1. 表达式（Expression）：输入一个 Python 表达式，每次触发断点时运行该表达式，当表达式的值为 True 时 VS Code 会暂停执行。例如：`x == 10` + 2. 触发计数（Hit Count）：断点触发计数达到输入值时才会暂停运行。 + 3. 记录日志（Log Message）：触发该断点时在 Debug Console 中输出指定信息，实际上就是 logpoint。需要输入要输出的信息，如果要用到表达式，可以使用 `{}` 将表达式括起来。例如，每次记录变量 `i` 的值可以写 `x={i}`。 #### 表达式条件断点 -比如我们想让代码从i=end-1时停下来，就可以这样设置。 -现在断点处右键选择条件断点，或者先建立一个普通断点以后编辑断点。 +比如我们想让代码在 `i=end-1` 时停下来，可以这样设置： +在断点处右键选择“条件断点”，然后输入条件 `i == end-1`。 + + + + + +
+ Description of the image +
-
- Description of the image -
回车保存断点，然后运行debug，可以看到程序在i=9的时候停了下来，此时各变量的值如下 -
- Description of the image -
+ + + + +
+ Description of the image +
+ #### 触发计数条件断点 -如果我们想让sum_res+=i在运行5次后停下来，我们可以在这行设置这样的Hit count断点 -
- Description of the image -
+如果我们想让sum_res+=i在运行5次后停下来，我们可以在这行设置`Hit count`断点为5。 + + + + + +
+ Description of the image +
+ 运行debug后，程序第一次暂停时各变量的状态为 -
- Description of the image -
+ + + + +
+ Description of the image +
#### 记录日志条件断点 -每次触发时记录一下i的值 -
- Description of the image -
+在Log Message输入 `Current i is {i}` 每次触发时记录一下 i 的值 -运行debug后我们可以在debug console看到 -
- Description of the image -
+ + + + +
+ Description of the image +
-## 4.3 在vscode使用命令行进行debug -很多时候我们要debug的不止是一个简单的python文件，而是很多参数，参数中不止会有简单的值还可能有错综复杂的文件关系,甚至debug一整个项目。这种情况下，直接使用命令行来发起debug会是一个更好的选择。 +运行debug后我们可以在终端面板的debug console看到 -### 4.3.1 vscode设置 + + + + +
+ Description of the image +
-vscode支持通过remote的方法连接我们在命令行中发起的debug server。首先我们要配置一下debug的config。 +## 4.3 在vscode使用命令行进行debug -还是点击VSCode侧边栏的“Run and Debug”（运行和调试)，单击"create a lauch.json file" +很多时候我们要debug的不止是一个简单的python文件，而是很多参数，参数中不止会有简单的值还可能有错综复杂的文件关系,甚至debug一整个项目。这种情况下，直接使用命令行来发起debug会是一个更好的选择。 -
- Description of the image -
+### 4.3.1 vscode设置 -选择debugger时选择python debuger。选择debug config时选择remote attach就行，随后会让我们选择debug server的地址，因为我们是在本地debug，所以全都保持默认直接回车就可以了，也就是我们的server地址为localhost:5678。 +vscode支持通过remote的方法连接我们在命令行中发起的debug server。首先我们要配置一下debug的config。 -
- Description of the image -
+还是点击VSCode侧边栏的“Run and Debug”（运行和调试），单击"create a lauch.json file" -
- Description of the image -
+选择debugger时选择python debuger。选择debug config时选择remote attach就行，随后会让我们选择debug server的地址，因为我们是在本地debug，所以全都保持默认直接回车就可以了，也就是我们的server地址为 **localhost:5678**。 -
- Description of the image -
+ + + + +
+ Description of the image +
配置完以后会打开配置的json文件，但这不是重点，可以关掉。这时我们会看到run and debug界面有变化，出现了debug选项。 -
- Description of the image -
+ + + + +
+ Description of the image +
+ ### 4.3.2 debug命令行 @@ -401,21 +474,16 @@ python -m debugpy --listen 5678 --wait-for-client ./myscript.py 先在终端中发起debug server，然后再去vscode debug页面单击一下绿色箭头开启debug。 -
- Description of the image -
- -
- Description of the image -
- + + + + +
+ Description of the image +
接下来的操作就和上面一样了。 -
- Description of the image -
- ### 4.3.3 使用别名简化命令 @@ -442,4 +510,4 @@ pyd ./myscript.py # Ch5: Python基础 -本课程也提供一个简易的Python基础教程(内容较多，请前往[ch5_python_intro.md](./ch5_python_intro.md)浏览)。 \ No newline at end of file +本课程也提供一个简易的Python基础教程(内容较多，请前往[ch5_python_intro.md](./ch5_python_intro.md)浏览)。