nteract/papermill

Document common issues users encounter when using papermill

Open

#352 创建于 2019年5月3日

在 GitHub 查看
 (8 评论) (1 反应) (0 负责人)Python (5,381 star) (402 fork)batch import
docshelp wantednew-contributor-friendly

描述

We should add a docs section which outlines common failures, why they happen, and how / where to look to address them. An example is linked below, but a few ideas come to mind:

  • Kernel not found
  • Kernel died (OOM + other reasons)
  • New language not translating parameters
  • Can't access input / output notebook paths
  • Scheme not supported etc...

slack thread

Dennis [Yesterday at 6:11 PM] @here hello everyone, anyone ever experience the following issue when executing a spark notebook from within a Docker container via Papermill: RuntimeError: Kernel died before replying to kernel_info. I found a closed nteract/papermill github issue regarding this problem, but it did not specify a valid solution

3 replies

Dennis [16 hours ago] Sorry nevermind, issue resolved; I realize this has nothing to do with Papermill

betatim [7 hours ago] @Dennis do you think it is worth it to post on the issue you found to say “the problem has nothing to do with papermill, you should investigate X instead” for people from the future who experience this problem?

mseal [< 1 minute ago] I do think we should gather some of these common issues and put them in our docs for papermill, if nothing else because papermill is a touch point for many users and they often don't know how the underlying technologies are interacting.

贡献者指南

技术栈
python
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic familiarity with papermillability to search for common issues
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
Review the linked Slack thread and issue comments to identify common user issues. Compile examples like kernel not found, kernel died, parameter translation failures, and path access problems. Design a documentation section that explains each issue, its root cause, and suggested troubleshooting steps. Reference the existing docs/ directory for structure.