Merged
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
110 changes: 110 additions & 0 deletions docs/model_customization/model_customization.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,116 @@ Key Features
with clear precedence. Use ``get_resolved_recipe()`` to inspect the merged configuration
before job submission. See :doc:`finetuning_serverful` and :doc:`finetuning_hyperpod` for examples.

**Job Notifications**
Receive SNS notifications when training jobs complete, fail, or stop. Uses EventBridge
rules to route SageMaker Training Job status changes to your SNS topic.

The SDK creates one rule per unique config (topic + events + prefix). Re-running with
the same config reuses the existing rule. Different configs create separate rules.

.. note::
Supported for SMTJ (serverful and serverless) compute only. HyperPod is not currently supported.

.. code-block:: python

trainer = SFTTrainer(
model="nova-textgeneration-micro",
training_dataset="s3://my-bucket/train.jsonl",
accept_eula=True,
notifications={
"sns_topic_arn": "arn:aws:sns:us-east-1:123456789012:my-topic", # Required
"events": ["Completed", "Failed"], # Optional (default: Completed, Failed, Stopped)
"job_name_prefix": "my-team-sft-", # Optional: filter by job name
"event_bus_arn": "arn:aws:events:us-east-1:123456789012:event-bus/custom-bus" # Optional
},
)
job = trainer.train(wait=False) # Notification sent on completion

# Access the rule ARN
print(trainer.notification_rule_arn)

# List and manage rules
rules = trainer.list_notification_rules()
trainer.delete_notification_rule(rule_arn=trainer.notification_rule_arn)

**Prerequisites:**

- An SNS topic (and subscription) with a resource policy allowing ``events.amazonaws.com``.
To set up a topic and subscription, see `Creating an SNS topic and subscription <https://docs.aws.amazon.com/sns/latest/dg/sns-create-subscribe-endpoint-to-topic.html>`_.
- IAM permissions: ``events:PutRule``, ``events:PutTargets``, ``events:ListRules``,
``events:RemoveTargets``, ``events:DeleteRule``

**Monitoring: show_metrics()**
Plot training metrics after a job completes. Works across all compute types.

- **Nova models**: Metrics parsed from CloudWatch logs.
- **OSS models**: Metrics pulled from MLflow.

.. code-block:: python

# Plot all available metrics
df = trainer.show_metrics()

# Plot specific metrics
df = trainer.show_metrics(metrics=["training_loss", "lr"])

# Filter by step range
df = trainer.show_metrics(starting_step=10, ending_step=100)

# Filter by time window
from datetime import datetime
df = trainer.show_metrics(
start_time=datetime(2026, 1, 1, 10, 0, 0),
end_time=datetime(2026, 1, 1, 12, 0, 0),
)

**After a kernel restart:**

.. code-block:: python

# Standalone (SMTJ)
from sagemaker.train import plot_training_metrics
plot_training_metrics("my-sft-job")

# Re-attach (HyperPod — needs cluster name for log group resolution)
from sagemaker.train import SFTTrainer
from sagemaker.core.training.configs import HyperPodCompute

trainer = SFTTrainer(
model="nova-textgeneration-micro",
training_dataset="s3://unused",
compute=HyperPodCompute(cluster_name="my-cluster", instance_type="ml.p5.48xlarge")
)
trainer._latest_training_job = "my-hp-job"
df = trainer.show_metrics()

**Monitoring: stream_logs()**
Stream CloudWatch logs in real-time while a job is running.

.. code-block:: python

# Start training non-blocking
job = trainer.train(wait=False)

# Stream logs (blocks until job completes or Ctrl+C)
trainer.stream_logs()

# Custom polling interval (seconds)
trainer.stream_logs(poll=10)

# Stream from a specific start time - providing this will speed up execution.
from datetime import datetime
trainer.stream_logs(start_time=datetime(2026, 1, 1, 15, 0, 0))

.. note::

- **SMTJ**: Streaming auto-stops when the job reaches a terminal state.
- **HyperPod**: Streaming runs until you press Ctrl+C. Logs may take a few minutes
to propagate to CloudWatch on first run.


----


