nteract/papermill

Document common issues users encounter when using papermill

Open

#352 opened on May 3, 2019

View on GitHub
 (8 comments) (1 reaction) (0 assignees)Python (5,381 stars) (402 forks)batch import
docshelp wantednew-contributor-friendly

Description

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.

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic familiarity with papermillability to search for common issues
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
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.