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

Open Beginner friendly
#6,232 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
93/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
jupyter-notebook, python
Domain
documentation

Research direction

Open doc/source/v3-examples/ml-ops-examples/v3-hyperparameter-tuning-example/v3-hyperparameter-tuning-pipeline.ipynb and inspect its first cell and the rendered Read the Docs page. Add the missing introductory title cell so the page is labelled “V3 Hyperparameter Tuning Pipeline” rather than “Download Data,” then verify the notebook renders with the corrected navigation label.

Written by the indexing model from the issue text.

Description

PySDK Version

  • PySDK V2 (2.x)
  • [ x] PySDK V3 (3.x)

Describe the bug
The V3 Hyperparameter Tuning Pipeline example notebook is missing a title markdown cell. The notebook's first cell is a code cell (imports), so the first markdown heading ### Download Datais 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
  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"]
}
Dominant language
Python
Stars
2.3k
Forks
1.3k
Avg merge
3d 9h
Merged PRs (30d)
42

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from aws/sagemaker-python-sdk

All issues in aws/sagemaker-python-sdk

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.