.. toctree::
:maxdepth: 1
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
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
110 changes: 110 additions & 0 deletions docs/model_customization/model_customization.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,116 @@ Key Features
with clear precedence. Use ``get_resolved_recipe()`` to inspect the merged configuration
before job submission. See :doc:`finetuning_serverful` and :doc:`finetuning_hyperpod` for examples.

**Job Notifications**
Receive SNS notifications when training jobs complete, fail, or stop. Uses EventBridge
rules to route SageMaker Training Job status changes to your SNS topic.

The SDK creates one rule per unique config (topic + events + prefix). Re-running with
the same config reuses the existing rule. Different configs create separate rules.

.. note::
Supported for SMTJ (serverful and serverless) compute only. HyperPod is not currently supported.

.. code-block:: python

trainer = SFTTrainer(
model="nova-textgeneration-micro",
training_dataset="s3://my-bucket/train.jsonl",
accept_eula=True,
notifications={
"sns_topic_arn": "arn:aws:sns:us-east-1:123456789012:my-topic", # Required
"events": ["Completed", "Failed"], # Optional (default: Completed, Failed, Stopped)
"job_name_prefix": "my-team-sft-", # Optional: filter by job name
"event_bus_arn": "arn:aws:events:us-east-1:123456789012:event-bus/custom-bus" # Optional
},
)
job = trainer.train(wait=False) # Notification sent on completion

# Access the rule ARN
print(trainer.notification_rule_arn)

# List and manage rules
rules = trainer.list_notification_rules()
trainer.delete_notification_rule(rule_arn=trainer.notification_rule_arn)

**Prerequisites:**

- An SNS topic (and subscription) with a resource policy allowing ``events.amazonaws.com``.
To set up a topic and subscription, see `Creating an SNS topic and subscription <https://docs.aws.amazon.com/sns/latest/dg/sns-create-subscribe-endpoint-to-topic.html>`_.
- IAM permissions: ``events:PutRule``, ``events:PutTargets``, ``events:ListRules``,
``events:RemoveTargets``, ``events:DeleteRule``

**Monitoring: show_metrics()**
Plot training metrics after a job completes. Works across all compute types.

- **Nova models**: Metrics parsed from CloudWatch logs.
- **OSS models**: Metrics pulled from MLflow.

.. code-block:: python

# Plot all available metrics
df = trainer.show_metrics()

# Plot specific metrics
df = trainer.show_metrics(metrics=["training_loss", "lr"])

# Filter by step range
df = trainer.show_metrics(starting_step=10, ending_step=100)

# Filter by time window
from datetime import datetime
df = trainer.show_metrics(
start_time=datetime(2026, 1, 1, 10, 0, 0),
end_time=datetime(2026, 1, 1, 12, 0, 0),
)

**After a kernel restart:**

.. code-block:: python

# Standalone (SMTJ)
from sagemaker.train import plot_training_metrics
plot_training_metrics("my-sft-job")

# Re-attach (HyperPod — needs cluster name for log group resolution)
from sagemaker.train import SFTTrainer
from sagemaker.core.training.configs import HyperPodCompute

trainer = SFTTrainer(
model="nova-textgeneration-micro",
training_dataset="s3://unused",
compute=HyperPodCompute(cluster_name="my-cluster", instance_type="ml.p5.48xlarge")
)
trainer._latest_training_job = "my-hp-job"
df = trainer.show_metrics()

**Monitoring: stream_logs()**
Stream CloudWatch logs in real-time while a job is running.

.. code-block:: python

# Start training non-blocking
job = trainer.train(wait=False)

# Stream logs (blocks until job completes or Ctrl+C)
trainer.stream_logs()

# Custom polling interval (seconds)
trainer.stream_logs(poll=10)

# Stream from a specific start time - providing this will speed up execution.
from datetime import datetime
trainer.stream_logs(start_time=datetime(2026, 1, 1, 15, 0, 0))

.. note::

- **SMTJ**: Streaming auto-stops when the job reaches a terminal state.
- **HyperPod**: Streaming runs until you press Ctrl+C. Logs may take a few minutes
to propagate to CloudWatch on first run.


----


