Skip to content

Commit ca17a00

Browse files
committed
feat: update prebuild models documentation
1 parent 8522425 commit ca17a00

File tree

4 files changed

+2125
-77
lines changed

4 files changed

+2125
-77
lines changed

doc/doc_utils/jumpstart.rst

Whitespace-only changes.

doc/doc_utils/jumpstart_doc_utils.py

+12-7
Original file line numberDiff line numberDiff line change
@@ -143,20 +143,25 @@ def create_jumpstart_model_table():
143143
file_content.append(".. |external-link| raw:: html\n\n")
144144
file_content.append(' <i class="fa fa-external-link"></i>\n\n')
145145

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

186-
f = open("doc_utils/jumpstart.rst", "w")
191+
f = open("doc_utils/pretrainedmodels.rst", "w")
187192
f.writelines(file_content)

0 commit comments

Comments
 (0)