Skip to content

notebook.md

Latest commit

 

History

History
65 lines (43 loc) · 1.4 KB

notebook.md

File metadata and controls

65 lines (43 loc) · 1.4 KB

Dataform Javascript API Reference › Globals › "core/actions/notebook" › Notebook

Class: Notebook

Notebooks run Jupyter Notebook files, and can output content to the storage buckets defined in workflow_settings.yaml files.

You can create notebooks in the following ways. Available config options are defined in NotebookConfig, and are shared across all the following ways of creating notebooks.

Using action configs files:

# definitions/actions.yaml
actions:
- notebook:
  filename: name.ipynb
# definitions/name.ipynb
{ "cells": [] }

Using the Javascript API:

// definitions/file.js
notebook("name", { filename: "name.ipynb" })
# definitions/name.ipynb
{ "cells": [] }

Hierarchy

  • ActionBuilder‹Notebook›

    ↳ Notebook

Index

Methods

Methods

ipynb

▸ ipynb(contents: object): Notebook

Sets or overrides the contents of the notebook to run. Not recommended in general; using separate .ipynb files for notebooks is preferred.

Parameters:

Name Type
contents object

Returns: Notebook