.. toctree::
:maxdepth: 1
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
110 changes: 110 additions & 0 deletions docs/model_customization/model_customization.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,116 @@ Key Features
with clear precedence. Use ``get_resolved_recipe()`` to inspect the merged configuration
before job submission. See :doc:`finetuning_serverful` and :doc:`finetuning_hyperpod` for examples.

**Job Notifications**
Receive SNS notifications when training jobs complete, fail, or stop. Uses EventBridge
rules to route SageMaker Training Job status changes to your SNS topic.

The SDK creates one rule per unique config (topic + events + prefix). Re-running with
the same config reuses the existing rule. Different configs create separate rules.

.. note::
Supported for SMTJ (serverful and serverless) compute only. HyperPod is not currently supported.

.. code-block:: python

trainer = SFTTrainer(
model="nova-textgeneration-micro",
training_dataset="s3://my-bucket/train.jsonl",
accept_eula=True,
notifications={
"sns_topic_arn": "arn:aws:sns:us-east-1:123456789012:my-topic", # Required
"events": ["Completed", "Failed"], # Optional (default: Completed, Failed, Stopped)
"job_name_prefix": "my-team-sft-", # Optional: filter by job name
"event_bus_arn": "arn:aws:events:us-east-1:123456789012:event-bus/custom-bus" # Optional
},
)
job = trainer.train(wait=False) # Notification sent on completion

# Access the rule ARN
print(trainer.notification_rule_arn)

# List and manage rules
rules = trainer.list_notification_rules()
trainer.delete_notification_rule(rule_arn=trainer.notification_rule_arn)

**Prerequisites:**

- An SNS topic (and subscription) with a resource policy allowing ``events.amazonaws.com``.
To set up a topic and subscription, see `Creating an SNS topic and subscription <https://docs.aws.amazon.com/sns/latest/dg/sns-create-subscribe-endpoint-to-topic.html>`_.
- IAM permissions: ``events:PutRule``, ``events:PutTargets``, ``events:ListRules``,
``events:RemoveTargets``, ``events:DeleteRule``

**Monitoring: show_metrics()**
Plot training metrics after a job completes. Works across all compute types.

- **Nova models**: Metrics parsed from CloudWatch logs.
- **OSS models**: Metrics pulled from MLflow.

.. code-block:: python

# Plot all available metrics
df = trainer.show_metrics()

# Plot specific metrics
df = trainer.show_metrics(metrics=["training_loss", "lr"])

# Filter by step range
df = trainer.show_metrics(starting_step=10, ending_step=100)

# Filter by time window
from datetime import datetime
df = trainer.show_metrics(
start_time=datetime(2026, 1, 1, 10, 0, 0),
end_time=datetime(2026, 1, 1, 12, 0, 0),
)

**After a kernel restart:**

.. code-block:: python

# Standalone (SMTJ)
from sagemaker.train import plot_training_metrics
plot_training_metrics("my-sft-job")

# Re-attach (HyperPod — needs cluster name for log group resolution)
from sagemaker.train import SFTTrainer
from sagemaker.core.training.configs import HyperPodCompute

trainer = SFTTrainer(
model="nova-textgeneration-micro",
training_dataset="s3://unused",
compute=HyperPodCompute(cluster_name="my-cluster", instance_type="ml.p5.48xlarge")
)
trainer._latest_training_job = "my-hp-job"
df = trainer.show_metrics()

**Monitoring: stream_logs()**
Stream CloudWatch logs in real-time while a job is running.

.. code-block:: python

# Start training non-blocking
job = trainer.train(wait=False)

# Stream logs (blocks until job completes or Ctrl+C)
trainer.stream_logs()

# Custom polling interval (seconds)
trainer.stream_logs(poll=10)

# Stream from a specific start time - providing this will speed up execution.
from datetime import datetime
trainer.stream_logs(start_time=datetime(2026, 1, 1, 15, 0, 0))

.. note::

- **SMTJ**: Streaming auto-stops when the job reaches a terminal state.
- **HyperPod**: Streaming runs until you press Ctrl+C. Logs may take a few minutes
to propagate to CloudWatch on first run.


----


