Skip to content

Commit e3e962f

Browse files
authored
Merge branch 'master' into master-v3-update-telemetry
2 parents e0a271b + 1f6c645 commit e3e962f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+4865
-734
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ scratch/
1818
*.egg
1919
examples/tensorflow/distributed_mnist/data
2020
*.iml
21+
22+
# Sphinx documentation
23+
docs/_build/
2124
doc/_build
2225
doc/_static
2326
doc/_templates

.readthedocs.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Read the Docs configuration file
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
version: 2
5+
6+
build:
7+
os: ubuntu-22.04
8+
tools:
9+
python: "3.10"
10+
11+
sphinx:
12+
configuration: docs/conf.py
13+
14+
formats:
15+
- pdf
16+
- epub
17+
18+
python:
19+
install:
20+
- requirements: docs/requirements.txt
21+
- method: pip
22+
path: .
23+
extra_requirements:
24+
- docs

docs/Makefile

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
SPHINXOPTS ?=
2+
SPHINXBUILD ?= sphinx-build
3+
SOURCEDIR = .
4+
BUILDDIR = _build
5+
6+
help:
7+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
8+
9+
.PHONY: help Makefile
10+
11+
%: Makefile
12+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/custom.css

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
/* What's New Section Styling */
2+
.whats-new-container {
3+
display: grid;
4+
grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
5+
gap: 20px;
6+
margin: 30px 0;
7+
}
8+
9+
.new-feature-card {
10+
background: var(--pst-color-surface);
11+
border: 1px solid var(--pst-color-border);
12+
border-radius: 12px;
13+
padding: 25px;
14+
box-shadow: 0 4px 12px rgba(0, 0, 0, 0.1);
15+
transition: transform 0.2s ease, box-shadow 0.2s ease;
16+
position: relative;
17+
overflow: hidden;
18+
color: var(--pst-color-text-base);
19+
}
20+
21+
[data-theme="dark"] .new-feature-card {
22+
box-shadow: 0 4px 12px rgba(0, 0, 0, 0.3);
23+
}
24+
25+
.new-feature-card:hover {
26+
transform: translateY(-2px);
27+
box-shadow: 0 8px 25px rgba(0, 0, 0, 0.15);
28+
}
29+
30+
[data-theme="dark"] .new-feature-card:hover {
31+
box-shadow: 0 8px 25px rgba(0, 0, 0, 0.4);
32+
}
33+
34+
.new-feature-card h3 {
35+
margin-top: 0;
36+
margin-bottom: 15px;
37+
font-size: 1.3em;
38+
font-weight: 600;
39+
color: inherit;
40+
}
41+
42+
.new-feature-card ul {
43+
margin: 15px 0;
44+
padding-left: 20px;
45+
}
46+
47+
.new-feature-card li {
48+
margin-bottom: 8px;
49+
line-height: 1.5;
50+
}
51+
52+
/* Feedback Component */
53+
.feedback-container {
54+
border-top: 1px solid var(--pst-color-border);
55+
margin-top: 40px;
56+
padding: 24px;
57+
background-color: var(--pst-color-surface);
58+
border-radius: 8px;
59+
border: 1px solid var(--pst-color-border);
60+
}
61+
62+
.feedback-question {
63+
font-size: 20px;
64+
font-weight: 500;
65+
color: var(--pst-color-text-base);
66+
margin-bottom: 20px;
67+
text-align: left;
68+
}
69+
70+
.feedback-buttons {
71+
display: flex;
72+
justify-content: flex-start;
73+
gap: 12px;
74+
}
75+
76+
.feedback-btn {
77+
display: flex;
78+
align-items: center;
79+
gap: 8px;
80+
padding: 8px 16px;
81+
border: 1px solid var(--pst-color-border);
82+
border-radius: 6px;
83+
background: var(--pst-color-surface);
84+
color: var(--pst-color-text-muted);
85+
font-size: 14px;
86+
cursor: pointer;
87+
transition: all 0.2s ease;
88+
}
89+
90+
.feedback-btn:hover {
91+
border-color: var(--pst-color-primary);
92+
background: var(--pst-color-surface);
93+
}
94+
95+
.feedback-btn.selected {
96+
border-color: var(--pst-color-primary);
97+
background: var(--pst-color-primary-bg);
98+
color: var(--pst-color-primary);
99+
}
100+
101+
.feedback-btn svg {
102+
width: 16px;
103+
height: 16px;
104+
}
105+
106+
.feedback-thanks {
107+
display: none;
108+
color: #059669;
109+
font-size: 14px;
110+
text-align: center;
111+
margin-top: 16px;
112+
}
113+
114+
/* Feedback Options */
115+
.feedback-options {
116+
display: none;
117+
margin-top: 20px;
118+
}
119+
120+
.feedback-more {
121+
display: flex;
122+
flex-direction: column;
123+
gap: 12px;
124+
}
125+
126+
.feedback-github-link {
127+
color: #0366d6;
128+
text-decoration: none;
129+
font-size: 14px;
130+
padding: 10px 20px;
131+
border: 1px solid #0366d6;
132+
border-radius: 6px;
133+
transition: all 0.2s;
134+
font-weight: 500;
135+
align-self: flex-start;
136+
}
137+
138+
.feedback-github-link:hover {
139+
background-color: #0366d6;
140+
color: white;
141+
text-decoration: none;
142+
}
143+
144+
header {
145+
background-color: white;
146+
147+
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.05);
148+
position: sticky;
149+
top: 0;
150+
z-index: 50;
151+
}
152+
153+
h1 {
154+
font-size: 1.875rem;
155+
font-weight: 700;
156+
color: var(--pst-color-text-base);
157+
}
158+
159+
h2 {
160+
font-size: 1.5rem;
161+
font-weight: 700;
162+
color: var(--pst-color-text-base);
163+
}
164+
165+
h3 {
166+
font-size: 1.25rem;
167+
font-weight: 500;
168+
color: var(--pst-color-text-base);
169+
}
170+
171+
p {
172+
font-size: 1.0rem;
173+
color: var(--pst-color-text-base);
174+
}

