Notebook instance management
This documentation provides instructions for configuring and starting a notebook instance for running Jupyter notebooks with Wherobots Cloud.
Start a Wherobots Notebook¶
Quick Start¶
With Wherobots Cloud, you can start a pre-configured JupyterLab instance with a single click. This will create a spatial computing environment to develop your spatial analytics and AI workflows.
Configuring your Notebook Instance¶
Runtime Size¶
The runtime size determines the resources allocated to the notebook instance. Community users can only use the Sedona (tiny) runtime size. To switch the runtime size, click on the Runtime Size dropdown and select the desired size.
Environment Presets¶
Note
Configurations present in Environment Presets are subject to change. Configurations may be added or removed as the product evolves.
Environment Presets allow you to customize infrequently changed configurations for your notebook instance. These currently include:
- Wherobots version
- Whether Wherobots AI is on or off by default
- Spark configuration
- Dependencies
You can access the Environment Presets by clicking on the environment configuration button.
To customize Environment Presets, create a custom preset by pressing on the plus button in the top right corner.
Change Wherobots Version¶
You can customize the Wherobots version for your notebook instance. The default Wherobots version is the latest version.
Change Wherobots AI Default State¶
You can customize whether Wherobots AI is on or off by default for your notebook instance. The default state is off for CPU runtimes and on for GPU runtimes.
Change Spark Configuration¶
Add any custom spark configurations you want before starting the notebook instance. The expected input is a valid JSON, the example configuration is for accessing a public S3 bucket.
{
"spark.hadoop.fs.s3a.bucket.<YOUR_BUCKET_NAME>.aws.credentials.provider" : "org.apache.hadoop.fs.s3a.AnonymousAWSCredentialsProvider"
}
Adding Dependencies¶
We support both file and PYPI as sources for dependencies inside Wherobots Notebooks. Below you will find the directions for adding dependencies from each source.
Adding Dependencies from a File¶
Wherobots Cloud allows you to add dependencies from the Wherobots Filesystem.
Note
Only Python Wheel (.whl), .jar, and .zip files are supported.
Reference
Please refer to storage layer management page to upload the files in the correct directory.
Click "Browse" and select the file from the Wherobots File Browser. The selected file must have a valid file extension (.whl, .jar, or .zip).
PYPI Source¶
You can add dependencies from the PYPI source by providing the library name and version.
When the notebook instance starts, it will fetch and install listed packages from PYPI.
Environment Override Presets¶
Note
Configurations present in Environment Override Presets are subject to change. Configurations may be added or removed as the product evolves.
Environment Overrides allow you to customize the most commonly updated values for your notebook instance. These currently include:
- Driver disk size
- Executor disk size
- Spark configuration
You can access the Environment Overrides by clicking on the environment configuration button.
To customize Environment Overrides, create a custom preset by pressing on the plus button in the top right corner.
Change Disk Size¶
You can customize the default disk size for your notebook instance. The default disk size for driver and executor nodes is based on the runtime size and is listed below:
| Runtime Size | Disk Size |
|---|---|
| Sedona (tiny) | 20 GB |
| All others | 200 GB |
Spark Configuration¶
Refer to the Spark configuration section in the Environment Presets for more information.
Jupyter notebook environment¶
Once your notebook instance is running, press "Open" in the top right corner of the Current Notebook section to open the Jupyter notebook environment.
Reference
Please refer to Jupyter notebook management for an overview of how to manage Jupyter notebooks. The Jupyter notebook management documentation provides guidance on working with notebooks, including how to run code cells. Reviewing the notebook management guide is recommended before starting to use your notebook instance.
Deleting notebook instance¶
Once you have finished using the notebook instance, you can click the "Destroy" button in the top right of the Current Notebook section to free up resources.
This will shut down the notebook instance and release the resources it was using. It is recommended that you destroy notebook instances when they are no longer needed.
Note
Community users can expect notebook instances to automatically shut down after 2 hours of continuous use. Community users will need to restart the notebook instance if additional time is required beyond the 2 hour limit.
Troubleshooting¶
Notebook stuck in STARTING status¶
The notebook instance will usually start within 5 minutes of clicking Start. If you observe the notebook stuck in STARTING status, you can try to destroy and re-create the notebook instance. If the problem persists, please contact Wherobots support.