.. toctree::
:maxdepth: 1
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
110 changes: 110 additions & 0 deletions docs/model_customization/model_customization.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,116 @@ Key Features
with clear precedence. Use ``get_resolved_recipe()`` to inspect the merged configuration
before job submission. See :doc:`finetuning_serverful` and :doc:`finetuning_hyperpod` for examples.

**Job Notifications**
Receive SNS notifications when training jobs complete, fail, or stop. Uses EventBridge
rules to route SageMaker Training Job status changes to your SNS topic.

The SDK creates one rule per unique config (topic + events + prefix). Re-running with
the same config reuses the existing rule. Different configs create separate rules.

.. note::
Supported for SMTJ (serverful and serverless) compute only. HyperPod is not currently supported.

.. code-block:: python

trainer = SFTTrainer(
model="nova-textgeneration-micro",
training_dataset="s3://my-bucket/train.jsonl",
accept_eula=True,
notifications={
"sns_topic_arn": "arn:aws:sns:us-east-1:123456789012:my-topic", # Required
"events": ["Completed", "Failed"], # Optional (default: Completed, Failed, Stopped)
"job_name_prefix": "my-team-sft-", # Optional: filter by job name
"event_bus_arn": "arn:aws:events:us-east-1:123456789012:event-bus/custom-bus" # Optional
},
)
job = trainer.train(wait=False) # Notification sent on completion

# Access the rule ARN
print(trainer.notification_rule_arn)

# List and manage rules
rules = trainer.list_notification_rules()
trainer.delete_notification_rule(rule_arn=trainer.notification_rule_arn)

**Prerequisites:**

- An SNS topic (and subscription) with a resource policy allowing ``events.amazonaws.com``.
To set up a topic and subscription, see `Creating an SNS topic and subscription <https://docs.aws.amazon.com/sns/latest/dg/sns-create-subscribe-endpoint-to-topic.html>`_.
- IAM permissions: ``events:PutRule``, ``events:PutTargets``, ``events:ListRules``,
``events:RemoveTargets``, ``events:DeleteRule``

**Monitoring: show_metrics()**
Plot training metrics after a job completes. Works across all compute types.

- **Nova models**: Metrics parsed from CloudWatch logs.
- **OSS models**: Metrics pulled from MLflow.

.. code-block:: python

# Plot all available metrics
df = trainer.show_metrics()

# Plot specific metrics
df = trainer.show_metrics(metrics=["training_loss", "lr"])

# Filter by step range
df = trainer.show_metrics(starting_step=10, ending_step=100)

# Filter by time window
from datetime import datetime
df = trainer.show_metrics(
start_time=datetime(2026, 1, 1, 10, 0, 0),
end_time=datetime(2026, 1, 1, 12, 0, 0),
)

**After a kernel restart:**

.. code-block:: python

# Standalone (SMTJ)
from sagemaker.train import plot_training_metrics
plot_training_metrics("my-sft-job")

# Re-attach (HyperPod — needs cluster name for log group resolution)
from sagemaker.train import SFTTrainer
from sagemaker.core.training.configs import HyperPodCompute

trainer = SFTTrainer(
model="nova-textgeneration-micro",
training_dataset="s3://unused",
compute=HyperPodCompute(cluster_name="my-cluster", instance_type="ml.p5.48xlarge")
)
trainer._latest_training_job = "my-hp-job"
df = trainer.show_metrics()

**Monitoring: stream_logs()**
Stream CloudWatch logs in real-time while a job is running.

.. code-block:: python

# Start training non-blocking
job = trainer.train(wait=False)

# Stream logs (blocks until job completes or Ctrl+C)
trainer.stream_logs()

# Custom polling interval (seconds)
trainer.stream_logs(poll=10)

# Stream from a specific start time - providing this will speed up execution.
from datetime import datetime
trainer.stream_logs(start_time=datetime(2026, 1, 1, 15, 0, 0))

.. note::

- **SMTJ**: Streaming auto-stops when the job reaches a terminal state.
- **HyperPod**: Streaming runs until you press Ctrl+C. Logs may take a few minutes
to propagate to CloudWatch on first run.


----


