NotebooksΒΆ
class datarobot.models.notebooks.enums.NotebookTypeΒΆ
Types of notebooks.
class datarobot.models.notebooks.enums.RunTypeΒΆ
Types of notebook job runs.
class datarobot.models.notebooks.enums.ManualRunTypeΒΆ
A subset of RunType
To be used in API schemas.
class datarobot.models.notebooks.enums.SessionTypeΒΆ
Types of notebook sessions. Triggered sessions include notebook job runs whether manually triggered or scheduled.
class datarobot.models.notebooks.enums.ScheduleStatusΒΆ
Possible statuses for notebook schedules.
class datarobot.models.notebooks.enums.ScheduledRunStatusΒΆ
Possible statuses for scheduled notebook runs.
class datarobot.models.notebooks.enums.NotebookPermissionsΒΆ
Permissions for notebooks.
class datarobot.models.notebooks.enums.NotebookStatusΒΆ
Possible statuses for notebook sessions.
class datarobot.models.notebooks.enums.KernelExecutionStatusΒΆ
Possible statuses for kernel execution.
class datarobot.models.notebooks.enums.CellTypeΒΆ
Types of cells in a notebook.
class datarobot.models.notebooks.enums.RuntimeLanguageΒΆ
Languages as used in notebook jupyter kernels.
class datarobot.models.notebooks.enums.ImageLanguageΒΆ
Languages as used and supported in notebook images.
class datarobot.models.notebooks.enums.KernelSpecΒΆ
Kernel specifications for Jupyter notebook kernels.
class datarobot.models.notebooks.enums.KernelStateΒΆ
Possible states for notebook kernels.
exception datarobot.models.notebooks.exceptions.KernelNotAssignedErrorΒΆ
Raised when a Codespace notebook does not have a kernel assigned.
class datarobot.models.notebooks.notebook.ManualRunPayloadΒΆ
class datarobot.models.notebooks.notebook.NotebookΒΆ
Metadata for a DataRobot Notebook accessible to the user.
- Variables:
- id (
str
) β The ID of the Notebook. - name (
str
) β The name of the Notebook. - type (
NotebookType
) β The type of the Notebook. Can be βplainβ or βcodespaceβ. - permissions (
List[NotebookPermissions]
) β The permissions the user has for the Notebook. - tags (
List[str]
) β Any tags that have been added to the Notebook. Default is an empty list. - created (
NotebookActivity
) β Information on when the Notebook was created and who created it. - updated (
NotebookActivity
) β Information on when the Notebook was updated and who updated it. - last_viewed (
NotebookActivity
) β Information on when the Notebook was last viewed and who viewed it. - settings (
NotebookSettings
) β Information on global settings applied to the Notebook. - org_id (
Optional[str]
) β The organization ID associated with the Notebook. - tenant_id (
Optional[str]
) β The tenant ID associated with the Notebook. - description (
Optional[str]
) β The description of the Notebook. Optional. - session (
Optional[NotebookSession]
) β Metadata on the current status of the Notebook and its kernel. Optional. - use_case_id (
Optional[str]
) β The ID of the Use Case the Notebook is associated with. Optional. - use_case_name (
Optional[str]
) β The name of the Use Case the Notebook is associated with. Optional. - has_schedule (
bool
) β Whether or not the notebook has a schedule. - has_enabled_schedule (
bool
) β Whether or not the notebook has a currently enabled schedule.
- id (
get_uri()ΒΆ
- Returns: url β Permanent static hyperlink to this Notebook in its Use Case or standalone.
- Return type:
str
classmethod get(notebook_id)ΒΆ
Retrieve a single notebook.
- Parameters:
notebook_id (
str
) β The ID of the notebook you want to retrieve. - Returns: notebook β The requested notebook.
- Return type:
Notebook
Examples
from datarobot.models.notebooks import Notebook
notebook = Notebook.get(notebook_id='6556b00dcc4ea0bb7ea48121')
create_revision(name=None, notebook_path=None, is_auto=False)ΒΆ
Create a new revision for the notebook.
- Parameters:
- name (
Optional[str]
) β The name of the revision. Optional. - notebook_path (
Optional[str]
) β The path of the notebook to execute within the codespace. Required if notebook is in a codespace. - is_auto (
bool
) β Indicates whether the revision was auto-saved versus a user interaction. Default is False.
- name (
- Returns: notebook_revision β Information about the created notebook revision.
- Return type:
NotebookRevision
download_revision(revision_id, file_path=None, filelike=None)ΒΆ
Downloads the notebook as a JSON (.ipynb) file for the specified revision.
- Parameters:
- file_path (
string
, optional) β The destination to write the file to. - filelike (
file
, optional) β A file-like object to write to. The object must be able to write bytes. The user is responsible for closing the object.
- file_path (
- Return type:
None
Examples
from datarobot.models.notebooks import Notebook
notebook = Notebook.get(notebook_id='6556b00dcc4ea0bb7ea48121')
manual_run = notebook.run_as_job()
revision_id = manual_run.wait_for_completion()
notebook.download_revision(revision_id=revision_id, file_path="./results.ipynb")
delete()ΒΆ
Delete a single notebook
:rtype: None
Examples
from datarobot.models.notebooks import Notebook
notebook = Notebook.get(notebook_id='6556b00dcc4ea0bb7ea48121')
notebook.delete()
classmethod list(created_before=None, created_after=None, order_by=None, tags=None, owners=None, query=None, use_cases=None)ΒΆ
List all Notebooks available to the user.
- Parameters:
- created_before (
Optional[str]
) β List Notebooks created before a certain date. Optional. - created_after (
Optional[str]
) β List Notebooks created after a certain date. Optional. - order_by (
Optional[str]
) β Property to sort returned Notebooks. Optional. Supported properties are βnameβ, βcreatedβ, βupdatedβ, βtagsβ, and βlastViewedβ. Prefix the attribute name with a dash to sort in descending order, e.g. order_by=β-createdβ. By default, the order_by parameter is None. - tags (
Optional[List[str]]
) β A list of tags that returned Notebooks should be associated with. Optional. - owners (
Optional[List[str]]
) β A list of user IDs used to filter returned Notebooks. The respective users share ownership of the Notebooks. Optional. - query (
Optional[str]
) β A specific regex query to use when filtering Notebooks. Optional. - use_cases (
Optional[UseCase
orList[UseCase]
orstr
orList[str]]
) β Filters returned Notebooks by a specific Use Case or Cases. Accepts either the entity or the ID. Optional. If set to [None], the method filters the notebookβs datasets by those not linked to a UseCase.
- created_before (
- Returns: notebooks β A list of Notebooks available to the user.
- Return type:
List[Notebook]
Examples
from datarobot.models.notebooks import Notebook
notebooks = Notebook.list()
is_running()ΒΆ
Check if the notebook session is currently running.
- Return type:
bool
get_session_status()ΒΆ
Get the status of the notebook session.
- Return type:
NotebookStatus
start_session(is_triggered_run=False, parameters=None, open_file_paths=None, clone_repository=None)ΒΆ
Start a new session for the notebook.
- Parameters:
- is_triggered_run (
bool
) β Whether the session being started is considered an βinteractiveβ or βtriggeredβ session. Default is False. - parameters (
Optional[List[StartSessionParameters]]
) β A list of dictionaries in the format {βnameβ: βFOOβ, βvalueβ: βmy_valueβ} representing environment variables propagated to the notebook session. - open_file_paths (
Optional[List[str]]
) β A list of file paths to open upon instantiation of the notebook session. - clone_repository (
Optional[CloneRepositorySchema]
) β Information used to clone a remote repository as part of the environment setup flow.
- is_triggered_run (
- Returns: notebook_session β The created notebook session.
- Return type:
NotebookSession
Examples
from datarobot.models.notebooks import Notebook
notebook = Notebook.get(notebook_id='6556b00dcc4ea0bb7ea48121')
session = notebook.start_session()
stop_session()ΒΆ
Stop the current session for the notebook.
- Returns: notebook_session β The stopped notebook session.
- Return type:
NotebookSession
Examples
from datarobot.models.notebooks import Notebook
notebook = Notebook.get(notebook_id='6556b00dcc4ea0bb7ea48121')
session = notebook.stop_session()
execute(notebook_path=None, cell_ids=None)ΒΆ
Execute the notebook. Assumes session is already started.
- Parameters:
- notebook_path (
Optional[str]
) β The path of the notebook to execute within the Codespace. Required if the notebook is in a Codespace. - cell_ids (
Optional[List[str]]
) β The list of cell IDs to execute for a notebook. Not supported if the notebook is in a Codespace. Optional. If not provided, the whole notebook will be executed.
- notebook_path (
- Return type:
None
get_execution_status()ΒΆ
Get the execution status information of the notebook.
- Returns: execution_status β The notebook execution status information.
- Return type:
NotebookExecutionStatus
is_finished_executing(notebook_path=None)ΒΆ
Check if the notebook is finished executing.
- Parameters:
notebook_path (
Optional[str]
) β The path of the notebook the Codespace. Required only if the notebook is in a Codespace. Will raise an error if working with a standalone notebook. - Returns: is_finished_executing β Whether or not the notebook has finished executing.
- Return type:
bool
- Raises:
- InvalidUsageError β If attempting to check if a standalone notebook has finished executing and incorrectly passing a notebook path. If attempting to check if a codespace notebook has finished executing without passing a notebook path.
- KernelNotAssignedError β If attempting to check if a codespace notebook has finished executing but the notebook does not have a kernel assigned.
run_as_job(title=None, notebook_path=None, parameters=None, manual_run_type=ManualRunType.MANUAL)ΒΆ
Create a manual scheduled job that runs the notebook.
Notes
The notebook must be part of a Use Case. If the notebook is in a Codespace then notebook_path is required.
- Parameters:
- title (
Optional[str]
) β The title of the background job. Optional. - notebook_path (
Optional[str]
) β The path of the notebook to execute within the Codespace. Required if notebook is in a Codespace. - parameters (
Optional[List[StartSessionParameters]]
) β A list of dictionaries in the format {βnameβ: βFOOβ, βvalueβ: βmy_valueβ} representing environment variables predefined in the notebook session. Optional. - manual_run_type (
Optional[ManualRunType]
) β The type of manual run being triggered. Defaults to βmanualβ as opposed to βpipelineβ.
- title (
- Returns: notebook_scheduled_job β The created notebook schedule job.
- Return type:
NotebookScheduledJob
- Raises: InvalidUsageError β If attempting to create a manual scheduled run for a Codespace without a notebook path.
Examples
from datarobot.models.notebooks import Notebook
notebook = Notebook.get(notebook_id='6556b00dcc4ea0bb7ea48121')
manual_run = notebook.run_as_job()
# Alternatively, with title and parameters:
# manual_run = notebook.run_as_job(title="My Run", parameters=[{"name": "FOO", "value": "bar"}])
revision_id = manual_run.wait_for_completion()
list_schedules(enabled_only=False)ΒΆ
List all NotebookScheduledJobs associated with the notebook.
- Parameters:
enabled_only (
bool
) β Whether or not to return only enabled schedules. - Returns: notebook_schedules β A list of schedules for the notebook.
- Return type:
List[NotebookScheduledJob]
- Raises: InvalidUsageError β If attempting to list schedules for a notebook not associated with a Use Case.
Examples
from datarobot.models.notebooks import Notebook
notebook = Notebook.get(notebook_id='6556b00dcc4ea0bb7ea48121')
enabled_schedules = notebook.list_schedules(enabled_only=True)
class datarobot.models.notebooks.execution_environment.ExecutionEnvironmentAssignPayloadΒΆ
Payload for assigning an execution environment to a notebook.
class datarobot.models.notebooks.execution_environment.ImageΒΆ
Execution environment image information.
- Variables:
- id (
str
) β The ID of the image. - name (
str
) β The name of the image. - default (
bool
) β Whether the image is the default image. - description (
str
) β The description of the image. - environment_id (
str
) β The ID of the environment. - gpu_optimized (
bool
) β Whether the image is GPU optimized. - language (
ImageLanguage
) β The runtime language of the image. For example βPythonβ or βRβ - language_version (
str
) β The version of the language. For example β3.11β or β4.3β - libraries (
list[str]
) β A list of pre-installed libraries on the image.
- id (
class datarobot.models.notebooks.execution_environment.MachineΒΆ
Execution environment machine information.
- Variables:
- id (
str
) β The ID of the machine. - name (
str
) β The name of the machine. Values include βXSβ, βSβ, βMβ, βLβ etc. - default (
bool
) β Whether the machine is the default machine. - cpu (
str
) β The CPU of the machine. For example a value like β2000mβ. - cpu_cores (
int
) β The number of CPU cores. - ephemeral_storage (
str
) β The ephemeral storage of the machine. For example a value like β15Giβ. - has_gpu (
bool
) β Whether the machine has a GPU. - memory (
str
) β The memory of the machine. For example a value like β8Giβ. - ram_gb (
int
) β The amount of RAM of the machine.
- id (
class datarobot.models.notebooks.execution_environment.ExecutionEnvironmentΒΆ
An execution environment associated with a notebook.
- Variables:
classmethod get(notebook_id)ΒΆ
Get a notebook execution environment by its notebook ID.
- Parameters:
notebook_id (
str
) β The ID of the notebook. - Returns: The notebook execution environment.
- Return type:
ExecutionEnvironment
classmethod assign_environment(notebook_id, payload)ΒΆ
Assign execution environment values to a notebook.
- Parameters:
- notebook_id (
str
) β The ID of the notebook. - payload (
ExecutionEnvironmentAssignPayload
) β The payload for the assignment/update.
- notebook_id (
- Returns: The assigned execution environment.
- Return type:
ExecutionEnvironment
Examples
from datarobot.models.notebooks import ExecutionEnvironment, ExecutionEnvironmentAssignPayload
payload = ExecutionEnvironmentAssignPayload(machine_slug='medium', time_to_live=10)
exec_env = ExecutionEnvironment.assign_environment('67914bfab0279fd832dc3fd1', payload)
class datarobot.models.notebooks.kernel.NotebookKernelΒΆ
A kernel associated with a codespace notebook.
- Variables:
- id (
str
) β The kernel ID. - name (
str
) β The kernel name. - language (
RuntimeLanguage
) β The kernel language. Supports Python and R. - running (
bool
) β Whether the kernel is running. - execution_state (
KernelState
) β The kernel execution state.
- id (
class datarobot.models.notebooks.revision.CreateRevisionPayloadΒΆ
Payload for creating a notebook revision.
class datarobot.models.notebooks.revision.NotebookRevisionΒΆ
Represents a notebook revision.
- Variables:
- revision_id (
str
) β The ID of the notebook revision. - notebook_id (
str
) β The ID of the notebook. - is_auto (
bool
) β Whether the revision was auto-saved.
- revision_id (
classmethod create(notebook_id, payload=None)ΒΆ
Create a new notebook revision.
- Parameters:
- notebook_id (
str
) β The ID of the notebook. - payload (
CreateRevisionPayload
) β The payload to create the revision.
- notebook_id (
- Returns: Information about the created notebook revision.
- Return type:
NotebookRevision
class datarobot.models.notebooks.scheduled_job.NotebookScheduledJobΒΆ
DataRobot Notebook Schedule. A scheduled job that runs a notebook.
- Variables:
- id (
str
) β The ID of the scheduled notebook job. - enabled (
bool
) β Whether job is enabled or not. - run_type (
RunType
) β The type of the run - either manual (triggered via UI or API) or scheduled. - notebook_type (
NotebookType
) β The type of the notebook - either plain or codespace. - job_payload (
ScheduledJobPayload
) β The payload used for the background job. - next_run_time (
Optional[str]
) β The next time the job is scheduled to run (assuming it is enabled). - title (
Optional[str]
) β The title of the job. Optional. - schedule (
Optional[str]
) β Cron-like string to define how frequently job should be run. Optional. - schedule_localized (
Optional[str]
) β A human-readable localized version of the schedule. Example in English is βAt 42 minutes past the hourβ. Optional. - last_successful_run (
Optional[str]
) β The last time the job was run successfully. Optional. - last_failed_run (
Optional[str]
) β The last time the job failed. Optional. - last_run_time (
Optional[str]
) β The last time the job was run (failed or successful). Optional.
- id (
classmethod get(use_case_id, scheduled_job_id)ΒΆ
Retrieve a single notebook schedule.
- Parameters:
scheduled_job_id (
str
) β The ID of the notebook schedule you want to retrieve. - Returns: notebook_schedule β The requested notebook schedule.
- Return type:
NotebookScheduledJob
Examples
from datarobot.models.notebooks import NotebookScheduledJob
notebook_schedule = NotebookScheduledJob.get(
use_case_id="654ad653c6c1e889e8eab12e",
scheduled_job_id="65734fe637157200e28bf688",
)
classmethod list(notebook_ids=None, statuses=None)ΒΆ
List all NotebookScheduledJobs available to the user.
- Parameters:
- notebook_ids (
Optional[List[str]]
) β Notebook IDs to filter listed schedules by. Optional. - statuses (
Optional[List[ScheduleStatus]]
) β Statuses to filter listed schedules by. Includes values βdisabledβ and βenabledβ. Optional.
- notebook_ids (
- Returns: notebook_schedules β A list of NotebookScheduledJobs available to the user.
- Return type:
List[NotebookScheduledJob]
cancel()ΒΆ
Cancel a running notebook schedule.
- Return type:
None
get_most_recent_run()ΒΆ
Retrieve the most recent run for the notebook schedule.
- Returns: notebook_scheduled_run β The most recent run for the notebook schedule, or None if no runs have been made.
- Return type:
Optional[NotebookScheduledRun]
Examples
from datarobot.models.notebooks import NotebookScheduledJob
notebook_schedule = NotebookScheduledJob.get(
use_case_id="654ad653c6c1e889e8eab12e",
scheduled_job_id="65734fe637157200e28bf688",
)
most_recent_run = notebook_schedule.get_most_recent_run()
get_job_history()ΒΆ
Retrieve list of historical runs for the notebook schedule. Gets the most recent runs first.
- Returns: notebook_scheduled_runs β The list of historical runs for the notebook schedule.
- Return type:
List[NotebookScheduledRun]
Examples
from datarobot.models.notebooks import NotebookScheduledJob
notebook_schedule = NotebookScheduledJob.get(
use_case_id="654ad653c6c1e889e8eab12e",
scheduled_job_id="65734fe637157200e28bf688",
)
notebook_scheduled_runs = notebook_schedule.get_job_history()
wait_for_completion(max_wait=600)ΒΆ
Wait for the completion of a scheduled notebook and return the revision ID corresponding to the runβs output.
- Parameters:
max_wait (
int
) β The number of seconds to wait before giving up. - Returns: revision_id β Returns either revision ID or message describing current state.
- Return type:
str
Examples
from datarobot.models.notebooks.notebook import Notebook
notebook = Notebook.get(notebook_id='6556b00dcc4ea0bb7ea48121')
manual_run = notebook.run_as_job()
revision_id = manual_run.wait_for_completion()
class datarobot.models.notebooks.scheduled_run.ScheduledJobParamΒΆ
DataRobot Schedule Job Parameter.
- Variables:
- name (
str
) β The name of the parameter. - value (
str
) β The value of the parameter.
- name (
class datarobot.models.notebooks.scheduled_run.ScheduledJobPayloadΒΆ
DataRobot Schedule Job Payload.
- Variables:
- uid (
str
) β The ID of the user who created the notebook schedule. - org_id (
str
) β The ID of the userβs organization who created the notebook schedule. - use_case_id (
str
) β The ID of the Use Case that the notebook belongs to. - notebook_id (
str
) β The ID of the notebook being run on a schedule. - notebook_name (
str
) β The name of the notebook being run on a schedule. - run_type (
RunType
) β The type of the run - either manual (triggered via UI or API) or scheduled. - notebook_type (
NotebookType
) β The type of the notebook - either plain or codespace. - parameters (
List[ScheduledJobParam]
) β The parameters being used in the notebook schedule. Can be an empty list. - notebook_path (
Optional[str]
) β The path of the notebook to execute within the codespace. Optional. Required if notebook is in a codespace. - use_case_name (
Optional[str]
) β The name of the Use Case that the notebook belongs to.
- uid (
class datarobot.models.notebooks.scheduled_run.ScheduledRunRevisionMetadataΒΆ
DataRobot Notebook Revision Metadata specifically for a scheduled run.
Both id and name can be null if for example the job is still running or has failed.
- Variables:
- id (
Optional[str]
) β The ID of the Notebook Revision. Optional. - name (
Optional[str]
) β The name of the Notebook Revision. Optional.
- id (
class datarobot.models.notebooks.scheduled_run.NotebookScheduledRunΒΆ
DataRobot Notebook Scheduled Run. A historical run of a notebook schedule.
- Variables:
- id (
str
) β The ID of the scheduled notebook job. - use_case_id (
str
) β The Use Case ID of the scheduled notebook job. - status (
str
) β The status of the run. - payload (
ScheduledJobPayload
) β The payload used for the background job. - title (
Optional[str]
) β The title of the job. Optional. - start_time (
Optional[str]
) β The start time of the job. Optional. - end_time (
Optional[str]
) β The end time of the job. Optional. - revision (
ScheduledRunRevisionMetadata
) β Notebook revision data - ID and name. - duration (
Optional[int]
) β The job duration in seconds. May be None for example while the job is running. Optional. - run_type (
Optional[RunType]
) β The type of the run - either manual (triggered via UI or API) or scheduled. Optional. - notebook_type (
Optional[NotebookType]
) β The type of the notebook - either plain or codespace. Optional.
- id (
class datarobot.models.notebooks.session.CloneRepositorySchemaΒΆ
Schema for cloning a repository when starting a notebook session.
class datarobot.models.notebooks.session.StartSessionParametersΒΆ
Parameters used as environment variables in a notebook session.
class datarobot.models.notebooks.session.StartSessionPayloadΒΆ
Payload for starting a notebook session.
class datarobot.models.notebooks.session.NotebookExecutionStatusΒΆ
Notebook execution status information.
- Variables:
- status (
str
) β The status of the notebook execution. - cell_id (
Optional[bson.ObjectId]
) β The ID of the cell being executed. Optional. - queued_cell_ids (
Optional[List[bson.ObjectId]]
) β The list of cell IDs that are queued for execution. Optional.
- status (
class datarobot.models.notebooks.session.CodespaceNotebookCellΒΆ
Represents a cell in a codespace notebook.
class datarobot.models.notebooks.session.CodespaceNotebookStateΒΆ
Notebook state information for a codespace notebook.
- Variables:
- name (
str
) β The name of the notebook. - path (
str
) β The path of the notebook. - generation (
int
) β The generation of the notebook. - nbformat (
int
) β The notebook format version. - nbformat_minor (
int
) β The notebook format minor version. - metadata (
dict
) β The metadata of the notebook. - cells (
List[CodespaceNotebookCell]
) β The list of cells in the notebook. - kernel_id (
Optional[str]
) β The ID of the kernel. Optional.
- name (
class datarobot.models.notebooks.session.NotebookSessionΒΆ
Notebook session information.
- Variables:
- status (
NotebookStatus
) β The current status of the notebook kernel. - notebook_id (
str
) β The ID of the notebook. - session_id (
str
) β The ID of the session. Incorporates thenotebook_id
as part of this ID. - started_at (
Optional[str]
) β The date and time when the notebook was started. Optional. - session_type (
Optional[SessionType]
) β The type of the run - either manual (triggered via UI or API) or scheduled. Optional. - ephemeral_session_key (
Optional[str]
) β The ID specific to ephemeral session if being used. Optional.
- status (
classmethod get(notebook_id)ΒΆ
Get a notebook session by its notebook ID.
- Parameters:
notebook_id (
str
) β The ID of the notebook. - Returns: The notebook session information.
- Return type:
NotebookSession
classmethod start(notebook_id, payload)ΒΆ
Start a notebook session.
- Parameters:
- notebook_id (
str
) β The ID of the notebook. - payload (
StartSessionPayload
) β The payload to start the session.
- notebook_id (
- Returns: The notebook session information.
- Return type:
NotebookSession
classmethod stop(notebook_id)ΒΆ
Stop a notebook session.
- Parameters:
notebook_id (
str
) β The ID of the notebook. - Returns: The notebook session information.
- Return type:
NotebookSession
classmethod execute_notebook(notebook_id, cell_ids=None)ΒΆ
Execute a notebook.
- Parameters:
- notebook_id (
str
) β The ID of the notebook. - cell_ids (
Optional[List[bson.ObjectId]]
) β The list of cell IDs to execute. Optional. If not provided, the whole notebook will be executed.
- notebook_id (
- Return type:
None
classmethod execute_codespace_notebook(notebook_id, notebook_path, generation, cells)ΒΆ
Execute a notebook.
- Parameters:
- notebook_id (
str
) β The ID of the notebook. - notebook_path (
str
) β The path of the notebook. - generation (
int
) β The generation of the notebook. - cells (
List[CodespaceNotebookCell]
) β The list of cells to execute.
- notebook_id (
- Return type:
None
classmethod get_execution_status(notebook_id)ΒΆ
Get the execution status information of a notebook.
- Parameters:
notebook_id (
str
) β The ID of the notebook. - Returns: The execution status information of the notebook.
- Return type:
NotebookExecutionStatus
class datarobot.models.notebooks.settings.NotebookSettingsΒΆ
Settings for a DataRobot Notebook.
- Variables:
- show_line_numbers (
bool
) β Whether line numbers in cells should be displayed. - hide_cell_titles (
bool
) β Whether cell titles should be displayed. - hide_cell_outputs (
bool
) β Whether the cell outputs should be displayed. - show_scrollers (
bool
) β Whether scroll bars should be shown on cells. - hide_cell_footers (
bool
) β Whether footers should be shown on cells. - highlight_whitespace (
bool
) β Whether whitespace should be highlighted or not.
- show_line_numbers (
class datarobot.models.notebooks.user.NotebookUserΒΆ
A user associated with a Notebook.
- Variables:
- id (
str
) β The ID of the user. - activated (
bool
) β Whether or not the user is enabled. - username (
str
) β The username of the user, usually their email address. - first_name (
str
) β The first name of the user. - last_name (
str
) β The last name of the user. - gravatar_hash (
Optional[str]
) β The gravatar hash of the user. Optional. - tenant_phase (
Optional[str]
) β The phase that the userβs tenant is in. Optional.
- id (
class datarobot.models.notebooks.user.NotebookActivityΒΆ
A record of activity (i.e. last run, updated, etc.) in a Notebook.
- Variables:
- at (
str
) β The time of the activity in the notebook. - by (
NotebookUser
) β The user who performed the activity.
- at (