doc: JumpStart Utility Doc Update#3866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
knikure merged 14 commits into from
Jun 2, 2023
Merged

doc: JumpStart Utility Doc Update #3866

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
ae2a0d0
JumpStartModel documentation
May 17, 2023
a25e2a6
Remove JS model references
May 17, 2023
1b52f02
Fixed spacing on Python examples
May 17, 2023
700ca26
Low-code deployment doc formatting
May 17, 2023
ae6ebdf
Fixed JS Model docstring formatting
May 17, 2023
009493f
Fixed estimator docstring formatting
May 26, 2023
39672aa
Added fine-tuning steps
May 26, 2023
449ab5e
Finalized deployment text
May 26, 2023
37aa14b
Added fine-tuning utilities
May 26, 2023
b3e7713
Removed trailing whitespaces
May 26, 2023
c87210a
Added new utilities to Utility API docs
Jun 1, 2023
3b37024
Finalized doc feedback and API docstring locations
Jun 1, 2023
004ea79
Fixed link
Jun 1, 2023
d970f91
Fixed newline formatting
Jun 1, 2023
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 doc/api/inference/deserializers.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Deserializers
:members:
:undoc-members:
:show-inheritance:

6 changes: 6 additions & 0 deletions doc/api/inference/model.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,12 @@ Model
:show-inheritance:
:inherited-members:

.. autoclass:: sagemaker.jumpstart.model.JumpStartModel
:members:
:undoc-members:
:show-inheritance:
:inherited-members:

.. autoclass:: sagemaker.model.FrameworkModel
:members:
:undoc-members:
Expand Down
1 change: 1 addition & 0 deletions doc/api/inference/serializers.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Serializers
:members:
:undoc-members:
:show-inheritance:

6 changes: 6 additions & 0 deletions doc/api/training/estimators.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,12 @@ A high level interface for SageMaker training
:show-inheritance:
:inherited-members:

.. autoclass:: sagemaker.jumpstart.estimator.JumpStartEstimator
:members:
:undoc-members:
:show-inheritance:
:inherited-members:

.. autoclass:: sagemaker.estimator.Framework
:members:
:undoc-members:
Expand Down
8 changes: 8 additions & 0 deletions doc/api/utility/accept_types.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Accept Types
------------

.. automodule:: sagemaker.accept_types
:members:
:undoc-members:
:show-inheritance:
:private-members:
8 changes: 8 additions & 0 deletions doc/api/utility/content_types.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Content Types
-------------

.. automodule:: sagemaker.content_types
:members:
:undoc-members:
:show-inheritance:
:private-members:
1 change: 1 addition & 0 deletions doc/api/utility/hyperparameters.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Hyperparameters
:members:
:undoc-members:
:show-inheritance:

8 changes: 8 additions & 0 deletions doc/api/utility/instance_types.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Instance Types
--------------

.. automodule:: sagemaker.instance_types
:members:
:undoc-members:
:show-inheritance:
:private-members:
8 changes: 8 additions & 0 deletions doc/api/utility/metric_definitions.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Metric Definitions
------------------

.. automodule:: sagemaker.metric_definitions
:members:
:undoc-members:
:show-inheritance:
:private-members:
327 changes: 248 additions & 79 deletions doc/overview.rst
View file
Open in desktop

Large diffs are not rendered by default.