.. toctree::
:maxdepth: 1
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
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
110 changes: 110 additions & 0 deletions docs/model_customization/model_customization.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,116 @@ Key Features
with clear precedence. Use ``get_resolved_recipe()`` to inspect the merged configuration
before job submission. See :doc:`finetuning_serverful` and :doc:`finetuning_hyperpod` for examples.

**Job Notifications**
Receive SNS notifications when training jobs complete, fail, or stop. Uses EventBridge
rules to route SageMaker Training Job status changes to your SNS topic.

The SDK creates one rule per unique config (topic + events + prefix). Re-running with
the same config reuses the existing rule. Different configs create separate rules.

.. note::
Supported for SMTJ (serverful and serverless) compute only. HyperPod is not currently supported.

.. code-block:: python

trainer = SFTTrainer(
model="nova-textgeneration-micro",
training_dataset="s3://my-bucket/train.jsonl",
accept_eula=True,
notifications={
"sns_topic_arn": "arn:aws:sns:us-east-1:123456789012:my-topic", # Required
"events": ["Completed", "Failed"], # Optional (default: Completed, Failed, Stopped)
"job_name_prefix": "my-team-sft-", # Optional: filter by job name
"event_bus_arn": "arn:aws:events:us-east-1:123456789012:event-bus/custom-bus" # Optional
},
)
job = trainer.train(wait=False) # Notification sent on completion

# Access the rule ARN
print(trainer.notification_rule_arn)

# List and manage rules
rules = trainer.list_notification_rules()
trainer.delete_notification_rule(rule_arn=trainer.notification_rule_arn)

**Prerequisites:**

- An SNS topic (and subscription) with a resource policy allowing ``events.amazonaws.com``.
To set up a topic and subscription, see `Creating an SNS topic and subscription <https://docs.aws.amazon.com/sns/latest/dg/sns-create-subscribe-endpoint-to-topic.html>`_.
- IAM permissions: ``events:PutRule``, ``events:PutTargets``, ``events:ListRules``,
``events:RemoveTargets``, ``events:DeleteRule``

**Monitoring: show_metrics()**
Plot training metrics after a job completes. Works across all compute types.

- **Nova models**: Metrics parsed from CloudWatch logs.
- **OSS models**: Metrics pulled from MLflow.

.. code-block:: python

# Plot all available metrics
df = trainer.show_metrics()

# Plot specific metrics
df = trainer.show_metrics(metrics=["training_loss", "lr"])

# Filter by step range
df = trainer.show_metrics(starting_step=10, ending_step=100)

# Filter by time window
from datetime import datetime
df = trainer.show_metrics(
start_time=datetime(2026, 1, 1, 10, 0, 0),
end_time=datetime(2026, 1, 1, 12, 0, 0),
)

**After a kernel restart:**

.. code-block:: python

# Standalone (SMTJ)
from sagemaker.train import plot_training_metrics
plot_training_metrics("my-sft-job")

# Re-attach (HyperPod — needs cluster name for log group resolution)
from sagemaker.train import SFTTrainer
from sagemaker.core.training.configs import HyperPodCompute

trainer = SFTTrainer(
model="nova-textgeneration-micro",
training_dataset="s3://unused",
compute=HyperPodCompute(cluster_name="my-cluster", instance_type="ml.p5.48xlarge")
)
trainer._latest_training_job = "my-hp-job"
df = trainer.show_metrics()

**Monitoring: stream_logs()**
Stream CloudWatch logs in real-time while a job is running.

.. code-block:: python

# Start training non-blocking
job = trainer.train(wait=False)

# Stream logs (blocks until job completes or Ctrl+C)
trainer.stream_logs()

# Custom polling interval (seconds)
trainer.stream_logs(poll=10)

# Stream from a specific start time - providing this will speed up execution.
from datetime import datetime
trainer.stream_logs(start_time=datetime(2026, 1, 1, 15, 0, 0))

.. note::

- **SMTJ**: Streaming auto-stops when the job reaches a terminal state.
- **HyperPod**: Streaming runs until you press Ctrl+C. Logs may take a few minutes
to propagate to CloudWatch on first run.


----


