Skip to content

feat: update prebuilt models documentation #3186

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
merged 3 commits into from
Jun 22, 2022
Merged

feat: update prebuilt models documentation #3186

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ca17a00
feat: update prebuild models documentation
bencrabtree Jun 21, 2022
58d9462
fix: typos
bencrabtree Jun 21, 2022
3907367
chore: empty pretrainedmodels.rst
bencrabtree Jun 21, 2022
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
Empty file removed doc/doc_utils/jumpstart.rst
View file
Open in desktop
Empty file.
19 changes: 12 additions & 7 deletions doc/doc_utils/jumpstart_doc_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,20 +143,25 @@ def create_jumpstart_model_table():
file_content.append(".. |external-link| raw:: html\n\n")
file_content.append(' <i class="fa fa-external-link"></i>\n\n')

file_content.append("==================================\n")
file_content.append("JumpStart Available Model Table\n")
file_content.append("==================================\n")
file_content.append("================================================\n")
file_content.append("Built-in Algorithms with pre-trained Model Table\n")
file_content.append("================================================\n")
file_content.append(
"""
JumpStart for the SageMaker Python SDK uses model IDs and model versions to access the necessary
utilities. This table serves to provide the core material plus some extra information that can be useful
in selecting the correct model ID and corresponding parameters.\n"""
The SageMaker Python SDK uses model IDs and model versions to access the necessary
utilities for pre-trained models. This table serves to provide the core material plus
some extra information that can be useful in selecting the correct model ID and
corresponding parameters.\n"""
)
file_content.append(
"""
If you want to automatically use the latest version of the model, use "*" for the `model_version` attribute.
We highly suggest pinning an exact model version however.\n"""
)
file_content.append(
"""
These models are also available through the `JumpStart UI in SageMaker Studio <https://docs.aws.amazon.com/sagemaker/latest/dg/studio-jumpstart.html>`__\n"""
)
file_content.append("\n")
file_content.append(".. list-table:: Available Models\n")
file_content.append(" :widths: 50 20 20 20 30 20\n")
Expand All @@ -183,5 +188,5 @@ def create_jumpstart_model_table():
" - `{} <{}>`__ |external-link|\n".format(model_source, model_spec["url"])
)

f = open("doc_utils/jumpstart.rst", "w")
f = open("doc_utils/pretrainedmodels.rst", "w")
f.writelines(file_content)
Loading