aiscalator.jupyter package

Submodules

aiscalator.jupyter.command module

Implementations of commands for Jupyter

aiscalator.jupyter.command.jupyter_edit(conf: aiscalator.core.config.AiscalatorConfig, param=None, param_raw=None)

Starts a Jupyter Lab environment configured to edit the focused step

Parameters

• conf (AiscalatorConfig) – Configuration object for the step

• param (list) – list of tuples of parameters

• param_raw (list) – list of tuples of raw parameters

Returns

string – Url of the running jupyter lab

aiscalator.jupyter.command.jupyter_new(name, path, output_format='hocon')

Starts a Jupyter Lab environment configured to edit a brand new step

Parameters

• name (str) – name of the new step

• path (str) – path to where the new step files should be created

• output_format (str) – the format of the new configuration file to produce

Returns

string – Url of the running jupyter lab

aiscalator.jupyter.command.jupyter_run(conf: aiscalator.core.config.AiscalatorConfig, prepare_only=False, param=None, param_raw=None)

Executes the step in browserless mode using papermill

Parameters

• conf (AiscalatorConfig) – Configuration object for the step

• prepare_only (bool) – Indicates if papermill should replace the parameters of the notebook only or it should execute all the cells too

Returns

string – the path to the output notebook resulting from the execution of this step

aiscalator.jupyter.cli module

CLI module for Jupyter related commands.

aiscalator.jupyter.cli.prompt_edit(file)

When creating a new step, if it is already defined, ask to edit instead

Parameters

file (str) – existing configuration file

aiscalator.jupyter.cli.run_auto_update()

Checks and tries to update Aiscalator itself from Pypi if necessary

aiscalator.jupyter.cli.update_aiscalator()

Create and run Thread to execute auto update in the background

Module contents