aws / aws/sagemaker-python-sdk

[Bug] V3 Hyperparameter Tuning Pipeline page labelled "Download Data" in navigation due to missing title cell

未关闭 适合新手
#6,232 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Python
星标
2.3k
派生
1.3k
平均合并
1 天 22 小时
30 天内合并 PR
35

描述

**PySDK Version**
- [ ] PySDK V2 (2.x)
- [ x] PySDK V3 (3.x)

**Describe the bug**
The [V3 Hyperparameter Tuning Pipeline example](https://sagemaker.readthedocs.io/en/stable/v3-examples/ml-ops-examples/v3-hyperparameter-tuning-example/v3-hyperparameter-tuning-pipeline.html) notebook is missing a title markdown cell. The notebook's first cell is a code cell (imports), so the first markdown heading `### Download Data`is picked up as the page label in the readthedocs navigation sidebar, causing the page to appear as "Download Data" rather than "V3 Hyperparameter Tuning Pipeline".

**To reproduce**
1. Navigate to the [readthedocs page](https://sagemaker.readthedocs.io/en/stable/v3-examples/ml-ops-examples/v3-hyperparameter-tuning-example/v3-hyperparameter-tuning-pipeline.html)
2. Observe the sidebar navigation label for this page

**Expected behavior**
The page should be labelled "V3 Hyperparameter Tuning Pipeline" (or similar) in the navigation sidebar, not "Download Data".

**Screenshots or logs**
Image

**System information**
A description of your system. Please provide:
- **SageMaker Python SDK version**:
- **Framework name (eg. PyTorch) or algorithm (eg. KMeans)**:
- **Framework version**:
- **Python version**:
- **CPU or GPU**:
- **Custom Docker image (Y/N)**:

**Additional context**
Fix: add a title markdown cell as the first cell in doc/source/v3-examples/ml-ops-examples/v3-hyperparameter-tuning-example/v3-hyperparameter-tuning-pipeline.ipynb:

```
{
"cell_type": "markdown",
"id": "intro",
"metadata": {},
"source": ["# V3 Hyperparameter Tuning Pipeline"]
}
```

贡献指南

打开贡献指南

调研方向

打开 doc/source/v3-examples/ml-ops-examples/v3-hyperparameter-tuning-example/v3-hyperparameter-tuning-pipeline.ipynb,检查其第一个单元格和渲染后的 Read the Docs 页面。添加缺失的介绍性标题单元格,使页面标记为“V3 Hyperparameter Tuning Pipeline”而不是“Download Data”,然后验证 notebook 是否使用修正后的导航标签进行渲染。

由索引模型根据 Issue 内容生成。

评估

技术栈
jupyter-notebook, python
领域
documentation
Issue 类型
缺陷
难度
1/5
预计耗时
1 小时以内
活跃度
活跃
描述清晰度
描述清楚
新手友好度
93/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。