Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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/
32 changes: 32 additions & 0 deletions docs/api/full_reference.rst
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions docs/api/sagemaker_core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,5 @@ Exceptions
.. automodule:: sagemaker.core.exceptions
:members:
:undoc-members:


4 changes: 3 additions & 1 deletion docs/api/sagemaker_mlops.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,6 @@ Feature Store
.. automodule:: sagemaker.mlops.feature_store
:members:
:undoc-members:
:show-inheritance:
:show-inheritance:


2 changes: 2 additions & 0 deletions docs/api/sagemaker_serve.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,5 @@ Model Deployment
:members:
:undoc-members:
:show-inheritance:


2 changes: 2 additions & 0 deletions docs/api/sagemaker_train.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,5 @@ Model Evaluation
:members:
:undoc-members:
:show-inheritance:


34 changes: 29 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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']
7 changes: 7 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,10 @@ SageMaker Python SDK V3
:hidden:

api/index

.. toctree::
:maxdepth: 2
:caption: Full Module Reference
:hidden:

api/full_reference
1 change: 1 addition & 0 deletions sagemaker-core/src/sagemaker/core/__init__.py
Original file line number Diff line number Diff line change
@@ -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


Expand Down
7 changes: 0 additions & 7 deletions sagemaker-core/src/sagemaker/core/image_retriever/test.py

This file was deleted.

Loading