Skip to content

Commit 46a0a1a

Browse files
stacichobenieric
authored andcommitted
documentation: NotebookJobSteps class parameter severity update (#1298)
1 parent 0db3ae6 commit 46a0a1a

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

src/sagemaker/workflow/notebook_job_step.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,9 +102,12 @@ def __init__(
102102
"""Constructs a `NotebookJobStep`.
103103
104104
Args:
105-
name (str): The name of the `NotebookJobStep`.
106-
display_name (str): The display name of the `NotebookJobStep`.
107-
description (str): The description of the `NotebookJobStep`.
105+
name (Optional[str]): The name of the `NotebookJobStep`. If not provided,
106+
it is derived from the notebook file name.
107+
display_name (Optional[str]): The display name of the `NotebookJobStep`.
108+
Default is ``None``.
109+
description (Optional[str]): The description of the `NotebookJobStep`.
110+
Default is ``None``.
108111
109112
notebook_job_name (Optional[str]): An optional user-specified descriptive name
110113
for the notebook job. If provided, the sanitized notebook job name

0 commit comments

Comments
 (0)