From 59f137d0b4b7900c03211d052b8a6d5744dd0305 Mon Sep 17 00:00:00 2001 From: Molly He Date: Wed, 8 Apr 2026 12:04:40 -0700 Subject: [PATCH 1/3] Update v3 readthedocs to autorender all submodules --- .gitignore | 1 + docs/api/sagemaker_core.rst | 58 +++--------------------------------- docs/api/sagemaker_mlops.rst | 37 +++-------------------- docs/api/sagemaker_serve.rst | 12 +++----- docs/api/sagemaker_train.rst | 30 ++++--------------- docs/conf.py | 20 ++++++++++++- 6 files changed, 37 insertions(+), 121 deletions(-) diff --git a/.gitignore b/.gitignore index f87727e33e..57ed7da807 100644 --- a/.gitignore +++ b/.gitignore @@ -41,3 +41,4 @@ sagemaker_train/src/**/container_drivers/sm_train.sh sagemaker_train/src/**/container_drivers/sourcecode.json sagemaker_train/src/**/container_drivers/distributed.json .kiro +docs/api/generated/ diff --git a/docs/api/sagemaker_core.rst b/docs/api/sagemaker_core.rst index bbad9631ab..69ddca7165 100644 --- a/docs/api/sagemaker_core.rst +++ b/docs/api/sagemaker_core.rst @@ -3,58 +3,8 @@ SageMaker Core Core SageMaker resources and utilities for managing AWS SageMaker services. -.. currentmodule:: sagemaker.core +.. autosummary:: + :toctree: generated/ + :recursive: -Core Resources --------------- - -.. automodule:: sagemaker.core.resources - :members: - :undoc-members: - :show-inheritance: - -Session Management ------------------- - -.. automodule:: sagemaker.core.session_settings - :members: - :undoc-members: - -Configuration -------------- - -.. automodule:: sagemaker.core.config_schema - :members: - :undoc-members: - -Processing ----------- - -.. automodule:: sagemaker.core.processing - :members: - :undoc-members: - -Transformers ------------- - -.. automodule:: sagemaker.core.transformer - :members: - :undoc-members: - -Utilities ---------- - -.. automodule:: sagemaker.core.common_utils - :members: - :undoc-members: - -.. automodule:: sagemaker.core.image_uris - :members: - :undoc-members: - -Exceptions ----------- - -.. automodule:: sagemaker.core.exceptions - :members: - :undoc-members: + sagemaker.core diff --git a/docs/api/sagemaker_mlops.rst b/docs/api/sagemaker_mlops.rst index b9aa069c7d..d53591e069 100644 --- a/docs/api/sagemaker_mlops.rst +++ b/docs/api/sagemaker_mlops.rst @@ -3,37 +3,8 @@ SageMaker MLOps MLOps capabilities including pipelines, workflows, and model management. -.. currentmodule:: sagemaker.mlops +.. autosummary:: + :toctree: generated/ + :recursive: -Pipeline Management -------------------- - -.. automodule:: sagemaker.mlops - :members: - :undoc-members: - :show-inheritance: - -Workflow Management -------------------- - -.. automodule:: sagemaker.mlops.workflow - :members: - :undoc-members: - :show-inheritance: - -Local Development ------------------ - -.. automodule:: sagemaker.mlops.local - :members: - :undoc-members: - :show-inheritance: - - -Feature Store -------------- - -.. automodule:: sagemaker.mlops.feature_store - :members: - :undoc-members: - :show-inheritance: \ No newline at end of file + sagemaker.mlops diff --git a/docs/api/sagemaker_serve.rst b/docs/api/sagemaker_serve.rst index 471b79530b..bdd5e43ea1 100644 --- a/docs/api/sagemaker_serve.rst +++ b/docs/api/sagemaker_serve.rst @@ -3,12 +3,8 @@ SageMaker Serve Model serving and inference capabilities for deploying and managing ML models. -.. currentmodule:: sagemaker.serve +.. autosummary:: + :toctree: generated/ + :recursive: -Model Deployment ----------------- - -.. automodule:: sagemaker.serve - :members: - :undoc-members: - :show-inheritance: + sagemaker.serve diff --git a/docs/api/sagemaker_train.rst b/docs/api/sagemaker_train.rst index d54b720a92..cada8065b5 100644 --- a/docs/api/sagemaker_train.rst +++ b/docs/api/sagemaker_train.rst @@ -1,30 +1,10 @@ SageMaker Train =============== -Training capabilities including model training, hyperparameter tuning, and distributed training. +Training capabilities including model training, fine-tuning, hyperparameter tuning, and distributed training. -.. currentmodule:: sagemaker.train +.. autosummary:: + :toctree: generated/ + :recursive: -Model Training --------------- - -.. automodule:: sagemaker.train - :members: - :undoc-members: - :show-inheritance: - -Distributed Training --------------------- - -.. automodule:: sagemaker.train.distributed - :members: - :undoc-members: - :show-inheritance: - -Model Evaluation ----------------- - -.. automodule:: sagemaker.train.evaluate - :members: - :undoc-members: - :show-inheritance: + sagemaker.train diff --git a/docs/conf.py b/docs/conf.py index d9e282694f..d201502ca7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -39,6 +39,7 @@ suppress_warnings = [ 'myst.header', # Suppress header level warnings from notebooks 'toc.not_readable', # Suppress toctree warnings for symlinked files + 'ref.python', # Suppress "more than one target found" for duplicate class names across modules ] html_theme = 'sphinx_book_theme' @@ -76,11 +77,28 @@ 'members': True, 'undoc-members': True, 'show-inheritance': True, + 'private-members': False, } -# Generate autosummary stubs +# Generate autosummary stubs recursively autosummary_generate = True +# Suppress internal/implementation modules not intended for users +exclude_patterns += [ + '*/telemetry*', + '*/tools*', + '*/container_drivers*', + '*/runtime_environment*', + '*/model_server*', + '*/detector*', + '*/validations*', +] + +# Modules that fail to import due to runtime dependencies or side effects +autodoc_mock_imports = [ + 'triton_python_backend_utils', +] + # Don't mock imports - let them fail gracefully and show what's available autodoc_mock_imports = [] suppress_warnings = ['autodoc.import_error'] From f1a3ca1b1141719e0618ff936703b0af3f6f88b9 Mon Sep 17 00:00:00 2001 From: Molly He Date: Wed, 8 Apr 2026 16:09:50 -0700 Subject: [PATCH 2/3] Maintain previous opinionated list, add new section of full module reference --- docs/api/full_reference.rst | 32 ++++++++++ docs/api/sagemaker_core.rst | 60 +++++++++++++++++-- docs/api/sagemaker_mlops.rst | 39 ++++++++++-- docs/api/sagemaker_serve.rst | 14 +++-- docs/api/sagemaker_train.rst | 32 ++++++++-- docs/conf.py | 16 +++-- docs/index.rst | 7 +++ .../sagemaker/core/image_retriever/test.py | 7 --- 8 files changed, 178 insertions(+), 29 deletions(-) create mode 100644 docs/api/full_reference.rst delete mode 100644 sagemaker-core/src/sagemaker/core/image_retriever/test.py diff --git a/docs/api/full_reference.rst b/docs/api/full_reference.rst new file mode 100644 index 0000000000..d8587dad76 --- /dev/null +++ b/docs/api/full_reference.rst @@ -0,0 +1,32 @@ +Full Module Reference +===================== + +Complete auto-generated API reference for all public modules in SageMaker Python SDK V3. + + +.. autosummary:: + :toctree: generated/ + :recursive: + + sagemaker.core + + +.. autosummary:: + :toctree: generated/ + :recursive: + + sagemaker.train + + +.. autosummary:: + :toctree: generated/ + :recursive: + + sagemaker.serve + + +.. autosummary:: + :toctree: generated/ + :recursive: + + sagemaker.mlops diff --git a/docs/api/sagemaker_core.rst b/docs/api/sagemaker_core.rst index 69ddca7165..e78b6f8ca4 100644 --- a/docs/api/sagemaker_core.rst +++ b/docs/api/sagemaker_core.rst @@ -3,8 +3,60 @@ SageMaker Core Core SageMaker resources and utilities for managing AWS SageMaker services. -.. autosummary:: - :toctree: generated/ - :recursive: +.. currentmodule:: sagemaker.core + +Core Resources +-------------- + +.. automodule:: sagemaker.core.resources + :members: + :undoc-members: + :show-inheritance: + +Session Management +------------------ + +.. automodule:: sagemaker.core.session_settings + :members: + :undoc-members: + +Configuration +------------- + +.. automodule:: sagemaker.core.config_schema + :members: + :undoc-members: + +Processing +---------- + +.. automodule:: sagemaker.core.processing + :members: + :undoc-members: + +Transformers +------------ + +.. automodule:: sagemaker.core.transformer + :members: + :undoc-members: + +Utilities +--------- + +.. automodule:: sagemaker.core.common_utils + :members: + :undoc-members: + +.. automodule:: sagemaker.core.image_uris + :members: + :undoc-members: + +Exceptions +---------- + +.. automodule:: sagemaker.core.exceptions + :members: + :undoc-members: + - sagemaker.core diff --git a/docs/api/sagemaker_mlops.rst b/docs/api/sagemaker_mlops.rst index d53591e069..f628774d35 100644 --- a/docs/api/sagemaker_mlops.rst +++ b/docs/api/sagemaker_mlops.rst @@ -3,8 +3,39 @@ SageMaker MLOps MLOps capabilities including pipelines, workflows, and model management. -.. autosummary:: - :toctree: generated/ - :recursive: +.. currentmodule:: sagemaker.mlops + +Pipeline Management +------------------- + +.. automodule:: sagemaker.mlops + :members: + :undoc-members: + :show-inheritance: + +Workflow Management +------------------- + +.. automodule:: sagemaker.mlops.workflow + :members: + :undoc-members: + :show-inheritance: + +Local Development +----------------- + +.. automodule:: sagemaker.mlops.local + :members: + :undoc-members: + :show-inheritance: + + +Feature Store +------------- + +.. automodule:: sagemaker.mlops.feature_store + :members: + :undoc-members: + :show-inheritance: + - sagemaker.mlops diff --git a/docs/api/sagemaker_serve.rst b/docs/api/sagemaker_serve.rst index bdd5e43ea1..9df8b9468c 100644 --- a/docs/api/sagemaker_serve.rst +++ b/docs/api/sagemaker_serve.rst @@ -3,8 +3,14 @@ SageMaker Serve Model serving and inference capabilities for deploying and managing ML models. -.. autosummary:: - :toctree: generated/ - :recursive: +.. currentmodule:: sagemaker.serve + +Model Deployment +---------------- + +.. automodule:: sagemaker.serve + :members: + :undoc-members: + :show-inheritance: + - sagemaker.serve diff --git a/docs/api/sagemaker_train.rst b/docs/api/sagemaker_train.rst index cada8065b5..abdd944413 100644 --- a/docs/api/sagemaker_train.rst +++ b/docs/api/sagemaker_train.rst @@ -1,10 +1,32 @@ SageMaker Train =============== -Training capabilities including model training, fine-tuning, hyperparameter tuning, and distributed training. +Training capabilities including model training, hyperparameter tuning, and distributed training. + +.. currentmodule:: sagemaker.train + +Model Training +-------------- + +.. automodule:: sagemaker.train + :members: + :undoc-members: + :show-inheritance: + +Distributed Training +-------------------- + +.. automodule:: sagemaker.train.distributed + :members: + :undoc-members: + :show-inheritance: + +Model Evaluation +---------------- + +.. automodule:: sagemaker.train.evaluate + :members: + :undoc-members: + :show-inheritance: -.. autosummary:: - :toctree: generated/ - :recursive: - sagemaker.train diff --git a/docs/conf.py b/docs/conf.py index d201502ca7..26aee16b5c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -37,9 +37,10 @@ # Suppress specific warnings suppress_warnings = [ - 'myst.header', # Suppress header level warnings from notebooks - 'toc.not_readable', # Suppress toctree warnings for symlinked files - 'ref.python', # Suppress "more than one target found" for duplicate class names across modules + 'myst.header', # header level warnings from notebooks + 'toc.not_readable', # toctree warnings for symlinked files + 'ref.python', # "more than one target found" for duplicate class names + 'autosummary', # autosummary import failures for internal modules ] html_theme = 'sphinx_book_theme' @@ -92,13 +93,18 @@ '*/model_server*', '*/detector*', '*/validations*', + '*/image_retriever*', ] # Modules that fail to import due to runtime dependencies or side effects autodoc_mock_imports = [ 'triton_python_backend_utils', + 'sagemaker.serve.model_server.in_process_model_server.app', + 'sagemaker.serve.model_server.multi_model_server.inference', + 'sagemaker.serve.model_server.tensorflow_serving.inference', + 'sagemaker.serve.model_server.torchserve.inference', + 'sagemaker.serve.model_server.torchserve.xgboost_inference', + 'sagemaker.serve.model_server.triton.model', ] -# Don't mock imports - let them fail gracefully and show what's available -autodoc_mock_imports = [] suppress_warnings = ['autodoc.import_error'] diff --git a/docs/index.rst b/docs/index.rst index da965af497..ae3c0baf0d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -36,3 +36,10 @@ SageMaker Python SDK V3 :hidden: api/index + +.. toctree:: + :maxdepth: 2 + :caption: Full Module Reference + :hidden: + + api/full_reference diff --git a/sagemaker-core/src/sagemaker/core/image_retriever/test.py b/sagemaker-core/src/sagemaker/core/image_retriever/test.py deleted file mode 100644 index c93bb7396a..0000000000 --- a/sagemaker-core/src/sagemaker/core/image_retriever/test.py +++ /dev/null @@ -1,7 +0,0 @@ -a = 1 -b = 2 -print(locals()) -args = dict(locals()) -print(args) -locals()["a"] = 3 -print(a) From 90aebae0a3ff258e60710e8186dabaac8d8d9810 Mon Sep 17 00:00:00 2001 From: Molly He Date: Wed, 8 Apr 2026 16:34:51 -0700 Subject: [PATCH 3/3] Add sagemaker-core description in init --- sagemaker-core/src/sagemaker/core/__init__.py | 1 + 1 file changed, 1 insertion(+) diff --git a/sagemaker-core/src/sagemaker/core/__init__.py b/sagemaker-core/src/sagemaker/core/__init__.py index f25f18009d..498c85390a 100644 --- a/sagemaker-core/src/sagemaker/core/__init__.py +++ b/sagemaker-core/src/sagemaker/core/__init__.py @@ -1,3 +1,4 @@ +"""SageMaker Core package for low-level resource management and SDK foundations.""" from sagemaker.core.utils.utils import enable_textual_rich_console_and_traceback