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/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 bbad9631ab..e78b6f8ca4 100644 --- a/docs/api/sagemaker_core.rst +++ b/docs/api/sagemaker_core.rst @@ -58,3 +58,5 @@ Exceptions .. automodule:: sagemaker.core.exceptions :members: :undoc-members: + + diff --git a/docs/api/sagemaker_mlops.rst b/docs/api/sagemaker_mlops.rst index b9aa069c7d..f628774d35 100644 --- a/docs/api/sagemaker_mlops.rst +++ b/docs/api/sagemaker_mlops.rst @@ -36,4 +36,6 @@ Feature Store .. automodule:: sagemaker.mlops.feature_store :members: :undoc-members: - :show-inheritance: \ No newline at end of file + :show-inheritance: + + diff --git a/docs/api/sagemaker_serve.rst b/docs/api/sagemaker_serve.rst index 471b79530b..9df8b9468c 100644 --- a/docs/api/sagemaker_serve.rst +++ b/docs/api/sagemaker_serve.rst @@ -12,3 +12,5 @@ Model Deployment :members: :undoc-members: :show-inheritance: + + diff --git a/docs/api/sagemaker_train.rst b/docs/api/sagemaker_train.rst index d54b720a92..abdd944413 100644 --- a/docs/api/sagemaker_train.rst +++ b/docs/api/sagemaker_train.rst @@ -28,3 +28,5 @@ Model Evaluation :members: :undoc-members: :show-inheritance: + + diff --git a/docs/conf.py b/docs/conf.py index d9e282694f..26aee16b5c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -37,8 +37,10 @@ # Suppress specific warnings suppress_warnings = [ - 'myst.header', # Suppress header level warnings from notebooks - 'toc.not_readable', # Suppress toctree warnings for symlinked files + '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' @@ -76,11 +78,33 @@ 'members': True, 'undoc-members': True, 'show-inheritance': True, + 'private-members': False, } -# Generate autosummary stubs +# Generate autosummary stubs recursively autosummary_generate = True -# Don't mock imports - let them fail gracefully and show what's available -autodoc_mock_imports = [] +# Suppress internal/implementation modules not intended for users +exclude_patterns += [ + '*/telemetry*', + '*/tools*', + '*/container_drivers*', + '*/runtime_environment*', + '*/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', +] + 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/__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 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)