.. toctree::
:maxdepth: 1
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
110 changes: 110 additions & 0 deletions docs/model_customization/model_customization.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,116 @@ Key Features
with clear precedence. Use ``get_resolved_recipe()`` to inspect the merged configuration
before job submission. See :doc:`finetuning_serverful` and :doc:`finetuning_hyperpod` for examples.

**Job Notifications**
Receive SNS notifications when training jobs complete, fail, or stop. Uses EventBridge
rules to route SageMaker Training Job status changes to your SNS topic.

The SDK creates one rule per unique config (topic + events + prefix). Re-running with
the same config reuses the existing rule. Different configs create separate rules.

.. note::
Supported for SMTJ (serverful and serverless) compute only. HyperPod is not currently supported.

.. code-block:: python

trainer = SFTTrainer(
model="nova-textgeneration-micro",
training_dataset="s3://my-bucket/train.jsonl",
accept_eula=True,
notifications={
"sns_topic_arn": "arn:aws:sns:us-east-1:123456789012:my-topic", # Required
"events": ["Completed", "Failed"], # Optional (default: Completed, Failed, Stopped)
"job_name_prefix": "my-team-sft-", # Optional: filter by job name
"event_bus_arn": "arn:aws:events:us-east-1:123456789012:event-bus/custom-bus" # Optional
},
)
job = trainer.train(wait=False) # Notification sent on completion

# Access the rule ARN
print(trainer.notification_rule_arn)

# List and manage rules
rules = trainer.list_notification_rules()
trainer.delete_notification_rule(rule_arn=trainer.notification_rule_arn)

**Prerequisites:**

- An SNS topic (and subscription) with a resource policy allowing ``events.amazonaws.com``.
To set up a topic and subscription, see `Creating an SNS topic and subscription <https://docs.aws.amazon.com/sns/latest/dg/sns-create-subscribe-endpoint-to-topic.html>`_.
- IAM permissions: ``events:PutRule``, ``events:PutTargets``, ``events:ListRules``,
``events:RemoveTargets``, ``events:DeleteRule``

**Monitoring: show_metrics()**
Plot training metrics after a job completes. Works across all compute types.

- **Nova models**: Metrics parsed from CloudWatch logs.
- **OSS models**: Metrics pulled from MLflow.

.. code-block:: python

# Plot all available metrics
df = trainer.show_metrics()

# Plot specific metrics
df = trainer.show_metrics(metrics=["training_loss", "lr"])

# Filter by step range
df = trainer.show_metrics(starting_step=10, ending_step=100)

# Filter by time window
from datetime import datetime
df = trainer.show_metrics(
start_time=datetime(2026, 1, 1, 10, 0, 0),
end_time=datetime(2026, 1, 1, 12, 0, 0),
)

**After a kernel restart:**

.. code-block:: python

# Standalone (SMTJ)
from sagemaker.train import plot_training_metrics
plot_training_metrics("my-sft-job")

# Re-attach (HyperPod — needs cluster name for log group resolution)
from sagemaker.train import SFTTrainer
from sagemaker.core.training.configs import HyperPodCompute

trainer = SFTTrainer(
model="nova-textgeneration-micro",
training_dataset="s3://unused",
compute=HyperPodCompute(cluster_name="my-cluster", instance_type="ml.p5.48xlarge")
)
trainer._latest_training_job = "my-hp-job"
df = trainer.show_metrics()

**Monitoring: stream_logs()**
Stream CloudWatch logs in real-time while a job is running.

.. code-block:: python

# Start training non-blocking
job = trainer.train(wait=False)

# Stream logs (blocks until job completes or Ctrl+C)
trainer.stream_logs()

# Custom polling interval (seconds)
trainer.stream_logs(poll=10)

# Stream from a specific start time - providing this will speed up execution.
from datetime import datetime
trainer.stream_logs(start_time=datetime(2026, 1, 1, 15, 0, 0))

.. note::

- **SMTJ**: Streaming auto-stops when the job reaches a terminal state.
- **HyperPod**: Streaming runs until you press Ctrl+C. Logs may take a few minutes
to propagate to CloudWatch on first run.


----


