Jupyter Environments

You can also use omni-fig in an interactive programming environment such as Jupyter or IPython. This is useful for quickly prototyping and debugging scripts. First, to load a project, use the fig.initialize() function. Once the project is initialized you can create a config with any of the registered configs using fig.create_config(). Additionally, you can run any registered scripts with fig.run_script(), or fig.run() if the script is already specified in the config.

Remember that when running a script, the first positional argument is the config, however you can manually include additional positional keyword arguments which are passed to the script as well. Alternatively, for additional convenience, you can use the fig.quick_run() function to create a config object and run a script in one line.

See the feature slide B3.