43 changes: 18 additions & 25 deletions src/sagemaker/jumpstart/estimator.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -340,6 +340,7 @@ def __init__(
when training on Amazon SageMaker. If 'git_config' is provided,
'source_dir' should be a relative location to a directory in the Git
repo.
(Default: None).

.. admonition:: Example

Expand All@@ -353,7 +354,6 @@ def __init__(
if you need 'train.py'
as the entry point and 'test.py' as the training source code, you can assign
entry_point='train.py', source_dir='src'.
(Default: None).
git_config (Optional[dict[str, str]]): Git configurations used for cloning
files, including ``repo``, ``branch``, ``commit``,
``2FA_enabled``, ``username``, ``password`` and ``token``. The
Expand All@@ -363,18 +363,6 @@ def __init__(
'master' is used. If you don't provide ``commit``, the latest
commit in the specified branch is used.

.. admonition:: Example

The following config:

>>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
>>> 'branch': 'test-branch-git-config',
>>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

results in cloning the repo specified in 'repo', then
checking out the 'master' branch, and checking out the specified
commit.

``2FA_enabled``, ``username``, ``password`` and ``token`` are
used for authentication. For GitHub (or other Git) accounts, set
``2FA_enabled`` to 'True' if two-factor authentication is
Expand DownExpand Up@@ -405,6 +393,17 @@ def __init__(
the SageMaker Python SDK attempts to use either the CodeCommit
credential helper or local credential storage for authentication.
(Default: None).

.. admonition:: Example
The following config:

>>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
>>> 'branch': 'test-branch-git-config',
>>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

results in cloning the repo specified in 'repo', then
checking out the 'master' branch, and checking out the specified
commit.
container_log_level (Optional[Union[int, PipelineVariable]]): The log level to use
within the container. Valid values are defined in the Python logging module.
(Default: None).
Expand All@@ -420,8 +419,9 @@ def __init__(
must point to a file located at the root of ``source_dir``.
If 'git_config' is provided, 'entry_point' should be
a relative location to the Python source file in the Git repo.
(Default: None).

Example:
.. admonition:: Example
With the following GitHub repo directory structure:

>>> |----- README.md
Expand All@@ -430,18 +430,16 @@ def __init__(
>>> |----- test.py

You can assign entry_point='src/train.py'.

(Default: None).
dependencies (Optional[list[str]]): A list of absolute or relative paths to directories
with any additional libraries that should be exported
to the container. The library folders are
copied to SageMaker in the same folder where the entrypoint is
copied. If 'git_config' is provided, 'dependencies' should be a
list of relative locations to directories with any additional
libraries needed in the Git repo.
libraries needed in the Git repo. This is not supported with "local code"
in Local Mode. (Default: None).

.. admonition:: Example

The following Estimator call:

>>> Estimator(entry_point='train.py',
Expand All@@ -455,9 +453,6 @@ def __init__(
>>> |------ train.py
>>> |------ common
>>> |------ virtual-env

This is not supported with "local code" in Local Mode.
(Default: None).
instance_groups (Optional[list[:class:`sagemaker.instance_group.InstanceGroup`]]):
A list of ``InstanceGroup`` objects for launching a training job with a
heterogeneous cluster. For example:
Expand All@@ -475,8 +470,7 @@ def __init__(
through the SageMaker generic and framework estimator classes, see
`Train Using a Heterogeneous Cluster
<https://docs.aws.amazon.com/sagemaker/latest/dg/train-heterogeneous-cluster.html>`_
in the *Amazon SageMaker developer guide*.
(Default: None).
in the *Amazon SageMaker developer guide*. (Default: None).
training_repository_access_mode (Optional[str]): Specifies how SageMaker accesses the
Docker image that contains the training algorithm (Default: None).
Set this to one of the following values:
Expand DownExpand Up@@ -797,7 +791,7 @@ def deploy(
when training on Amazon SageMaker. If 'git_config' is provided,
'source_dir' should be a relative location to a directory in the Git repo.
If the directory points to S3, no code is uploaded and the S3 location
is used instead.
is used instead. (Default: None).

.. admonition:: Example

Expand All@@ -809,7 +803,6 @@ def deploy(
>>> |----- test.py

You can assign entry_point='inference.py', source_dir='src'.
(Default: None).
code_location (Optional[str]): Name of the S3 bucket where custom code is
uploaded (Default: None). If not specified, the default bucket
created by ``sagemaker.session.Session`` is used. (Default: None).
Expand Down
37 changes: 15 additions & 22 deletions src/sagemaker/jumpstart/model.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ def __init__(
when training on Amazon SageMaker. If 'git_config' is provided,
'source_dir' should be a relative location to a directory in the Git repo.
If the directory points to S3, no code is uploaded and the S3 location
is used instead.
is used instead. (Default: None).

.. admonition:: Example

Expand All@@ -150,7 +150,6 @@ def __init__(
>>> |----- test.py

You can assign entry_point='inference.py', source_dir='src'.
(Default: None).
code_location (Optional[str]): Name of the S3 bucket where custom code is
uploaded (Default: None). If not specified, the default bucket
created by ``sagemaker.session.Session`` is used. (Default: None).
Expand All@@ -159,9 +158,9 @@ def __init__(
model hosting. (Default: None). If ``source_dir`` is specified, then ``entry_point``
must point to a file located at the root of ``source_dir``.
If 'git_config' is provided, 'entry_point' should be
a relative location to the Python source file in the Git repo.
a relative location to the Python source file in the Git repo. (Default: None).

Example:
.. admonition:: Example
With the following GitHub repo directory structure:

>>> |----- README.md
Expand All@@ -170,8 +169,6 @@ def __init__(
>>> |----- test.py

You can assign entry_point='src/inference.py'.

(Default: None).
container_log_level (Optional[Union[int, PipelineVariable]]): Log level to use
within the container. Valid values are defined in the Python
logging module. (Default: None).
Expand All@@ -183,7 +180,8 @@ def __init__(
list of relative locations to directories with any additional
libraries needed in the Git repo. If the ```source_dir``` points
to S3, code will be uploaded and the S3 location will be used
instead.
instead. This is not supported with "local code" in Local Mode.
(Default: None).

.. admonition:: Example

Expand All@@ -200,9 +198,6 @@ def __init__(
>>> |------ inference.py
>>> |------ common
>>> |------ virtual-env

This is not supported with "local code" in Local Mode.
(Default: None).
git_config (Optional[dict[str, str]]): Git configurations used for cloning
files, including ``repo``, ``branch``, ``commit``,
``2FA_enabled``, ``username``, ``password`` and ``token``. The
Expand All@@ -212,18 +207,6 @@ def __init__(
'master' is used. If you don't provide ``commit``, the latest
commit in the specified branch is used.

.. admonition:: Example

The following config:

>>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
>>> 'branch': 'test-branch-git-config',
>>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

results in cloning the repo specified in 'repo', then
checking out the 'master' branch, and checking out the specified
commit.

``2FA_enabled``, ``username``, ``password`` and ``token`` are
used for authentication. For GitHub (or other Git) accounts, set
``2FA_enabled`` to 'True' if two-factor authentication is
Expand DownExpand Up@@ -255,6 +238,16 @@ def __init__(
credential helper or local credential storage for authentication.
(Default: None).

.. admonition:: Example

The following config results in cloning the repo specified in 'repo', then
checking out the 'master' branch, and checking out the specified
commit.

>>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
>>> 'branch': 'test-branch-git-config',
>>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

Raises:
ValueError: If the model ID is not recognized by JumpStart.
"""
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
doc: JumpStart Utility Doc Update#3866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

knikure
merged 14 commits into

from

Jun 2, 2023
 Merged


doc: JumpStart Utility Doc Update
#3866
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
ae2a0d0

JumpStartModel documentation

May 17, 2023
a25e2a6

Remove JS model references

May 17, 2023
1b52f02

Fixed spacing on Python examples

May 17, 2023
700ca26

Low-code deployment doc formatting

May 17, 2023
ae6ebdf

Fixed JS Model docstring formatting

May 17, 2023
009493f

Fixed estimator docstring formatting

May 26, 2023
39672aa

Added fine-tuning steps

May 26, 2023
449ab5e

Finalized deployment text

May 26, 2023
37aa14b

Added fine-tuning utilities

May 26, 2023
b3e7713

Removed trailing whitespaces

May 26, 2023
c87210a

Added new utilities to Utility API docs

Jun 1, 2023
3b37024

Finalized doc feedback and API docstring locations

Jun 1, 2023
004ea79

Fixed link

Jun 1, 2023
d970f91

Fixed newline formatting

Jun 1, 2023

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
doc/api/inference/deserializers.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Deserializers
 :members:
 :undoc-members:
 :show-inheritance:


6 changes: 6 additions & 0 deletions
doc/api/inference/model.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,12 @@ Model
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.jumpstart.model.JumpStartModel
 :members:
 :undoc-members:
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.model.FrameworkModel
 :members:
 :undoc-members:
Expand Down

1 change: 1 addition & 0 deletions
doc/api/inference/serializers.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Serializers
 :members:
 :undoc-members:
 :show-inheritance:


6 changes: 6 additions & 0 deletions
doc/api/training/estimators.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,12 @@ A high level interface for SageMaker training
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.jumpstart.estimator.JumpStartEstimator
 :members:
 :undoc-members:
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.estimator.Framework
 :members:
 :undoc-members:
Expand Down

8 changes: 8 additions & 0 deletions
doc/api/utility/accept_types.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Accept Types
------------

.. automodule:: sagemaker.accept_types
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

8 changes: 8 additions & 0 deletions
doc/api/utility/content_types.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Content Types
-------------

.. automodule:: sagemaker.content_types
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

1 change: 1 addition & 0 deletions
doc/api/utility/hyperparameters.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Hyperparameters
 :members:
 :undoc-members:
 :show-inheritance:


8 changes: 8 additions & 0 deletions
doc/api/utility/instance_types.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Instance Types
--------------

.. automodule:: sagemaker.instance_types
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

8 changes: 8 additions & 0 deletions
doc/api/utility/metric_definitions.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Metric Definitions
------------------

.. automodule:: sagemaker.metric_definitions
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

327 changes: 248 additions & 79 deletions
doc/overview.rst

View file


Open in desktop


Large diffs are not rendered by default.


43 changes: 18 additions & 25 deletions
src/sagemaker/jumpstart/estimator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -340,6 +340,7 @@ def __init__(
 when training on Amazon SageMaker. If 'git_config' is provided,
 'source_dir' should be a relative location to a directory in the Git
 repo.
 (Default: None).

 .. admonition:: Example

Expand All@@ -353,7 +354,6 @@ def __init__(
 if you need 'train.py'
 as the entry point and 'test.py' as the training source code, you can assign
 entry_point='train.py', source_dir='src'.
 (Default: None).
 git_config (Optional[dict[str, str]]): Git configurations used for cloning
 files, including ``repo``, ``branch``, ``commit``,
 ``2FA_enabled``, ``username``, ``password`` and ``token``. The
Expand All@@ -363,18 +363,6 @@ def __init__(
 'master' is used. If you don't provide ``commit``, the latest
 commit in the specified branch is used.

 .. admonition:: Example

 The following config:

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.

 ``2FA_enabled``, ``username``, ``password`` and ``token`` are
 used for authentication. For GitHub (or other Git) accounts, set
 ``2FA_enabled`` to 'True' if two-factor authentication is
Expand DownExpand Up@@ -405,6 +393,17 @@ def __init__(
 the SageMaker Python SDK attempts to use either the CodeCommit
 credential helper or local credential storage for authentication.
 (Default: None).

 .. admonition:: Example
 The following config:

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.
 container_log_level (Optional[Union[int, PipelineVariable]]): The log level to use
 within the container. Valid values are defined in the Python logging module.
 (Default: None).
Expand All@@ -420,8 +419,9 @@ def __init__(
 must point to a file located at the root of ``source_dir``.
 If 'git_config' is provided, 'entry_point' should be
 a relative location to the Python source file in the Git repo.
 (Default: None).

Example:
.. admonition:: Example
 With the following GitHub repo directory structure:

 >>> |----- README.md
Expand All@@ -430,18 +430,16 @@ def __init__(
 >>> |----- test.py

 You can assign entry_point='src/train.py'.

 (Default: None).
 dependencies (Optional[list[str]]): A list of absolute or relative paths to directories
 with any additional libraries that should be exported
 to the container. The library folders are
 copied to SageMaker in the same folder where the entrypoint is
 copied. If 'git_config' is provided, 'dependencies' should be a
 list of relative locations to directories with any additional
 libraries needed in the Git repo.
 libraries needed in the Git repo. This is not supported with "local code"
 in Local Mode. (Default: None).

 .. admonition:: Example

 The following Estimator call:

 >>> Estimator(entry_point='train.py',
Expand All@@ -455,9 +453,6 @@ def __init__(
 >>> |------ train.py
 >>> |------ common
 >>> |------ virtual-env

 This is not supported with "local code" in Local Mode.
 (Default: None).
 instance_groups (Optional[list[:class:`sagemaker.instance_group.InstanceGroup`]]):
 A list of ``InstanceGroup`` objects for launching a training job with a
 heterogeneous cluster. For example:
Expand All@@ -475,8 +470,7 @@ def __init__(
 through the SageMaker generic and framework estimator classes, see
 `Train Using a Heterogeneous Cluster
 <https://docs.aws.amazon.com/sagemaker/latest/dg/train-heterogeneous-cluster.html>`_
 in the *Amazon SageMaker developer guide*.
 (Default: None).
 in the *Amazon SageMaker developer guide*. (Default: None).
 training_repository_access_mode (Optional[str]): Specifies how SageMaker accesses the
 Docker image that contains the training algorithm (Default: None).
 Set this to one of the following values:
Expand DownExpand Up@@ -797,7 +791,7 @@ def deploy(
 when training on Amazon SageMaker. If 'git_config' is provided,
 'source_dir' should be a relative location to a directory in the Git repo.
 If the directory points to S3, no code is uploaded and the S3 location
 is used instead.
 is used instead. (Default: None).

 .. admonition:: Example

Expand All@@ -809,7 +803,6 @@ def deploy(
 >>> |----- test.py

 You can assign entry_point='inference.py', source_dir='src'.
 (Default: None).
 code_location (Optional[str]): Name of the S3 bucket where custom code is
 uploaded (Default: None). If not specified, the default bucket
 created by ``sagemaker.session.Session`` is used. (Default: None).
Expand Down

37 changes: 15 additions & 22 deletions
src/sagemaker/jumpstart/model.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ def __init__(
 when training on Amazon SageMaker. If 'git_config' is provided,
 'source_dir' should be a relative location to a directory in the Git repo.
 If the directory points to S3, no code is uploaded and the S3 location
 is used instead.
 is used instead. (Default: None).

 .. admonition:: Example

Expand All@@ -150,7 +150,6 @@ def __init__(
 >>> |----- test.py

 You can assign entry_point='inference.py', source_dir='src'.
 (Default: None).
 code_location (Optional[str]): Name of the S3 bucket where custom code is
 uploaded (Default: None). If not specified, the default bucket
 created by ``sagemaker.session.Session`` is used. (Default: None).
Expand All@@ -159,9 +158,9 @@ def __init__(
 model hosting. (Default: None). If ``source_dir`` is specified, then ``entry_point``
 must point to a file located at the root of ``source_dir``.
 If 'git_config' is provided, 'entry_point' should be
 a relative location to the Python source file in the Git repo.
 a relative location to the Python source file in the Git repo. (Default: None).

Example:
.. admonition:: Example
 With the following GitHub repo directory structure:

 >>> |----- README.md
Expand All@@ -170,8 +169,6 @@ def __init__(
 >>> |----- test.py

 You can assign entry_point='src/inference.py'.

 (Default: None).
 container_log_level (Optional[Union[int, PipelineVariable]]): Log level to use
 within the container. Valid values are defined in the Python
 logging module. (Default: None).
Expand All@@ -183,7 +180,8 @@ def __init__(
 list of relative locations to directories with any additional
 libraries needed in the Git repo. If the ```source_dir``` points
 to S3, code will be uploaded and the S3 location will be used
 instead.
 instead. This is not supported with "local code" in Local Mode.
 (Default: None).

 .. admonition:: Example

Expand All@@ -200,9 +198,6 @@ def __init__(
 >>> |------ inference.py
 >>> |------ common
 >>> |------ virtual-env

 This is not supported with "local code" in Local Mode.
 (Default: None).
 git_config (Optional[dict[str, str]]): Git configurations used for cloning
 files, including ``repo``, ``branch``, ``commit``,
 ``2FA_enabled``, ``username``, ``password`` and ``token``. The
Expand All@@ -212,18 +207,6 @@ def __init__(
 'master' is used. If you don't provide ``commit``, the latest
 commit in the specified branch is used.

 .. admonition:: Example

 The following config:

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.

 ``2FA_enabled``, ``username``, ``password`` and ``token`` are
 used for authentication. For GitHub (or other Git) accounts, set
 ``2FA_enabled`` to 'True' if two-factor authentication is
Expand DownExpand Up@@ -255,6 +238,16 @@ def __init__(
 credential helper or local credential storage for authentication.
 (Default: None).

 .. admonition:: Example

 The following config results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 Raises:
 ValueError: If the model ID is not recognized by JumpStart.
 """
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
doc: JumpStart Utility Doc Update#3866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

knikure
merged 14 commits into

from

Jun 2, 2023
 Merged


doc: JumpStart Utility Doc Update
#3866
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
ae2a0d0

JumpStartModel documentation

May 17, 2023
a25e2a6

Remove JS model references

May 17, 2023
1b52f02

Fixed spacing on Python examples

May 17, 2023
700ca26

Low-code deployment doc formatting

May 17, 2023
ae6ebdf

Fixed JS Model docstring formatting

May 17, 2023
009493f

Fixed estimator docstring formatting

May 26, 2023
39672aa

Added fine-tuning steps

May 26, 2023
449ab5e

Finalized deployment text

May 26, 2023
37aa14b

Added fine-tuning utilities

May 26, 2023
b3e7713

Removed trailing whitespaces

May 26, 2023
c87210a

Added new utilities to Utility API docs

Jun 1, 2023
3b37024

Finalized doc feedback and API docstring locations

Jun 1, 2023
004ea79

Fixed link

Jun 1, 2023
d970f91

Fixed newline formatting

Jun 1, 2023

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
doc/api/inference/deserializers.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Deserializers
 :members:
 :undoc-members:
 :show-inheritance:


6 changes: 6 additions & 0 deletions
doc/api/inference/model.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,12 @@ Model
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.jumpstart.model.JumpStartModel
 :members:
 :undoc-members:
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.model.FrameworkModel
 :members:
 :undoc-members:
Expand Down

1 change: 1 addition & 0 deletions
doc/api/inference/serializers.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Serializers
 :members:
 :undoc-members:
 :show-inheritance:


6 changes: 6 additions & 0 deletions
doc/api/training/estimators.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,12 @@ A high level interface for SageMaker training
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.jumpstart.estimator.JumpStartEstimator
 :members:
 :undoc-members:
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.estimator.Framework
 :members:
 :undoc-members:
Expand Down

8 changes: 8 additions & 0 deletions
doc/api/utility/accept_types.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Accept Types
------------

.. automodule:: sagemaker.accept_types
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

8 changes: 8 additions & 0 deletions
doc/api/utility/content_types.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Content Types
-------------

.. automodule:: sagemaker.content_types
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

1 change: 1 addition & 0 deletions
doc/api/utility/hyperparameters.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Hyperparameters
 :members:
 :undoc-members:
 :show-inheritance:


8 changes: 8 additions & 0 deletions
doc/api/utility/instance_types.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Instance Types
--------------

.. automodule:: sagemaker.instance_types
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

8 changes: 8 additions & 0 deletions
doc/api/utility/metric_definitions.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Metric Definitions
------------------

.. automodule:: sagemaker.metric_definitions
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

327 changes: 248 additions & 79 deletions
doc/overview.rst

View file


Open in desktop


Large diffs are not rendered by default.


43 changes: 18 additions & 25 deletions
src/sagemaker/jumpstart/estimator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -340,6 +340,7 @@ def __init__(
 when training on Amazon SageMaker. If 'git_config' is provided,
 'source_dir' should be a relative location to a directory in the Git
 repo.
 (Default: None).

 .. admonition:: Example

Expand All@@ -353,7 +354,6 @@ def __init__(
 if you need 'train.py'
 as the entry point and 'test.py' as the training source code, you can assign
 entry_point='train.py', source_dir='src'.
 (Default: None).
 git_config (Optional[dict[str, str]]): Git configurations used for cloning
 files, including ``repo``, ``branch``, ``commit``,
 ``2FA_enabled``, ``username``, ``password`` and ``token``. The
Expand All@@ -363,18 +363,6 @@ def __init__(
 'master' is used. If you don't provide ``commit``, the latest
 commit in the specified branch is used.

 .. admonition:: Example

 The following config:

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.

 ``2FA_enabled``, ``username``, ``password`` and ``token`` are
 used for authentication. For GitHub (or other Git) accounts, set
 ``2FA_enabled`` to 'True' if two-factor authentication is
Expand DownExpand Up@@ -405,6 +393,17 @@ def __init__(
 the SageMaker Python SDK attempts to use either the CodeCommit
 credential helper or local credential storage for authentication.
 (Default: None).

 .. admonition:: Example
 The following config:

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.
 container_log_level (Optional[Union[int, PipelineVariable]]): The log level to use
 within the container. Valid values are defined in the Python logging module.
 (Default: None).
Expand All@@ -420,8 +419,9 @@ def __init__(
 must point to a file located at the root of ``source_dir``.
 If 'git_config' is provided, 'entry_point' should be
 a relative location to the Python source file in the Git repo.
 (Default: None).

Example:
.. admonition:: Example
 With the following GitHub repo directory structure:

 >>> |----- README.md
Expand All@@ -430,18 +430,16 @@ def __init__(
 >>> |----- test.py

 You can assign entry_point='src/train.py'.

 (Default: None).
 dependencies (Optional[list[str]]): A list of absolute or relative paths to directories
 with any additional libraries that should be exported
 to the container. The library folders are
 copied to SageMaker in the same folder where the entrypoint is
 copied. If 'git_config' is provided, 'dependencies' should be a
 list of relative locations to directories with any additional
 libraries needed in the Git repo.
 libraries needed in the Git repo. This is not supported with "local code"
 in Local Mode. (Default: None).

 .. admonition:: Example

 The following Estimator call:

 >>> Estimator(entry_point='train.py',
Expand All@@ -455,9 +453,6 @@ def __init__(
 >>> |------ train.py
 >>> |------ common
 >>> |------ virtual-env

 This is not supported with "local code" in Local Mode.
 (Default: None).
 instance_groups (Optional[list[:class:`sagemaker.instance_group.InstanceGroup`]]):
 A list of ``InstanceGroup`` objects for launching a training job with a
 heterogeneous cluster. For example:
Expand All@@ -475,8 +470,7 @@ def __init__(
 through the SageMaker generic and framework estimator classes, see
 `Train Using a Heterogeneous Cluster
 <https://docs.aws.amazon.com/sagemaker/latest/dg/train-heterogeneous-cluster.html>`_
 in the *Amazon SageMaker developer guide*.
 (Default: None).
 in the *Amazon SageMaker developer guide*. (Default: None).
 training_repository_access_mode (Optional[str]): Specifies how SageMaker accesses the
 Docker image that contains the training algorithm (Default: None).
 Set this to one of the following values:
Expand DownExpand Up@@ -797,7 +791,7 @@ def deploy(
 when training on Amazon SageMaker. If 'git_config' is provided,
 'source_dir' should be a relative location to a directory in the Git repo.
 If the directory points to S3, no code is uploaded and the S3 location
 is used instead.
 is used instead. (Default: None).

 .. admonition:: Example

Expand All@@ -809,7 +803,6 @@ def deploy(
 >>> |----- test.py

 You can assign entry_point='inference.py', source_dir='src'.
 (Default: None).
 code_location (Optional[str]): Name of the S3 bucket where custom code is
 uploaded (Default: None). If not specified, the default bucket
 created by ``sagemaker.session.Session`` is used. (Default: None).
Expand Down

37 changes: 15 additions & 22 deletions
src/sagemaker/jumpstart/model.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ def __init__(
 when training on Amazon SageMaker. If 'git_config' is provided,
 'source_dir' should be a relative location to a directory in the Git repo.
 If the directory points to S3, no code is uploaded and the S3 location
 is used instead.
 is used instead. (Default: None).

 .. admonition:: Example

Expand All@@ -150,7 +150,6 @@ def __init__(
 >>> |----- test.py

 You can assign entry_point='inference.py', source_dir='src'.
 (Default: None).
 code_location (Optional[str]): Name of the S3 bucket where custom code is
 uploaded (Default: None). If not specified, the default bucket
 created by ``sagemaker.session.Session`` is used. (Default: None).
Expand All@@ -159,9 +158,9 @@ def __init__(
 model hosting. (Default: None). If ``source_dir`` is specified, then ``entry_point``
 must point to a file located at the root of ``source_dir``.
 If 'git_config' is provided, 'entry_point' should be
 a relative location to the Python source file in the Git repo.
 a relative location to the Python source file in the Git repo. (Default: None).

Example:
.. admonition:: Example
 With the following GitHub repo directory structure:

 >>> |----- README.md
Expand All@@ -170,8 +169,6 @@ def __init__(
 >>> |----- test.py

 You can assign entry_point='src/inference.py'.

 (Default: None).
 container_log_level (Optional[Union[int, PipelineVariable]]): Log level to use
 within the container. Valid values are defined in the Python
 logging module. (Default: None).
Expand All@@ -183,7 +180,8 @@ def __init__(
 list of relative locations to directories with any additional
 libraries needed in the Git repo. If the ```source_dir``` points
 to S3, code will be uploaded and the S3 location will be used
 instead.
 instead. This is not supported with "local code" in Local Mode.
 (Default: None).

 .. admonition:: Example

Expand All@@ -200,9 +198,6 @@ def __init__(
 >>> |------ inference.py
 >>> |------ common
 >>> |------ virtual-env

 This is not supported with "local code" in Local Mode.
 (Default: None).
 git_config (Optional[dict[str, str]]): Git configurations used for cloning
 files, including ``repo``, ``branch``, ``commit``,
 ``2FA_enabled``, ``username``, ``password`` and ``token``. The
Expand All@@ -212,18 +207,6 @@ def __init__(
 'master' is used. If you don't provide ``commit``, the latest
 commit in the specified branch is used.

 .. admonition:: Example

 The following config:

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.

 ``2FA_enabled``, ``username``, ``password`` and ``token`` are
 used for authentication. For GitHub (or other Git) accounts, set
 ``2FA_enabled`` to 'True' if two-factor authentication is
Expand DownExpand Up@@ -255,6 +238,16 @@ def __init__(
 credential helper or local credential storage for authentication.
 (Default: None).

 .. admonition:: Example

 The following config results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 Raises:
 ValueError: If the model ID is not recognized by JumpStart.
 """
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
doc: JumpStart Utility Doc Update#3866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

knikure
merged 14 commits into

from

Jun 2, 2023
 Merged


doc: JumpStart Utility Doc Update
#3866
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
ae2a0d0

JumpStartModel documentation

May 17, 2023
a25e2a6

Remove JS model references

May 17, 2023
1b52f02

Fixed spacing on Python examples

May 17, 2023
700ca26

Low-code deployment doc formatting

May 17, 2023
ae6ebdf

Fixed JS Model docstring formatting

May 17, 2023
009493f

Fixed estimator docstring formatting

May 26, 2023
39672aa

Added fine-tuning steps

May 26, 2023
449ab5e

Finalized deployment text

May 26, 2023
37aa14b

Added fine-tuning utilities

May 26, 2023
b3e7713

Removed trailing whitespaces

May 26, 2023
c87210a

Added new utilities to Utility API docs

Jun 1, 2023
3b37024

Finalized doc feedback and API docstring locations

Jun 1, 2023
004ea79

Fixed link

Jun 1, 2023
d970f91

Fixed newline formatting

Jun 1, 2023

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
doc/api/inference/deserializers.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Deserializers
 :members:
 :undoc-members:
 :show-inheritance:


6 changes: 6 additions & 0 deletions
doc/api/inference/model.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,12 @@ Model
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.jumpstart.model.JumpStartModel
 :members:
 :undoc-members:
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.model.FrameworkModel
 :members:
 :undoc-members:
Expand Down

1 change: 1 addition & 0 deletions
doc/api/inference/serializers.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Serializers
 :members:
 :undoc-members:
 :show-inheritance:


6 changes: 6 additions & 0 deletions
doc/api/training/estimators.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,12 @@ A high level interface for SageMaker training
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.jumpstart.estimator.JumpStartEstimator
 :members:
 :undoc-members:
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.estimator.Framework
 :members:
 :undoc-members:
Expand Down

8 changes: 8 additions & 0 deletions
doc/api/utility/accept_types.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Accept Types
------------

.. automodule:: sagemaker.accept_types
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

8 changes: 8 additions & 0 deletions
doc/api/utility/content_types.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Content Types
-------------

.. automodule:: sagemaker.content_types
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

1 change: 1 addition & 0 deletions
doc/api/utility/hyperparameters.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Hyperparameters
 :members:
 :undoc-members:
 :show-inheritance:


8 changes: 8 additions & 0 deletions
doc/api/utility/instance_types.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Instance Types
--------------

.. automodule:: sagemaker.instance_types
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

8 changes: 8 additions & 0 deletions
doc/api/utility/metric_definitions.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Metric Definitions
------------------

.. automodule:: sagemaker.metric_definitions
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

327 changes: 248 additions & 79 deletions
doc/overview.rst

View file


Open in desktop


Large diffs are not rendered by default.


43 changes: 18 additions & 25 deletions
src/sagemaker/jumpstart/estimator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -340,6 +340,7 @@ def __init__(
 when training on Amazon SageMaker. If 'git_config' is provided,
 'source_dir' should be a relative location to a directory in the Git
 repo.
 (Default: None).

 .. admonition:: Example

Expand All@@ -353,7 +354,6 @@ def __init__(
 if you need 'train.py'
 as the entry point and 'test.py' as the training source code, you can assign
 entry_point='train.py', source_dir='src'.
 (Default: None).
 git_config (Optional[dict[str, str]]): Git configurations used for cloning
 files, including ``repo``, ``branch``, ``commit``,
 ``2FA_enabled``, ``username``, ``password`` and ``token``. The
Expand All@@ -363,18 +363,6 @@ def __init__(
 'master' is used. If you don't provide ``commit``, the latest
 commit in the specified branch is used.

 .. admonition:: Example

 The following config:

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.

 ``2FA_enabled``, ``username``, ``password`` and ``token`` are
 used for authentication. For GitHub (or other Git) accounts, set
 ``2FA_enabled`` to 'True' if two-factor authentication is
Expand DownExpand Up@@ -405,6 +393,17 @@ def __init__(
 the SageMaker Python SDK attempts to use either the CodeCommit
 credential helper or local credential storage for authentication.
 (Default: None).

 .. admonition:: Example
 The following config:

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.
 container_log_level (Optional[Union[int, PipelineVariable]]): The log level to use
 within the container. Valid values are defined in the Python logging module.
 (Default: None).
Expand All@@ -420,8 +419,9 @@ def __init__(
 must point to a file located at the root of ``source_dir``.
 If 'git_config' is provided, 'entry_point' should be
 a relative location to the Python source file in the Git repo.
 (Default: None).

Example:
.. admonition:: Example
 With the following GitHub repo directory structure:

 >>> |----- README.md
Expand All@@ -430,18 +430,16 @@ def __init__(
 >>> |----- test.py

 You can assign entry_point='src/train.py'.

 (Default: None).
 dependencies (Optional[list[str]]): A list of absolute or relative paths to directories
 with any additional libraries that should be exported
 to the container. The library folders are
 copied to SageMaker in the same folder where the entrypoint is
 copied. If 'git_config' is provided, 'dependencies' should be a
 list of relative locations to directories with any additional
 libraries needed in the Git repo.
 libraries needed in the Git repo. This is not supported with "local code"
 in Local Mode. (Default: None).

 .. admonition:: Example

 The following Estimator call:

 >>> Estimator(entry_point='train.py',
Expand All@@ -455,9 +453,6 @@ def __init__(
 >>> |------ train.py
 >>> |------ common
 >>> |------ virtual-env

 This is not supported with "local code" in Local Mode.
 (Default: None).
 instance_groups (Optional[list[:class:`sagemaker.instance_group.InstanceGroup`]]):
 A list of ``InstanceGroup`` objects for launching a training job with a
 heterogeneous cluster. For example:
Expand All@@ -475,8 +470,7 @@ def __init__(
 through the SageMaker generic and framework estimator classes, see
 `Train Using a Heterogeneous Cluster
 <https://docs.aws.amazon.com/sagemaker/latest/dg/train-heterogeneous-cluster.html>`_
 in the *Amazon SageMaker developer guide*.
 (Default: None).
 in the *Amazon SageMaker developer guide*. (Default: None).
 training_repository_access_mode (Optional[str]): Specifies how SageMaker accesses the
 Docker image that contains the training algorithm (Default: None).
 Set this to one of the following values:
Expand DownExpand Up@@ -797,7 +791,7 @@ def deploy(
 when training on Amazon SageMaker. If 'git_config' is provided,
 'source_dir' should be a relative location to a directory in the Git repo.
 If the directory points to S3, no code is uploaded and the S3 location
 is used instead.
 is used instead. (Default: None).

 .. admonition:: Example

Expand All@@ -809,7 +803,6 @@ def deploy(
 >>> |----- test.py

 You can assign entry_point='inference.py', source_dir='src'.
 (Default: None).
 code_location (Optional[str]): Name of the S3 bucket where custom code is
 uploaded (Default: None). If not specified, the default bucket
 created by ``sagemaker.session.Session`` is used. (Default: None).
Expand Down

37 changes: 15 additions & 22 deletions
src/sagemaker/jumpstart/model.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ def __init__(
 when training on Amazon SageMaker. If 'git_config' is provided,
 'source_dir' should be a relative location to a directory in the Git repo.
 If the directory points to S3, no code is uploaded and the S3 location
 is used instead.
 is used instead. (Default: None).

 .. admonition:: Example

Expand All@@ -150,7 +150,6 @@ def __init__(
 >>> |----- test.py

 You can assign entry_point='inference.py', source_dir='src'.
 (Default: None).
 code_location (Optional[str]): Name of the S3 bucket where custom code is
 uploaded (Default: None). If not specified, the default bucket
 created by ``sagemaker.session.Session`` is used. (Default: None).
Expand All@@ -159,9 +158,9 @@ def __init__(
 model hosting. (Default: None). If ``source_dir`` is specified, then ``entry_point``
 must point to a file located at the root of ``source_dir``.
 If 'git_config' is provided, 'entry_point' should be
 a relative location to the Python source file in the Git repo.
 a relative location to the Python source file in the Git repo. (Default: None).

Example:
.. admonition:: Example
 With the following GitHub repo directory structure:

 >>> |----- README.md
Expand All@@ -170,8 +169,6 @@ def __init__(
 >>> |----- test.py

 You can assign entry_point='src/inference.py'.

 (Default: None).
 container_log_level (Optional[Union[int, PipelineVariable]]): Log level to use
 within the container. Valid values are defined in the Python
 logging module. (Default: None).
Expand All@@ -183,7 +180,8 @@ def __init__(
 list of relative locations to directories with any additional
 libraries needed in the Git repo. If the ```source_dir``` points
 to S3, code will be uploaded and the S3 location will be used
 instead.
 instead. This is not supported with "local code" in Local Mode.
 (Default: None).

 .. admonition:: Example

Expand All@@ -200,9 +198,6 @@ def __init__(
 >>> |------ inference.py
 >>> |------ common
 >>> |------ virtual-env

 This is not supported with "local code" in Local Mode.
 (Default: None).
 git_config (Optional[dict[str, str]]): Git configurations used for cloning
 files, including ``repo``, ``branch``, ``commit``,
 ``2FA_enabled``, ``username``, ``password`` and ``token``. The
Expand All@@ -212,18 +207,6 @@ def __init__(
 'master' is used. If you don't provide ``commit``, the latest
 commit in the specified branch is used.

 .. admonition:: Example

 The following config:

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.

 ``2FA_enabled``, ``username``, ``password`` and ``token`` are
 used for authentication. For GitHub (or other Git) accounts, set
 ``2FA_enabled`` to 'True' if two-factor authentication is
Expand DownExpand Up@@ -255,6 +238,16 @@ def __init__(
 credential helper or local credential storage for authentication.
 (Default: None).

 .. admonition:: Example

 The following config results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 Raises:
 ValueError: If the model ID is not recognized by JumpStart.
 """
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
doc: JumpStart Utility Doc Update#3866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

knikure
merged 14 commits into

from

Jun 2, 2023
 Merged


doc: JumpStart Utility Doc Update
#3866
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
ae2a0d0

JumpStartModel documentation

May 17, 2023
a25e2a6

Remove JS model references

May 17, 2023
1b52f02

Fixed spacing on Python examples

May 17, 2023
700ca26

Low-code deployment doc formatting

May 17, 2023
ae6ebdf

Fixed JS Model docstring formatting

May 17, 2023
009493f

Fixed estimator docstring formatting

May 26, 2023
39672aa

Added fine-tuning steps

May 26, 2023
449ab5e

Finalized deployment text

May 26, 2023
37aa14b

Added fine-tuning utilities

May 26, 2023
b3e7713

Removed trailing whitespaces

May 26, 2023
c87210a

Added new utilities to Utility API docs

Jun 1, 2023
3b37024

Finalized doc feedback and API docstring locations

Jun 1, 2023
004ea79

Fixed link

Jun 1, 2023
d970f91

Fixed newline formatting

Jun 1, 2023

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
doc/api/inference/deserializers.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Deserializers
 :members:
 :undoc-members:
 :show-inheritance:


6 changes: 6 additions & 0 deletions
doc/api/inference/model.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,12 @@ Model
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.jumpstart.model.JumpStartModel
 :members:
 :undoc-members:
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.model.FrameworkModel
 :members:
 :undoc-members:
Expand Down

1 change: 1 addition & 0 deletions
doc/api/inference/serializers.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Serializers
 :members:
 :undoc-members:
 :show-inheritance:


6 changes: 6 additions & 0 deletions
doc/api/training/estimators.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,12 @@ A high level interface for SageMaker training
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.jumpstart.estimator.JumpStartEstimator
 :members:
 :undoc-members:
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.estimator.Framework
 :members:
 :undoc-members:
Expand Down

8 changes: 8 additions & 0 deletions
doc/api/utility/accept_types.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Accept Types
------------

.. automodule:: sagemaker.accept_types
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

8 changes: 8 additions & 0 deletions
doc/api/utility/content_types.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Content Types
-------------

.. automodule:: sagemaker.content_types
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

1 change: 1 addition & 0 deletions
doc/api/utility/hyperparameters.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Hyperparameters
 :members:
 :undoc-members:
 :show-inheritance:


8 changes: 8 additions & 0 deletions
doc/api/utility/instance_types.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Instance Types
--------------

.. automodule:: sagemaker.instance_types
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

8 changes: 8 additions & 0 deletions
doc/api/utility/metric_definitions.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Metric Definitions
------------------

.. automodule:: sagemaker.metric_definitions
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

327 changes: 248 additions & 79 deletions
doc/overview.rst

View file


Open in desktop


Large diffs are not rendered by default.


43 changes: 18 additions & 25 deletions
src/sagemaker/jumpstart/estimator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -340,6 +340,7 @@ def __init__(
 when training on Amazon SageMaker. If 'git_config' is provided,
 'source_dir' should be a relative location to a directory in the Git
 repo.
 (Default: None).

 .. admonition:: Example

Expand All@@ -353,7 +354,6 @@ def __init__(
 if you need 'train.py'
 as the entry point and 'test.py' as the training source code, you can assign
 entry_point='train.py', source_dir='src'.
 (Default: None).
 git_config (Optional[dict[str, str]]): Git configurations used for cloning
 files, including ``repo``, ``branch``, ``commit``,
 ``2FA_enabled``, ``username``, ``password`` and ``token``. The
Expand All@@ -363,18 +363,6 @@ def __init__(
 'master' is used. If you don't provide ``commit``, the latest
 commit in the specified branch is used.

 .. admonition:: Example

 The following config:

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.

 ``2FA_enabled``, ``username``, ``password`` and ``token`` are
 used for authentication. For GitHub (or other Git) accounts, set
 ``2FA_enabled`` to 'True' if two-factor authentication is
Expand DownExpand Up@@ -405,6 +393,17 @@ def __init__(
 the SageMaker Python SDK attempts to use either the CodeCommit
 credential helper or local credential storage for authentication.
 (Default: None).

 .. admonition:: Example
 The following config:

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.
 container_log_level (Optional[Union[int, PipelineVariable]]): The log level to use
 within the container. Valid values are defined in the Python logging module.
 (Default: None).
Expand All@@ -420,8 +419,9 @@ def __init__(
 must point to a file located at the root of ``source_dir``.
 If 'git_config' is provided, 'entry_point' should be
 a relative location to the Python source file in the Git repo.
 (Default: None).

Example:
.. admonition:: Example
 With the following GitHub repo directory structure:

 >>> |----- README.md
Expand All@@ -430,18 +430,16 @@ def __init__(
 >>> |----- test.py

 You can assign entry_point='src/train.py'.

 (Default: None).
 dependencies (Optional[list[str]]): A list of absolute or relative paths to directories
 with any additional libraries that should be exported
 to the container. The library folders are
 copied to SageMaker in the same folder where the entrypoint is
 copied. If 'git_config' is provided, 'dependencies' should be a
 list of relative locations to directories with any additional
 libraries needed in the Git repo.
 libraries needed in the Git repo. This is not supported with "local code"
 in Local Mode. (Default: None).

 .. admonition:: Example

 The following Estimator call:

 >>> Estimator(entry_point='train.py',
Expand All@@ -455,9 +453,6 @@ def __init__(
 >>> |------ train.py
 >>> |------ common
 >>> |------ virtual-env

 This is not supported with "local code" in Local Mode.
 (Default: None).
 instance_groups (Optional[list[:class:`sagemaker.instance_group.InstanceGroup`]]):
 A list of ``InstanceGroup`` objects for launching a training job with a
 heterogeneous cluster. For example:
Expand All@@ -475,8 +470,7 @@ def __init__(
 through the SageMaker generic and framework estimator classes, see
 `Train Using a Heterogeneous Cluster
 <https://docs.aws.amazon.com/sagemaker/latest/dg/train-heterogeneous-cluster.html>`_
 in the *Amazon SageMaker developer guide*.
 (Default: None).
 in the *Amazon SageMaker developer guide*. (Default: None).
 training_repository_access_mode (Optional[str]): Specifies how SageMaker accesses the
 Docker image that contains the training algorithm (Default: None).
 Set this to one of the following values:
Expand DownExpand Up@@ -797,7 +791,7 @@ def deploy(
 when training on Amazon SageMaker. If 'git_config' is provided,
 'source_dir' should be a relative location to a directory in the Git repo.
 If the directory points to S3, no code is uploaded and the S3 location
 is used instead.
 is used instead. (Default: None).

 .. admonition:: Example

Expand All@@ -809,7 +803,6 @@ def deploy(
 >>> |----- test.py

 You can assign entry_point='inference.py', source_dir='src'.
 (Default: None).
 code_location (Optional[str]): Name of the S3 bucket where custom code is
 uploaded (Default: None). If not specified, the default bucket
 created by ``sagemaker.session.Session`` is used. (Default: None).
Expand Down

37 changes: 15 additions & 22 deletions
src/sagemaker/jumpstart/model.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ def __init__(
 when training on Amazon SageMaker. If 'git_config' is provided,
 'source_dir' should be a relative location to a directory in the Git repo.
 If the directory points to S3, no code is uploaded and the S3 location
 is used instead.
 is used instead. (Default: None).

 .. admonition:: Example

Expand All@@ -150,7 +150,6 @@ def __init__(
 >>> |----- test.py

 You can assign entry_point='inference.py', source_dir='src'.
 (Default: None).
 code_location (Optional[str]): Name of the S3 bucket where custom code is
 uploaded (Default: None). If not specified, the default bucket
 created by ``sagemaker.session.Session`` is used. (Default: None).
Expand All@@ -159,9 +158,9 @@ def __init__(
 model hosting. (Default: None). If ``source_dir`` is specified, then ``entry_point``
 must point to a file located at the root of ``source_dir``.
 If 'git_config' is provided, 'entry_point' should be
 a relative location to the Python source file in the Git repo.
 a relative location to the Python source file in the Git repo. (Default: None).

Example:
.. admonition:: Example
 With the following GitHub repo directory structure:

 >>> |----- README.md
Expand All@@ -170,8 +169,6 @@ def __init__(
 >>> |----- test.py

 You can assign entry_point='src/inference.py'.

 (Default: None).
 container_log_level (Optional[Union[int, PipelineVariable]]): Log level to use
 within the container. Valid values are defined in the Python
 logging module. (Default: None).
Expand All@@ -183,7 +180,8 @@ def __init__(
 list of relative locations to directories with any additional
 libraries needed in the Git repo. If the ```source_dir``` points
 to S3, code will be uploaded and the S3 location will be used
 instead.
 instead. This is not supported with "local code" in Local Mode.
 (Default: None).

 .. admonition:: Example

Expand All@@ -200,9 +198,6 @@ def __init__(
 >>> |------ inference.py
 >>> |------ common
 >>> |------ virtual-env

 This is not supported with "local code" in Local Mode.
 (Default: None).
 git_config (Optional[dict[str, str]]): Git configurations used for cloning
 files, including ``repo``, ``branch``, ``commit``,
 ``2FA_enabled``, ``username``, ``password`` and ``token``. The
Expand All@@ -212,18 +207,6 @@ def __init__(
 'master' is used. If you don't provide ``commit``, the latest
 commit in the specified branch is used.

 .. admonition:: Example

 The following config:

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.

 ``2FA_enabled``, ``username``, ``password`` and ``token`` are
 used for authentication. For GitHub (or other Git) accounts, set
 ``2FA_enabled`` to 'True' if two-factor authentication is
Expand DownExpand Up@@ -255,6 +238,16 @@ def __init__(
 credential helper or local credential storage for authentication.
 (Default: None).

 .. admonition:: Example

 The following config results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 Raises:
 ValueError: If the model ID is not recognized by JumpStart.
 """
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
doc: JumpStart Utility Doc Update#3866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

knikure
merged 14 commits into

from

Jun 2, 2023
 Merged


doc: JumpStart Utility Doc Update
#3866
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
ae2a0d0

JumpStartModel documentation

May 17, 2023
a25e2a6

Remove JS model references

May 17, 2023
1b52f02

Fixed spacing on Python examples

May 17, 2023
700ca26

Low-code deployment doc formatting

May 17, 2023
ae6ebdf

Fixed JS Model docstring formatting

May 17, 2023
009493f

Fixed estimator docstring formatting

May 26, 2023
39672aa

Added fine-tuning steps

May 26, 2023
449ab5e

Finalized deployment text

May 26, 2023
37aa14b

Added fine-tuning utilities

May 26, 2023
b3e7713

Removed trailing whitespaces

May 26, 2023
c87210a

Added new utilities to Utility API docs

Jun 1, 2023
3b37024

Finalized doc feedback and API docstring locations

Jun 1, 2023
004ea79

Fixed link

Jun 1, 2023
d970f91

Fixed newline formatting

Jun 1, 2023

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
doc/api/inference/deserializers.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Deserializers
 :members:
 :undoc-members:
 :show-inheritance:


6 changes: 6 additions & 0 deletions
doc/api/inference/model.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,12 @@ Model
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.jumpstart.model.JumpStartModel
 :members:
 :undoc-members:
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.model.FrameworkModel
 :members:
 :undoc-members:
Expand Down

1 change: 1 addition & 0 deletions
doc/api/inference/serializers.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Serializers
 :members:
 :undoc-members:
 :show-inheritance:


6 changes: 6 additions & 0 deletions
doc/api/training/estimators.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,12 @@ A high level interface for SageMaker training
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.jumpstart.estimator.JumpStartEstimator
 :members:
 :undoc-members:
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.estimator.Framework
 :members:
 :undoc-members:
Expand Down

8 changes: 8 additions & 0 deletions
doc/api/utility/accept_types.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Accept Types
------------

.. automodule:: sagemaker.accept_types
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

8 changes: 8 additions & 0 deletions
doc/api/utility/content_types.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Content Types
-------------

.. automodule:: sagemaker.content_types
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

1 change: 1 addition & 0 deletions
doc/api/utility/hyperparameters.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Hyperparameters
 :members:
 :undoc-members:
 :show-inheritance:


8 changes: 8 additions & 0 deletions
doc/api/utility/instance_types.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Instance Types
--------------

.. automodule:: sagemaker.instance_types
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

8 changes: 8 additions & 0 deletions
doc/api/utility/metric_definitions.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Metric Definitions
------------------

.. automodule:: sagemaker.metric_definitions
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

327 changes: 248 additions & 79 deletions
doc/overview.rst

View file


Open in desktop


Large diffs are not rendered by default.


43 changes: 18 additions & 25 deletions
src/sagemaker/jumpstart/estimator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -340,6 +340,7 @@ def __init__(
 when training on Amazon SageMaker. If 'git_config' is provided,
 'source_dir' should be a relative location to a directory in the Git
 repo.
 (Default: None).

 .. admonition:: Example

Expand All@@ -353,7 +354,6 @@ def __init__(
 if you need 'train.py'
 as the entry point and 'test.py' as the training source code, you can assign
 entry_point='train.py', source_dir='src'.
 (Default: None).
 git_config (Optional[dict[str, str]]): Git configurations used for cloning
 files, including ``repo``, ``branch``, ``commit``,
 ``2FA_enabled``, ``username``, ``password`` and ``token``. The
Expand All@@ -363,18 +363,6 @@ def __init__(
 'master' is used. If you don't provide ``commit``, the latest
 commit in the specified branch is used.

 .. admonition:: Example

 The following config:

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.

 ``2FA_enabled``, ``username``, ``password`` and ``token`` are
 used for authentication. For GitHub (or other Git) accounts, set
 ``2FA_enabled`` to 'True' if two-factor authentication is
Expand DownExpand Up@@ -405,6 +393,17 @@ def __init__(
 the SageMaker Python SDK attempts to use either the CodeCommit
 credential helper or local credential storage for authentication.
 (Default: None).

 .. admonition:: Example
 The following config:

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.
 container_log_level (Optional[Union[int, PipelineVariable]]): The log level to use
 within the container. Valid values are defined in the Python logging module.
 (Default: None).
Expand All@@ -420,8 +419,9 @@ def __init__(
 must point to a file located at the root of ``source_dir``.
 If 'git_config' is provided, 'entry_point' should be
 a relative location to the Python source file in the Git repo.
 (Default: None).

Example:
.. admonition:: Example
 With the following GitHub repo directory structure:

 >>> |----- README.md
Expand All@@ -430,18 +430,16 @@ def __init__(
 >>> |----- test.py

 You can assign entry_point='src/train.py'.

 (Default: None).
 dependencies (Optional[list[str]]): A list of absolute or relative paths to directories
 with any additional libraries that should be exported
 to the container. The library folders are
 copied to SageMaker in the same folder where the entrypoint is
 copied. If 'git_config' is provided, 'dependencies' should be a
 list of relative locations to directories with any additional
 libraries needed in the Git repo.
 libraries needed in the Git repo. This is not supported with "local code"
 in Local Mode. (Default: None).

 .. admonition:: Example

 The following Estimator call:

 >>> Estimator(entry_point='train.py',
Expand All@@ -455,9 +453,6 @@ def __init__(
 >>> |------ train.py
 >>> |------ common
 >>> |------ virtual-env

 This is not supported with "local code" in Local Mode.
 (Default: None).
 instance_groups (Optional[list[:class:`sagemaker.instance_group.InstanceGroup`]]):
 A list of ``InstanceGroup`` objects for launching a training job with a
 heterogeneous cluster. For example:
Expand All@@ -475,8 +470,7 @@ def __init__(
 through the SageMaker generic and framework estimator classes, see
 `Train Using a Heterogeneous Cluster
 <https://docs.aws.amazon.com/sagemaker/latest/dg/train-heterogeneous-cluster.html>`_
 in the *Amazon SageMaker developer guide*.
 (Default: None).
 in the *Amazon SageMaker developer guide*. (Default: None).
 training_repository_access_mode (Optional[str]): Specifies how SageMaker accesses the
 Docker image that contains the training algorithm (Default: None).
 Set this to one of the following values:
Expand DownExpand Up@@ -797,7 +791,7 @@ def deploy(
 when training on Amazon SageMaker. If 'git_config' is provided,
 'source_dir' should be a relative location to a directory in the Git repo.
 If the directory points to S3, no code is uploaded and the S3 location
 is used instead.
 is used instead. (Default: None).

 .. admonition:: Example

Expand All@@ -809,7 +803,6 @@ def deploy(
 >>> |----- test.py

 You can assign entry_point='inference.py', source_dir='src'.
 (Default: None).
 code_location (Optional[str]): Name of the S3 bucket where custom code is
 uploaded (Default: None). If not specified, the default bucket
 created by ``sagemaker.session.Session`` is used. (Default: None).
Expand Down

37 changes: 15 additions & 22 deletions
src/sagemaker/jumpstart/model.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ def __init__(
 when training on Amazon SageMaker. If 'git_config' is provided,
 'source_dir' should be a relative location to a directory in the Git repo.
 If the directory points to S3, no code is uploaded and the S3 location
 is used instead.
 is used instead. (Default: None).

 .. admonition:: Example

Expand All@@ -150,7 +150,6 @@ def __init__(
 >>> |----- test.py

 You can assign entry_point='inference.py', source_dir='src'.
 (Default: None).
 code_location (Optional[str]): Name of the S3 bucket where custom code is
 uploaded (Default: None). If not specified, the default bucket
 created by ``sagemaker.session.Session`` is used. (Default: None).
Expand All@@ -159,9 +158,9 @@ def __init__(
 model hosting. (Default: None). If ``source_dir`` is specified, then ``entry_point``
 must point to a file located at the root of ``source_dir``.
 If 'git_config' is provided, 'entry_point' should be
 a relative location to the Python source file in the Git repo.
 a relative location to the Python source file in the Git repo. (Default: None).

Example:
.. admonition:: Example
 With the following GitHub repo directory structure:

 >>> |----- README.md
Expand All@@ -170,8 +169,6 @@ def __init__(
 >>> |----- test.py

 You can assign entry_point='src/inference.py'.

 (Default: None).
 container_log_level (Optional[Union[int, PipelineVariable]]): Log level to use
 within the container. Valid values are defined in the Python
 logging module. (Default: None).
Expand All@@ -183,7 +180,8 @@ def __init__(
 list of relative locations to directories with any additional
 libraries needed in the Git repo. If the ```source_dir``` points
 to S3, code will be uploaded and the S3 location will be used
 instead.
 instead. This is not supported with "local code" in Local Mode.
 (Default: None).

 .. admonition:: Example

Expand All@@ -200,9 +198,6 @@ def __init__(
 >>> |------ inference.py
 >>> |------ common
 >>> |------ virtual-env

 This is not supported with "local code" in Local Mode.
 (Default: None).
 git_config (Optional[dict[str, str]]): Git configurations used for cloning
 files, including ``repo``, ``branch``, ``commit``,
 ``2FA_enabled``, ``username``, ``password`` and ``token``. The
Expand All@@ -212,18 +207,6 @@ def __init__(
 'master' is used. If you don't provide ``commit``, the latest
 commit in the specified branch is used.

 .. admonition:: Example

 The following config:

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.

 ``2FA_enabled``, ``username``, ``password`` and ``token`` are
 used for authentication. For GitHub (or other Git) accounts, set
 ``2FA_enabled`` to 'True' if two-factor authentication is
Expand DownExpand Up@@ -255,6 +238,16 @@ def __init__(
 credential helper or local credential storage for authentication.
 (Default: None).

 .. admonition:: Example

 The following config results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 Raises:
 ValueError: If the model ID is not recognized by JumpStart.
 """
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
doc: JumpStart Utility Doc Update#3866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

knikure
merged 14 commits into

from

Jun 2, 2023
 Merged


doc: JumpStart Utility Doc Update
#3866
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
ae2a0d0

JumpStartModel documentation

May 17, 2023
a25e2a6

Remove JS model references

May 17, 2023
1b52f02

Fixed spacing on Python examples

May 17, 2023
700ca26

Low-code deployment doc formatting

May 17, 2023
ae6ebdf

Fixed JS Model docstring formatting

May 17, 2023
009493f

Fixed estimator docstring formatting

May 26, 2023
39672aa

Added fine-tuning steps

May 26, 2023
449ab5e

Finalized deployment text

May 26, 2023
37aa14b

Added fine-tuning utilities

May 26, 2023
b3e7713

Removed trailing whitespaces

May 26, 2023
c87210a

Added new utilities to Utility API docs

Jun 1, 2023
3b37024

Finalized doc feedback and API docstring locations

Jun 1, 2023
004ea79

Fixed link

Jun 1, 2023
d970f91

Fixed newline formatting

Jun 1, 2023

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
doc/api/inference/deserializers.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Deserializers
 :members:
 :undoc-members:
 :show-inheritance:


6 changes: 6 additions & 0 deletions
doc/api/inference/model.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,12 @@ Model
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.jumpstart.model.JumpStartModel
 :members:
 :undoc-members:
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.model.FrameworkModel
 :members:
 :undoc-members:
Expand Down

1 change: 1 addition & 0 deletions
doc/api/inference/serializers.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Serializers
 :members:
 :undoc-members:
 :show-inheritance:


6 changes: 6 additions & 0 deletions
doc/api/training/estimators.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,12 @@ A high level interface for SageMaker training
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.jumpstart.estimator.JumpStartEstimator
 :members:
 :undoc-members:
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.estimator.Framework
 :members:
 :undoc-members:
Expand Down

8 changes: 8 additions & 0 deletions
doc/api/utility/accept_types.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Accept Types
------------

.. automodule:: sagemaker.accept_types
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

8 changes: 8 additions & 0 deletions
doc/api/utility/content_types.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Content Types
-------------

.. automodule:: sagemaker.content_types
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

1 change: 1 addition & 0 deletions
doc/api/utility/hyperparameters.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Hyperparameters
 :members:
 :undoc-members:
 :show-inheritance:


8 changes: 8 additions & 0 deletions
doc/api/utility/instance_types.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Instance Types
--------------

.. automodule:: sagemaker.instance_types
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

8 changes: 8 additions & 0 deletions
doc/api/utility/metric_definitions.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Metric Definitions
------------------

.. automodule:: sagemaker.metric_definitions
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

327 changes: 248 additions & 79 deletions
doc/overview.rst

View file


Open in desktop


Large diffs are not rendered by default.


43 changes: 18 additions & 25 deletions
src/sagemaker/jumpstart/estimator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -340,6 +340,7 @@ def __init__(
 when training on Amazon SageMaker. If 'git_config' is provided,
 'source_dir' should be a relative location to a directory in the Git
 repo.
 (Default: None).

 .. admonition:: Example

Expand All@@ -353,7 +354,6 @@ def __init__(
 if you need 'train.py'
 as the entry point and 'test.py' as the training source code, you can assign
 entry_point='train.py', source_dir='src'.
 (Default: None).
 git_config (Optional[dict[str, str]]): Git configurations used for cloning
 files, including ``repo``, ``branch``, ``commit``,
 ``2FA_enabled``, ``username``, ``password`` and ``token``. The
Expand All@@ -363,18 +363,6 @@ def __init__(
 'master' is used. If you don't provide ``commit``, the latest
 commit in the specified branch is used.

 .. admonition:: Example

 The following config:

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.

 ``2FA_enabled``, ``username``, ``password`` and ``token`` are
 used for authentication. For GitHub (or other Git) accounts, set
 ``2FA_enabled`` to 'True' if two-factor authentication is
Expand DownExpand Up@@ -405,6 +393,17 @@ def __init__(
 the SageMaker Python SDK attempts to use either the CodeCommit
 credential helper or local credential storage for authentication.
 (Default: None).

 .. admonition:: Example
 The following config:

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.
 container_log_level (Optional[Union[int, PipelineVariable]]): The log level to use
 within the container. Valid values are defined in the Python logging module.
 (Default: None).
Expand All@@ -420,8 +419,9 @@ def __init__(
 must point to a file located at the root of ``source_dir``.
 If 'git_config' is provided, 'entry_point' should be
 a relative location to the Python source file in the Git repo.
 (Default: None).

Example:
.. admonition:: Example
 With the following GitHub repo directory structure:

 >>> |----- README.md
Expand All@@ -430,18 +430,16 @@ def __init__(
 >>> |----- test.py

 You can assign entry_point='src/train.py'.

 (Default: None).
 dependencies (Optional[list[str]]): A list of absolute or relative paths to directories
 with any additional libraries that should be exported
 to the container. The library folders are
 copied to SageMaker in the same folder where the entrypoint is
 copied. If 'git_config' is provided, 'dependencies' should be a
 list of relative locations to directories with any additional
 libraries needed in the Git repo.
 libraries needed in the Git repo. This is not supported with "local code"
 in Local Mode. (Default: None).

 .. admonition:: Example

 The following Estimator call:

 >>> Estimator(entry_point='train.py',
Expand All@@ -455,9 +453,6 @@ def __init__(
 >>> |------ train.py
 >>> |------ common
 >>> |------ virtual-env

 This is not supported with "local code" in Local Mode.
 (Default: None).
 instance_groups (Optional[list[:class:`sagemaker.instance_group.InstanceGroup`]]):
 A list of ``InstanceGroup`` objects for launching a training job with a
 heterogeneous cluster. For example:
Expand All@@ -475,8 +470,7 @@ def __init__(
 through the SageMaker generic and framework estimator classes, see
 `Train Using a Heterogeneous Cluster
 <https://docs.aws.amazon.com/sagemaker/latest/dg/train-heterogeneous-cluster.html>`_
 in the *Amazon SageMaker developer guide*.
 (Default: None).
 in the *Amazon SageMaker developer guide*. (Default: None).
 training_repository_access_mode (Optional[str]): Specifies how SageMaker accesses the
 Docker image that contains the training algorithm (Default: None).
 Set this to one of the following values:
Expand DownExpand Up@@ -797,7 +791,7 @@ def deploy(
 when training on Amazon SageMaker. If 'git_config' is provided,
 'source_dir' should be a relative location to a directory in the Git repo.
 If the directory points to S3, no code is uploaded and the S3 location
 is used instead.
 is used instead. (Default: None).

 .. admonition:: Example

Expand All@@ -809,7 +803,6 @@ def deploy(
 >>> |----- test.py

 You can assign entry_point='inference.py', source_dir='src'.
 (Default: None).
 code_location (Optional[str]): Name of the S3 bucket where custom code is
 uploaded (Default: None). If not specified, the default bucket
 created by ``sagemaker.session.Session`` is used. (Default: None).
Expand Down

37 changes: 15 additions & 22 deletions
src/sagemaker/jumpstart/model.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ def __init__(
 when training on Amazon SageMaker. If 'git_config' is provided,
 'source_dir' should be a relative location to a directory in the Git repo.
 If the directory points to S3, no code is uploaded and the S3 location
 is used instead.
 is used instead. (Default: None).

 .. admonition:: Example

Expand All@@ -150,7 +150,6 @@ def __init__(
 >>> |----- test.py

 You can assign entry_point='inference.py', source_dir='src'.
 (Default: None).
 code_location (Optional[str]): Name of the S3 bucket where custom code is
 uploaded (Default: None). If not specified, the default bucket
 created by ``sagemaker.session.Session`` is used. (Default: None).
Expand All@@ -159,9 +158,9 @@ def __init__(
 model hosting. (Default: None). If ``source_dir`` is specified, then ``entry_point``
 must point to a file located at the root of ``source_dir``.
 If 'git_config' is provided, 'entry_point' should be
 a relative location to the Python source file in the Git repo.
 a relative location to the Python source file in the Git repo. (Default: None).

Example:
.. admonition:: Example
 With the following GitHub repo directory structure:

 >>> |----- README.md
Expand All@@ -170,8 +169,6 @@ def __init__(
 >>> |----- test.py

 You can assign entry_point='src/inference.py'.

 (Default: None).
 container_log_level (Optional[Union[int, PipelineVariable]]): Log level to use
 within the container. Valid values are defined in the Python
 logging module. (Default: None).
Expand All@@ -183,7 +180,8 @@ def __init__(
 list of relative locations to directories with any additional
 libraries needed in the Git repo. If the ```source_dir``` points
 to S3, code will be uploaded and the S3 location will be used
 instead.
 instead. This is not supported with "local code" in Local Mode.
 (Default: None).

 .. admonition:: Example

Expand All@@ -200,9 +198,6 @@ def __init__(
 >>> |------ inference.py
 >>> |------ common
 >>> |------ virtual-env

 This is not supported with "local code" in Local Mode.
 (Default: None).
 git_config (Optional[dict[str, str]]): Git configurations used for cloning
 files, including ``repo``, ``branch``, ``commit``,
 ``2FA_enabled``, ``username``, ``password`` and ``token``. The
Expand All@@ -212,18 +207,6 @@ def __init__(
 'master' is used. If you don't provide ``commit``, the latest
 commit in the specified branch is used.

 .. admonition:: Example

 The following config:

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.

 ``2FA_enabled``, ``username``, ``password`` and ``token`` are
 used for authentication. For GitHub (or other Git) accounts, set
 ``2FA_enabled`` to 'True' if two-factor authentication is
Expand DownExpand Up@@ -255,6 +238,16 @@ def __init__(
 credential helper or local credential storage for authentication.
 (Default: None).

 .. admonition:: Example

 The following config results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 Raises:
 ValueError: If the model ID is not recognized by JumpStart.
 """
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
doc: JumpStart Utility Doc Update#3866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

knikure
merged 14 commits into

from

Jun 2, 2023
 Merged


doc: JumpStart Utility Doc Update
#3866
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
ae2a0d0

JumpStartModel documentation

May 17, 2023
a25e2a6

Remove JS model references

May 17, 2023
1b52f02

Fixed spacing on Python examples

May 17, 2023
700ca26

Low-code deployment doc formatting

May 17, 2023
ae6ebdf

Fixed JS Model docstring formatting

May 17, 2023
009493f

Fixed estimator docstring formatting

May 26, 2023
39672aa

Added fine-tuning steps

May 26, 2023
449ab5e

Finalized deployment text

May 26, 2023
37aa14b

Added fine-tuning utilities

May 26, 2023
b3e7713

Removed trailing whitespaces

May 26, 2023
c87210a

Added new utilities to Utility API docs

Jun 1, 2023
3b37024

Finalized doc feedback and API docstring locations

Jun 1, 2023
004ea79

Fixed link

Jun 1, 2023
d970f91

Fixed newline formatting

Jun 1, 2023

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
doc/api/inference/deserializers.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Deserializers
 :members:
 :undoc-members:
 :show-inheritance:


6 changes: 6 additions & 0 deletions
doc/api/inference/model.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,12 @@ Model
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.jumpstart.model.JumpStartModel
 :members:
 :undoc-members:
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.model.FrameworkModel
 :members:
 :undoc-members:
Expand Down

1 change: 1 addition & 0 deletions
doc/api/inference/serializers.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Serializers
 :members:
 :undoc-members:
 :show-inheritance:


6 changes: 6 additions & 0 deletions
doc/api/training/estimators.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,12 @@ A high level interface for SageMaker training
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.jumpstart.estimator.JumpStartEstimator
 :members:
 :undoc-members:
 :show-inheritance:
 :inherited-members:

.. autoclass:: sagemaker.estimator.Framework
 :members:
 :undoc-members:
Expand Down

8 changes: 8 additions & 0 deletions
doc/api/utility/accept_types.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Accept Types
------------

.. automodule:: sagemaker.accept_types
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

8 changes: 8 additions & 0 deletions
doc/api/utility/content_types.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Content Types
-------------

.. automodule:: sagemaker.content_types
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

1 change: 1 addition & 0 deletions
doc/api/utility/hyperparameters.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ Hyperparameters
 :members:
 :undoc-members:
 :show-inheritance:


8 changes: 8 additions & 0 deletions
doc/api/utility/instance_types.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Instance Types
--------------

.. automodule:: sagemaker.instance_types
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

8 changes: 8 additions & 0 deletions
doc/api/utility/metric_definitions.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Metric Definitions
------------------

.. automodule:: sagemaker.metric_definitions
 :members:
 :undoc-members:
 :show-inheritance:
 :private-members:

327 changes: 248 additions & 79 deletions
doc/overview.rst

View file


Open in desktop


Large diffs are not rendered by default.


43 changes: 18 additions & 25 deletions
src/sagemaker/jumpstart/estimator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -340,6 +340,7 @@ def __init__(
 when training on Amazon SageMaker. If 'git_config' is provided,
 'source_dir' should be a relative location to a directory in the Git
 repo.
 (Default: None).

 .. admonition:: Example

Expand All@@ -353,7 +354,6 @@ def __init__(
 if you need 'train.py'
 as the entry point and 'test.py' as the training source code, you can assign
 entry_point='train.py', source_dir='src'.
 (Default: None).
 git_config (Optional[dict[str, str]]): Git configurations used for cloning
 files, including ``repo``, ``branch``, ``commit``,
 ``2FA_enabled``, ``username``, ``password`` and ``token``. The
Expand All@@ -363,18 +363,6 @@ def __init__(
 'master' is used. If you don't provide ``commit``, the latest
 commit in the specified branch is used.

 .. admonition:: Example

 The following config:

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.

 ``2FA_enabled``, ``username``, ``password`` and ``token`` are
 used for authentication. For GitHub (or other Git) accounts, set
 ``2FA_enabled`` to 'True' if two-factor authentication is
Expand DownExpand Up@@ -405,6 +393,17 @@ def __init__(
 the SageMaker Python SDK attempts to use either the CodeCommit
 credential helper or local credential storage for authentication.
 (Default: None).

 .. admonition:: Example
 The following config:

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.
 container_log_level (Optional[Union[int, PipelineVariable]]): The log level to use
 within the container. Valid values are defined in the Python logging module.
 (Default: None).
Expand All@@ -420,8 +419,9 @@ def __init__(
 must point to a file located at the root of ``source_dir``.
 If 'git_config' is provided, 'entry_point' should be
 a relative location to the Python source file in the Git repo.
 (Default: None).

Example:
.. admonition:: Example
 With the following GitHub repo directory structure:

 >>> |----- README.md
Expand All@@ -430,18 +430,16 @@ def __init__(
 >>> |----- test.py

 You can assign entry_point='src/train.py'.

 (Default: None).
 dependencies (Optional[list[str]]): A list of absolute or relative paths to directories
 with any additional libraries that should be exported
 to the container. The library folders are
 copied to SageMaker in the same folder where the entrypoint is
 copied. If 'git_config' is provided, 'dependencies' should be a
 list of relative locations to directories with any additional
 libraries needed in the Git repo.
 libraries needed in the Git repo. This is not supported with "local code"
 in Local Mode. (Default: None).

 .. admonition:: Example

 The following Estimator call:

 >>> Estimator(entry_point='train.py',
Expand All@@ -455,9 +453,6 @@ def __init__(
 >>> |------ train.py
 >>> |------ common
 >>> |------ virtual-env

 This is not supported with "local code" in Local Mode.
 (Default: None).
 instance_groups (Optional[list[:class:`sagemaker.instance_group.InstanceGroup`]]):
 A list of ``InstanceGroup`` objects for launching a training job with a
 heterogeneous cluster. For example:
Expand All@@ -475,8 +470,7 @@ def __init__(
 through the SageMaker generic and framework estimator classes, see
 `Train Using a Heterogeneous Cluster
 <https://docs.aws.amazon.com/sagemaker/latest/dg/train-heterogeneous-cluster.html>`_
 in the *Amazon SageMaker developer guide*.
 (Default: None).
 in the *Amazon SageMaker developer guide*. (Default: None).
 training_repository_access_mode (Optional[str]): Specifies how SageMaker accesses the
 Docker image that contains the training algorithm (Default: None).
 Set this to one of the following values:
Expand DownExpand Up@@ -797,7 +791,7 @@ def deploy(
 when training on Amazon SageMaker. If 'git_config' is provided,
 'source_dir' should be a relative location to a directory in the Git repo.
 If the directory points to S3, no code is uploaded and the S3 location
 is used instead.
 is used instead. (Default: None).

 .. admonition:: Example

Expand All@@ -809,7 +803,6 @@ def deploy(
 >>> |----- test.py

 You can assign entry_point='inference.py', source_dir='src'.
 (Default: None).
 code_location (Optional[str]): Name of the S3 bucket where custom code is
 uploaded (Default: None). If not specified, the default bucket
 created by ``sagemaker.session.Session`` is used. (Default: None).
Expand Down

37 changes: 15 additions & 22 deletions
src/sagemaker/jumpstart/model.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -138,7 +138,7 @@ def __init__(
 when training on Amazon SageMaker. If 'git_config' is provided,
 'source_dir' should be a relative location to a directory in the Git repo.
 If the directory points to S3, no code is uploaded and the S3 location
 is used instead.
 is used instead. (Default: None).

 .. admonition:: Example

Expand All@@ -150,7 +150,6 @@ def __init__(
 >>> |----- test.py

 You can assign entry_point='inference.py', source_dir='src'.
 (Default: None).
 code_location (Optional[str]): Name of the S3 bucket where custom code is
 uploaded (Default: None). If not specified, the default bucket
 created by ``sagemaker.session.Session`` is used. (Default: None).
Expand All@@ -159,9 +158,9 @@ def __init__(
 model hosting. (Default: None). If ``source_dir`` is specified, then ``entry_point``
 must point to a file located at the root of ``source_dir``.
 If 'git_config' is provided, 'entry_point' should be
 a relative location to the Python source file in the Git repo.
 a relative location to the Python source file in the Git repo. (Default: None).

Example:
.. admonition:: Example
 With the following GitHub repo directory structure:

 >>> |----- README.md
Expand All@@ -170,8 +169,6 @@ def __init__(
 >>> |----- test.py

 You can assign entry_point='src/inference.py'.

 (Default: None).
 container_log_level (Optional[Union[int, PipelineVariable]]): Log level to use
 within the container. Valid values are defined in the Python
 logging module. (Default: None).
Expand All@@ -183,7 +180,8 @@ def __init__(
 list of relative locations to directories with any additional
 libraries needed in the Git repo. If the ```source_dir``` points
 to S3, code will be uploaded and the S3 location will be used
 instead.
 instead. This is not supported with "local code" in Local Mode.
 (Default: None).

 .. admonition:: Example

Expand All@@ -200,9 +198,6 @@ def __init__(
 >>> |------ inference.py
 >>> |------ common
 >>> |------ virtual-env

 This is not supported with "local code" in Local Mode.
 (Default: None).
 git_config (Optional[dict[str, str]]): Git configurations used for cloning
 files, including ``repo``, ``branch``, ``commit``,
 ``2FA_enabled``, ``username``, ``password`` and ``token``. The
Expand All@@ -212,18 +207,6 @@ def __init__(
 'master' is used. If you don't provide ``commit``, the latest
 commit in the specified branch is used.

 .. admonition:: Example

 The following config:

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.

 ``2FA_enabled``, ``username``, ``password`` and ``token`` are
 used for authentication. For GitHub (or other Git) accounts, set
 ``2FA_enabled`` to 'True' if two-factor authentication is
Expand DownExpand Up@@ -255,6 +238,16 @@ def __init__(
 credential helper or local credential storage for authentication.
 (Default: None).

 .. admonition:: Example

 The following config results in cloning the repo specified in 'repo', then
 checking out the 'master' branch, and checking out the specified
 commit.

 >>> git_config = {'repo': 'https://github.com/aws/sagemaker-python-sdk.git',
 >>> 'branch': 'test-branch-git-config',
 >>> 'commit': '329bfcf884482002c05ff7f44f62599ebc9f445a'}

 Raises:
 ValueError: If the model ID is not recognized by JumpStart.
 """
Expand Down