.. toctree::
:maxdepth: 1
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
110 changes: 110 additions & 0 deletions docs/model_customization/model_customization.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,116 @@ Key Features
with clear precedence. Use ``get_resolved_recipe()`` to inspect the merged configuration
before job submission. See :doc:`finetuning_serverful` and :doc:`finetuning_hyperpod` for examples.

**Job Notifications**
Receive SNS notifications when training jobs complete, fail, or stop. Uses EventBridge
rules to route SageMaker Training Job status changes to your SNS topic.

The SDK creates one rule per unique config (topic + events + prefix). Re-running with
the same config reuses the existing rule. Different configs create separate rules.

.. note::
Supported for SMTJ (serverful and serverless) compute only. HyperPod is not currently supported.

.. code-block:: python

trainer = SFTTrainer(
model="nova-textgeneration-micro",
training_dataset="s3://my-bucket/train.jsonl",
accept_eula=True,
notifications={
"sns_topic_arn": "arn:aws:sns:us-east-1:123456789012:my-topic", # Required
"events": ["Completed", "Failed"], # Optional (default: Completed, Failed, Stopped)
"job_name_prefix": "my-team-sft-", # Optional: filter by job name
"event_bus_arn": "arn:aws:events:us-east-1:123456789012:event-bus/custom-bus" # Optional
},
)
job = trainer.train(wait=False) # Notification sent on completion

# Access the rule ARN
print(trainer.notification_rule_arn)

# List and manage rules
rules = trainer.list_notification_rules()
trainer.delete_notification_rule(rule_arn=trainer.notification_rule_arn)

**Prerequisites:**

- An SNS topic (and subscription) with a resource policy allowing ``events.amazonaws.com``.
To set up a topic and subscription, see `Creating an SNS topic and subscription <https://docs.aws.amazon.com/sns/latest/dg/sns-create-subscribe-endpoint-to-topic.html>`_.
- IAM permissions: ``events:PutRule``, ``events:PutTargets``, ``events:ListRules``,
``events:RemoveTargets``, ``events:DeleteRule``

**Monitoring: show_metrics()**
Plot training metrics after a job completes. Works across all compute types.

- **Nova models**: Metrics parsed from CloudWatch logs.
- **OSS models**: Metrics pulled from MLflow.

.. code-block:: python

# Plot all available metrics
df = trainer.show_metrics()

# Plot specific metrics
df = trainer.show_metrics(metrics=["training_loss", "lr"])

# Filter by step range
df = trainer.show_metrics(starting_step=10, ending_step=100)

# Filter by time window
from datetime import datetime
df = trainer.show_metrics(
start_time=datetime(2026, 1, 1, 10, 0, 0),
end_time=datetime(2026, 1, 1, 12, 0, 0),
)

**After a kernel restart:**

.. code-block:: python

# Standalone (SMTJ)
from sagemaker.train import plot_training_metrics
plot_training_metrics("my-sft-job")

# Re-attach (HyperPod — needs cluster name for log group resolution)
from sagemaker.train import SFTTrainer
from sagemaker.core.training.configs import HyperPodCompute

trainer = SFTTrainer(
model="nova-textgeneration-micro",
training_dataset="s3://unused",
compute=HyperPodCompute(cluster_name="my-cluster", instance_type="ml.p5.48xlarge")
)
trainer._latest_training_job = "my-hp-job"
df = trainer.show_metrics()

**Monitoring: stream_logs()**
Stream CloudWatch logs in real-time while a job is running.

.. code-block:: python

# Start training non-blocking
job = trainer.train(wait=False)

# Stream logs (blocks until job completes or Ctrl+C)
trainer.stream_logs()

# Custom polling interval (seconds)
trainer.stream_logs(poll=10)

# Stream from a specific start time - providing this will speed up execution.
from datetime import datetime
trainer.stream_logs(start_time=datetime(2026, 1, 1, 15, 0, 0))

.. note::

- **SMTJ**: Streaming auto-stops when the job reaches a terminal state.
- **HyperPod**: Streaming runs until you press Ctrl+C. Logs may take a few minutes
to propagate to CloudWatch on first run.


----


