Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify input file immutability in the docs, explain what happens with a notebook during job or job definition lifecycle #505

Open
andrii-i opened this issue Apr 9, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@andrii-i
Copy link
Collaborator

andrii-i commented Apr 9, 2024

Problem

As #504 (comment) points out, docs do not clearly explain input file immutability.

Moreover, sentence When the scheduler runs your notebook, it makes a copy of the input file (https://jupyter-scheduler.readthedocs.io/en/latest/users/index.html#use) could be interpreted in a way that implies that every scheduled execution makes a copy of the input file notebook including mutations.

Proposed Solution

Clarify input file immutability in the docs, explain what happens with a notebook during job or job definition lifecycle.

Inputs are immutable: every time you create a schedule for an input file (job definition), jupyter scheduler server creates a snapshot of your input file and then runs it / creates jobs from the snapshot accordingly to the schedule. Therefore mutation of the original input notebook would not propagate, new job / job definition needs to be created based on the mutated notebook.
#504 (comment)

@andrii-i andrii-i added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant