如何用Jupyter Notebook正确运行GitHub Python项目？新手排障指引

一、前置准备 #

• 克隆项目仓库到本地：git clone https://github.com/wtomin/SteerablePyramid_Torch_TF_Numpy.git
• 进入项目根目录：cd SteerablePyramid_Torch_TF_Numpy
• 用Anaconda创建并激活虚拟环境：

  conda create -n steerable_env python=3.8
  conda activate steerable_env
  

• 按项目README安装依赖（比如TensorFlow、matplotlib、numpy等）：

  pip install tensorflow matplotlib numpy
  

二、启动Jupyter Notebook #

必须在项目根目录下执行以下命令，确保Jupyter的工作目录为项目根：

jupyter notebook

三、两类错误的解决方法 #

错误1：图片文件找不到 #

当在examples文件夹的Notebook里执行!python example_tf.py时，脚本内的./assets/patagonia.jpg路径是相对于当前工作目录（examples文件夹）的，但实际assets文件夹在项目根。解决方法二选一：

• 切换工作目录到项目根后再运行：

  import os
  os.chdir('../')  # 从examples回到项目根
  !python examples/example_tf.py
  

• 直接修改example_tf.py里的图片路径为../assets/patagonia.jpg（推荐，避免后续路径问题）

错误2：找不到steerable模块 #

复制example_tf.py代码到Notebook运行时，需要先把项目根目录添加到Python的搜索路径中，再导入模块：

import sys
sys.path.append('./')  # 将项目根加入Python路径

# 之后再执行原代码的导入和逻辑
from steerable.SCFpyr_TF import SCFpyr_TF
# ... 其余代码

四、标准运行流程 #

1. 在Jupyter文件浏览器中，进入examples文件夹，新建空白Notebook
2. 第一个单元格添加路径配置：

   import sys, os
   sys.path.append('../')  # 从examples目录指向项目根
   os.chdir('../')  # 切换工作目录到项目根
   

3. 第二个单元格复制example_tf.py的全部代码，执行即可正常运行

内容的提问来源于stack exchange，提问作者Can Celik