.. toctree::
:maxdepth: 1
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
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
110 changes: 110 additions & 0 deletions docs/model_customization/model_customization.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,116 @@ Key Features
with clear precedence. Use ``get_resolved_recipe()`` to inspect the merged configuration
before job submission. See :doc:`finetuning_serverful` and :doc:`finetuning_hyperpod` for examples.

**Job Notifications**
Receive SNS notifications when training jobs complete, fail, or stop. Uses EventBridge
rules to route SageMaker Training Job status changes to your SNS topic.

The SDK creates one rule per unique config (topic + events + prefix). Re-running with
the same config reuses the existing rule. Different configs create separate rules.

.. note::
Supported for SMTJ (serverful and serverless) compute only. HyperPod is not currently supported.

.. code-block:: python

trainer = SFTTrainer(
model="nova-textgeneration-micro",
training_dataset="s3://my-bucket/train.jsonl",
accept_eula=True,
notifications={
"sns_topic_arn": "arn:aws:sns:us-east-1:123456789012:my-topic", # Required
"events": ["Completed", "Failed"], # Optional (default: Completed, Failed, Stopped)
"job_name_prefix": "my-team-sft-", # Optional: filter by job name
"event_bus_arn": "arn:aws:events:us-east-1:123456789012:event-bus/custom-bus" # Optional
},
)
job = trainer.train(wait=False) # Notification sent on completion

# Access the rule ARN
print(trainer.notification_rule_arn)

# List and manage rules
rules = trainer.list_notification_rules()
trainer.delete_notification_rule(rule_arn=trainer.notification_rule_arn)

**Prerequisites:**

- An SNS topic (and subscription) with a resource policy allowing ``events.amazonaws.com``.
To set up a topic and subscription, see `Creating an SNS topic and subscription <https://docs.aws.amazon.com/sns/latest/dg/sns-create-subscribe-endpoint-to-topic.html>`_.
- IAM permissions: ``events:PutRule``, ``events:PutTargets``, ``events:ListRules``,
``events:RemoveTargets``, ``events:DeleteRule``

**Monitoring: show_metrics()**
Plot training metrics after a job completes. Works across all compute types.

- **Nova models**: Metrics parsed from CloudWatch logs.
- **OSS models**: Metrics pulled from MLflow.

.. code-block:: python

# Plot all available metrics
df = trainer.show_metrics()

# Plot specific metrics
df = trainer.show_metrics(metrics=["training_loss", "lr"])

# Filter by step range
df = trainer.show_metrics(starting_step=10, ending_step=100)

# Filter by time window
from datetime import datetime
df = trainer.show_metrics(
start_time=datetime(2026, 1, 1, 10, 0, 0),
end_time=datetime(2026, 1, 1, 12, 0, 0),
)

**After a kernel restart:**

.. code-block:: python

# Standalone (SMTJ)
from sagemaker.train import plot_training_metrics
plot_training_metrics("my-sft-job")

# Re-attach (HyperPod — needs cluster name for log group resolution)
from sagemaker.train import SFTTrainer
from sagemaker.core.training.configs import HyperPodCompute

trainer = SFTTrainer(
model="nova-textgeneration-micro",
training_dataset="s3://unused",
compute=HyperPodCompute(cluster_name="my-cluster", instance_type="ml.p5.48xlarge")
)
trainer._latest_training_job = "my-hp-job"
df = trainer.show_metrics()

**Monitoring: stream_logs()**
Stream CloudWatch logs in real-time while a job is running.

.. code-block:: python

# Start training non-blocking
job = trainer.train(wait=False)

# Stream logs (blocks until job completes or Ctrl+C)
trainer.stream_logs()

# Custom polling interval (seconds)
trainer.stream_logs(poll=10)

# Stream from a specific start time - providing this will speed up execution.
from datetime import datetime
trainer.stream_logs(start_time=datetime(2026, 1, 1, 15, 0, 0))

.. note::

- **SMTJ**: Streaming auto-stops when the job reaches a terminal state.
- **HyperPod**: Streaming runs until you press Ctrl+C. Logs may take a few minutes
to propagate to CloudWatch on first run.


----


.. toctree::
:maxdepth: 1
Expand Down