0 / 0
Creating notebooks

Creating notebooks

You can add a notebook to your project by using one of these methods: creating a notebook file, copying a sample notebook from the Gallery, or adding a notebook from a catalog.  

Required permissions
You must have the Admin or Editor role in the project to create a notebook.

Watch this short video to learn the basics of Jupyter notebooks.

This video provides a visual method to learn the concepts and tasks in this documentation.

  • Video transcript
    Time Transcript
    00:00 This video covers the basics for working with Jupyter notebooks using Watson Studio.
    00:07 Start in a Watson Studio project and add to the project a notebook.
    00:12 Just provide a name and a description and a Python runtime environment to use, then create the notebook.
    00:22 Let's first load a file, so you have some data to work with.
    00:28 Just drag and drop a file into the "Files" slide-out panel.
    00:32 After the file is added to the project, it's available to work with in this notebook.
    00:38 Just click "Insert to code" and insert a pandas DataFrame.
    00:43 Before running the notebook, it's a best practice to insert a cell at the top to describe what the notebook does.
    00:51 Change the cell type to Markdown so this cell will not be treated as code, and then add the description.
    00:59 Now, you're ready to run the notebook.
    01:02 The inserted code loads the data set into a DataFrame, using your credentials for your Cloud Object Storage instance, and then displays the first five rows of the data set.
    01:13 Before returning to the project, save the notebook.
    01:20 On the "Assets" tab, you'll find the notebook.
    01:24 If you open the notebook, it will be in read-only mode.
    01:28 But you can edit the notebook and make changes.
    01:34 For example, you can access the "Information" panel and change the name of the notebook.
    01:41 And on the "Environment" tab, you can change the environment used to run the notebook, as well as stop or restart the runtime environment.
    01:53 If you'd like to share a read-only version of the notebook, you can do that from here.
    01:58 You can select how much of the content you'd like to share and how you want to share the notebook: either through a link or social media.
    02:08 If you'd like to schedule the notebook to run at a different time, you can create a job.
    02:14 Just provide a name for the job and select the notebook version and runtime.
    02:24 Then, select the scheduling options, like: specifying a date for the job to run and whether you'd like the job run to repeat.
    02:43 After you create and run the job, you'll see the status and the job will display on the "Jobs" tab in the project.
    02:55 Find more videos in the Cloud Pak for Data as a Service documentation.

Creating a notebook file in the notebook editor

To create a notebook file in the notebook editor:

  1. From your project, click New asset > Jupyter notebook editor.

  2. On the New Notebook page, specify the method to use to create your notebook. You can create a blank notebook, upload a notebook file from your file system, or upload a notebook file from a URL:

    • The notebook file you select to upload must follow these requirements:
      • The file type must be .ipynb.
      • The file name must not exceed 255 characters.
      • The file name must not contain these characters: < > : ” / | ( ) ?
    • The URL must be a public URL that is shareable and doesn't require authentication.
      Notebook options
  3. Specify the runtime environment for the language you want to use (Python or R). You can select a provided environment template or an environment template which you created and configured under Templates on the Environments page on the Manage tab of your project. For more information on environments, see Notebook environments.

  4. Click Create Notebook. The notebook opens in edit mode.

    Note that the time that it takes to create a new notebook or to open an existing one for editing might vary. If no runtime container is available, a container needs to be created and only after it is available, the Jupyter notebook user interface can be loaded. The time it takes to create a container depends on the cluster load and size. Once a runtime container exists, subsequent calls to open notebooks will be significantly faster.

    The opened notebook is locked by you. For more information, see Locking and unlocking notebooks.

  5. Tell the service to trust your notebook content and execute all cells.

    When a new notebook is opened in edit mode, the notebook is considered to be untrusted by the Jupyter service by default. When you run an untrusted notebook, content deemed untrusted will not be executed. Untrusted content includes any Javascript, HTML or Javascript in Markdown cells or in any output cells that you did not generate.

    1. Click Not Trusted in the upper right corner of the notebook.
    2. Click Trust to execute all cells.

Adding a notebook from the Gallery

Notebooks from the Gallery are based on real-world scenarios and contain many useful examples of computations and visualizations that you can adapt to your analysis needs.

To copy a sample notebook:

  1. In the main menu, click Gallery, then filter for Notebooks to show only notebook cards.
  2. Find the card for the sample notebook you want, and click the card. You can view the notebook contents to browse the steps and the code that it contains.
  3. To work with a copy of the sample notebook, click Add to project.
  4. Choose the project for the notebook, and click Add.
  5. Optional: Change the name and description for the notebook.
  6. Specify the runtime environment. If you created an environment template on the Environments page of your project, it will display in the list of runtimes you can select from.
  7. Click Create. The notebook opens in edit mode and is locked by you. Locking the file avoids possible merge conflicts that might be caused by competing changes to the file. To get familiar with the structure of a notebook, see Parts of a notebook.

Locking and unlocking notebooks

If you open a notebook in edit mode, this notebook is locked by you. While you hold the lock, only you can make changes to the notebook. All other projects users will see the lock icon on the notebook. Only project administrators are able to unlock a locked notebook and open it in edit mode.

When you close the notebook, the lock is released and another user can select to open the notebook in edit mode. Note that you must close the notebook while the runtime environment is still active. The notebook lock can't be released for you if the runtime was stopped or is in idle state. If the notebook lock is not released for you, you can unlock the notebook from the project's Assets page. Locking the file avoids possible merge conflicts that might be caused by competing changes to the file.

Finding your notebooks

You can find and open notebooks from the Assets page of the project.

You can open a notebook in view or edit mode. When you open a notebook in view mode, you can't change or run the notebook. You can only change or run a notebook when it is opened in edit mode and started in an environment.

You can open a notebook by:

  • Clicking the notebook. This opens the notebook in view mode. To then open the notebook in edit mode, click the pencil icon (Edit icon) on the notebook toolbar. This starts the environment associated with the notebook.
  • Expanding the three vertical dots on the right of the notebook entry, and selecting View or Edit.

Next step

Learn more

Find videos showing how to run a sample notebook from the Gallery on the Videos page.

Parent topic: Jupyter Notebook editor

Generative AI search and answer
These answers are generated by a large language model in watsonx.ai based on content from the product documentation. Learn more