docs/_static/feedback.js

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
// Feedback functionality
2+
document.addEventListener('DOMContentLoaded', function() {
3+
// Add feedback component to the very bottom of each page
4+
const article = document.querySelector('article[role="main"]') || document.querySelector('.bd-article') || document.querySelector('main');
5+
if (article) {
6+
const feedbackHTML = `
7+
<div class="feedback-container">
8+
<div class="feedback-question">Was this page helpful?</div>
9+
<div class="feedback-buttons">
10+
<button class="feedback-btn" data-feedback="yes">
11+
<svg viewBox="0 0 24 24" fill="currentColor">
12+
<path d="M7.493 18.75c-.425 0-.82-.236-.975-.632A7.48 7.48 0 016 15.375c0-1.75.599-3.358 1.602-4.634.151-.192.373-.309.6-.397.473-.183.89-.514 1.212-.924a9.042 9.042 0 012.861-2.4c.723-.384 1.35-.956 1.653-1.715a4.498 4.498 0 00.322-1.672V3a.75.75 0 01.75-.75 2.25 2.25 0 012.25 2.25c0 1.152-.26 2.243-.723 3.218-.266.558-.107 1.282.725 1.282h3.126c1.026 0 1.945.694 2.054 1.715.045.422.068.85.068 1.285a11.95 11.95 0 01-2.649 7.521c-.388.482-.987.729-1.605.729H14.23c-.483 0-.964-.078-1.423-.23l-3.114-1.04a4.501 4.501 0 00-1.423-.23h-.777zM2.331 10.977a11.969 11.969 0 00-.831 4.398 12 12 0 00.52 3.507c.26.85 1.084 1.368 1.973 1.368H4.9c.445 0 .72-.498.523-.898a8.963 8.963 0 01-.924-3.977c0-1.708.476-3.305 1.302-4.666.245-.403-.028-.959-.5-.959H4.25c-.832 0-1.612.453-1.918 1.227z"/>
13+
</svg>
14+
Yes
15+
</button>
16+
<button class="feedback-btn" data-feedback="no">
17+
<svg viewBox="0 0 24 24" fill="currentColor">
18+
<path d="M15.73 5.25h1.035A7.465 7.465 0 0118 9.375a7.465 7.465 0 01-1.235 4.125h-.148c-.806 0-1.534.446-2.031 1.08a9.04 9.04 0 01-2.861 2.4c-.723.384-1.35.956-1.653 1.715a4.498 4.498 0 00-.322 1.672V21a.75.75 0 01-.75.75 2.25 2.25 0 01-2.25-2.25c0-1.152.26-2.243.723-3.218C7.74 15.724 7.366 15 6.748 15H3.622c-1.026 0-1.945-.694-2.054-1.715A12.134 12.134 0 011.5 12c0-2.848.992-5.464 2.649-7.521C4.537 3.997 5.136 3.75 5.754 3.75H9.77a4.5 4.5 0 011.423.23l3.114 1.04a4.5 4.5 0 001.423.23zM21.669 14.023c.536-1.362.831-2.845.831-4.398 0-1.22-.182-2.398-.52-3.507-.26-.85-1.084-1.368-1.973-1.368H19.1c-.445 0-.72.498-.523.898.591 1.2.924 2.55.924 3.977a8.958 8.958 0 01-1.302 4.666c-.245.403.028.959.5.959h1.053c.832 0 1.612-.453 1.918-1.227z"/>
19+
</svg>
20+
No
21+
</button>
22+
</div>
23+
<div class="feedback-options">
24+
<div class="feedback-more">
25+
<a href="https://github.com/aws/sagemaker-python-sdk/issues/new" target="_blank" class="feedback-github-link">
26+
Create GitHub Issue
27+
</a>
28+
</div>
29+
</div>
30+
<div class="feedback-thanks">Thank you for your feedback!</div>
31+
</div>
32+
`;
33+
34+
article.insertAdjacentHTML('beforeend', feedbackHTML);
35+
36+
// Add click handlers
37+
const feedbackBtns = document.querySelectorAll('.feedback-btn');
38+
const thanksMessage = document.querySelector('.feedback-thanks');
39+
const feedbackOptions = document.querySelector('.feedback-options');
40+
41+
feedbackBtns.forEach(btn => {
42+
btn.addEventListener('click', function() {
43+
const feedback = this.dataset.feedback;
44+
45+
// Remove selected class from all buttons
46+
feedbackBtns.forEach(b => b.classList.remove('selected'));
47+
48+
// Add selected class to clicked button
49+
this.classList.add('selected');
50+
51+
if (feedback === 'yes') {
52+
// Hide options and show thanks
53+
feedbackOptions.style.display = 'none';
54+
thanksMessage.style.display = 'block';
55+
56+
// Send positive feedback
57+
if (typeof gtag !== 'undefined') {
58+
gtag('event', 'page_feedback', {
59+
'feedback_value': 'positive',
60+
'page_location': window.location.href
61+
});
62+
}
63+
} else {
64+
// Show GitHub link for negative feedback
65+
feedbackOptions.style.display = 'block';
66+
thanksMessage.style.display = 'none';
67+
}
68+
});
69+
});
70+
}
71+
});

docs/api/index.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
API Reference
2+
=============
3+
4+
Complete API documentation for SageMaker Python SDK V3.
5+
6+
.. toctree::
7+
:maxdepth: 2
8+
:caption: API Reference
9+
10+
sagemaker_core
11+
sagemaker_train
12+
sagemaker_serve
13+
sagemaker_mlops

docs/api/sagemaker_core.rst

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
SageMaker Core
2+
==============
3+
4+
Core SageMaker resources and utilities for managing AWS SageMaker services.
5+
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:

0 commit comments

Comments
 (0)