Skip to content

Commit 4b7180d

Browse files
author
Uemit Yoldas
committed
documentation: add docstring for amtviz module
1 parent 4aba04a commit 4b7180d

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

src/sagemaker/amtviz/__init__.py

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,16 @@
1010
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
1111
# ANY KIND, either express or implied. See the License for the specific
1212
# language governing permissions and limitations under the License.
13-
"""Placeholder docstring"""
13+
"""Amazon SageMaker Automatic Model Tuning Visualization module.
14+
15+
This module provides visualization capabilities for SageMaker hyperparameter tuning jobs.
16+
It enables users to create interactive visualizations to analyze and understand the
17+
performance of hyperparameter optimization experiments.
18+
19+
Example:
20+
>>> from sagemaker.amtviz import visualize_tuning_job
21+
>>> visualize_tuning_job('my-tuning-job')
22+
"""
1423
from __future__ import absolute_import
1524

1625
from sagemaker.amtviz.visualization import visualize_tuning_job

0 commit comments

Comments
 (0)