Skip to content

On-premise users: click in-app to access the full platform documentation for your version of DataRobot.

Convert notebooks to codespaces

Availability information

Standalone notebook to codespace conversion is on by default.

Feature flag: Enable Standalone Notebook to Codespace Conversion

After creating a standalone notebook, you may want to incorporate additional workflow capabilities such as persistent file storage or Git compatibility. These types of features require a codespace. DataRobot allows you to convert standalone notebooks into codespaces.

Before converting a standalone notebook to a codespace, review how the settings and related artifacts of the notebook asset are handled during conversion:

Notebook asset Conversion behavior
Environment settings The resource type, environment, and inactivity timeout settings are preserved in the new codespace.
Notebook contents The cells of the notebook are converted to an .ipynb file with the same name, populating at the root of the new codespace file system.
Environment variables Any configured environment variables are preserved and persistent in the codespace.
Job definitions Any scheduled job definitions for the standalone notebook will be preserved as scheduled jobs for the new codespace. All run history records for previous jobs of the notebook will be preserved and will continue to be accessible from the “Run history” sub-tab of the use case Notebooks tab. The “Source” field of each run record will be updated to represent the newly converted codespace metadata. The notebook snapshot tied to each run record will be preserved as well, and can be accessed by clicking on the corresponding row in the Run History table.
Run history The built-in revision history (accessible from the “Revision history” side panel) for the standalone notebook will not be preserved (with the exception of any revisions that are tied to run history records for previous notebook jobs). If there are any revisions you would like to keep, download them first from the Revision history side panel before initiating conversion. For codespaces, version control is recommended by versioning with external Git repos.

Workbench notebook conversion

To convert a standalone notebook in Workbench into a codespace, access and open the notebook you want to convert in Workbench.

From the actions menu in the notebook interface, select Convert to codespace. Note that you can only convert a standalone notebook to a codespace if the notebook is not currently being run in an active session. Shut down the session before proceeding to initiate conversion.

Review the dialog box that informs you of how the notebook's assets are treated during conversion. Then click Convert.

Once the conversion is complete, start the codespace session.

The notebook content is now available as an .ipynb file at the root of the codespace file system.

DataRobot classic notebook conversion

You can also convert a notebook from DataRobot Classic to a codespace. Since codespaces are only available in Workbench, when you initiate conversion you will also need to specify a Use Case that the converted codespace will belong to. Once the notebook is converted, it will no longer be accessible in Classic.

From the actions menu in the notebook interface, select Convert to codespace. Note that you can only convert a standalone notebook to a codespace if the notebook is not currently being run in an active session. Shut down the session before proceeding to initiate conversion.

In the dialog box, select the Use Case that the codespace will belong to. Additionally, you can review how the notebook's assets are treated during conversion. Then click Convert.

Once the conversion is complete, start the codespace session.

The notebook content is now available as an .ipynb file at the root of the codespace file system.


Updated June 26, 2024