Skip to content

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

@andrii-i

Description

@andrii-i

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)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions