Skip to content

Commit f1a3ca1

Browse files
committed
Maintain previous opinionated list, add new section of full module reference
1 parent 59f137d commit f1a3ca1

8 files changed

Lines changed: 178 additions & 29 deletions

File tree

docs/api/full_reference.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Full Module Reference
2+
=====================
3+
4+
Complete auto-generated API reference for all public modules in SageMaker Python SDK V3.
5+
6+
7+
.. autosummary::
8+
:toctree: generated/
9+
:recursive:
10+
11+
sagemaker.core
12+
13+
14+
.. autosummary::
15+
:toctree: generated/
16+
:recursive:
17+
18+
sagemaker.train
19+
20+
21+
.. autosummary::
22+
:toctree: generated/
23+
:recursive:
24+
25+
sagemaker.serve
26+
27+
28+
.. autosummary::
29+
:toctree: generated/
30+
:recursive:
31+
32+
sagemaker.mlops

docs/api/sagemaker_core.rst

Lines changed: 56 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,60 @@ SageMaker Core
33

44
Core SageMaker resources and utilities for managing AWS SageMaker services.
55

6-
.. autosummary::
7-
:toctree: generated/
8-
:recursive:
6+
.. currentmodule:: sagemaker.core
7+
8+
Core Resources
9+
--------------
10+
11+
.. automodule:: sagemaker.core.resources
12+
:members:
13+
:undoc-members:
14+
:show-inheritance:
15+
16+
Session Management
17+
------------------
18+
19+
.. automodule:: sagemaker.core.session_settings
20+
:members:
21+
:undoc-members:
22+
23+
Configuration
24+
-------------
25+
26+
.. automodule:: sagemaker.core.config_schema
27+
:members:
28+
:undoc-members:
29+
30+
Processing
31+
----------
32+
33+
.. automodule:: sagemaker.core.processing
34+
:members:
35+
:undoc-members:
36+
37+
Transformers
38+
------------
39+
40+
.. automodule:: sagemaker.core.transformer
41+
:members:
42+
:undoc-members:
43+
44+
Utilities
45+
---------
46+
47+
.. automodule:: sagemaker.core.common_utils
48+
:members:
49+
:undoc-members:
50+
51+
.. automodule:: sagemaker.core.image_uris
52+
:members:
53+
:undoc-members:
54+
55+
Exceptions
56+
----------
57+
58+
.. automodule:: sagemaker.core.exceptions
59+
:members:
60+
:undoc-members:
61+
962

10-
sagemaker.core

docs/api/sagemaker_mlops.rst

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,39 @@ SageMaker MLOps
33

44
MLOps capabilities including pipelines, workflows, and model management.
55

6-
.. autosummary::
7-
:toctree: generated/
8-
:recursive:
6+
.. currentmodule:: sagemaker.mlops
7+
8+
Pipeline Management
9+
-------------------
10+
11+
.. automodule:: sagemaker.mlops
12+
:members:
13+
:undoc-members:
14+
:show-inheritance:
15+
16+
Workflow Management
17+
-------------------
18+
19+
.. automodule:: sagemaker.mlops.workflow
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:
23+
24+
Local Development
25+
-----------------
26+
27+
.. automodule:: sagemaker.mlops.local
28+
:members:
29+
:undoc-members:
30+
:show-inheritance:
31+
32+
33+
Feature Store
34+
-------------
35+
36+
.. automodule:: sagemaker.mlops.feature_store
37+
:members:
38+
:undoc-members:
39+
:show-inheritance:
40+
941

10-
sagemaker.mlops

docs/api/sagemaker_serve.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,14 @@ SageMaker Serve
33

44
Model serving and inference capabilities for deploying and managing ML models.
55

6-
.. autosummary::
7-
:toctree: generated/
8-
:recursive:
6+
.. currentmodule:: sagemaker.serve
7+
8+
Model Deployment
9+
----------------
10+
11+
.. automodule:: sagemaker.serve
12+
:members:
13+
:undoc-members:
14+
:show-inheritance:
15+
916

10-
sagemaker.serve

docs/api/sagemaker_train.rst

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,32 @@
11
SageMaker Train
22
===============
33

4-
Training capabilities including model training, fine-tuning, hyperparameter tuning, and distributed training.
4+
Training capabilities including model training, hyperparameter tuning, and distributed training.
5+
6+
.. currentmodule:: sagemaker.train
7+
8+
Model Training
9+
--------------
10+
11+
.. automodule:: sagemaker.train
12+
:members:
13+
:undoc-members:
14+
:show-inheritance:
15+
16+
Distributed Training
17+
--------------------
18+
19+
.. automodule:: sagemaker.train.distributed
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:
23+
24+
Model Evaluation
25+
----------------
26+
27+
.. automodule:: sagemaker.train.evaluate
28+
:members:
29+
:undoc-members:
30+
:show-inheritance:
531

6-
.. autosummary::
7-
:toctree: generated/
8-
:recursive:
932

10-
sagemaker.train

docs/conf.py

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,10 @@
3737

3838
# Suppress specific warnings
3939
suppress_warnings = [
40-
'myst.header', # Suppress header level warnings from notebooks
41-
'toc.not_readable', # Suppress toctree warnings for symlinked files
42-
'ref.python', # Suppress "more than one target found" for duplicate class names across modules
40+
'myst.header', # header level warnings from notebooks
41+
'toc.not_readable', # toctree warnings for symlinked files
42+
'ref.python', # "more than one target found" for duplicate class names
43+
'autosummary', # autosummary import failures for internal modules
4344
]
4445

4546
html_theme = 'sphinx_book_theme'
@@ -92,13 +93,18 @@
9293
'*/model_server*',
9394
'*/detector*',
9495
'*/validations*',
96+
'*/image_retriever*',
9597
]
9698

9799
# Modules that fail to import due to runtime dependencies or side effects
98100
autodoc_mock_imports = [
99101
'triton_python_backend_utils',
102+
'sagemaker.serve.model_server.in_process_model_server.app',
103+
'sagemaker.serve.model_server.multi_model_server.inference',
104+
'sagemaker.serve.model_server.tensorflow_serving.inference',
105+
'sagemaker.serve.model_server.torchserve.inference',
106+
'sagemaker.serve.model_server.torchserve.xgboost_inference',
107+
'sagemaker.serve.model_server.triton.model',
100108
]
101109

102-
# Don't mock imports - let them fail gracefully and show what's available
103-
autodoc_mock_imports = []
104110
suppress_warnings = ['autodoc.import_error']

docs/index.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,10 @@ SageMaker Python SDK V3
3636
:hidden:
3737

3838
api/index
39+
40+
.. toctree::
41+
:maxdepth: 2
42+
:caption: Full Module Reference
43+
:hidden:
44+
45+
api/full_reference

sagemaker-core/src/sagemaker/core/image_retriever/test.py

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)