aws / aws/sagemaker-python-sdk
[Bug] V3 Hyperparameter Tuning Pipeline page labelled "Download Data" in navigation due to missing title cell
- Vorherrschende Sprache
- Python
- Sterne
- 2.3k
- Forks
- 1.3k
- Ø Merge
- 1 T. 22 Std.
- Gemergte PRs (30 T.)
- 35
Beschreibung
**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**
**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"]
}
```
Beitragsleitfaden
Rechercherichtung
Öffne doc/source/v3-examples/ml-ops-examples/v3-hyperparameter-tuning-example/v3-hyperparameter-tuning-pipeline.ipynb und prüfe die erste Zelle sowie die gerenderte Read the Docs-Seite. Füge die fehlende einleitende Titelzelle hinzu, damit die Seite mit „V3 Hyperparameter Tuning Pipeline“ statt „Download Data“ beschriftet ist, und überprüfe anschließend, dass das Notebook mit dem korrigierten Navigationslabel gerendert wird.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- jupyter-notebook, python
- Bereich
- documentation
- Issue-Typ
- Bug
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- Unter einer Stunde
- Aktivitätsstatus
- Aktiv
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 93/100