Skip to content

Commit 1f9b88f

Browse files
committed
test: update linting
1 parent 4d0bfed commit 1f9b88f

File tree

2 files changed

+45
-30
lines changed

2 files changed

+45
-30
lines changed

doc/conf.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,11 @@
1717
from datetime import datetime
1818
import sys
1919
import os
20-
sys.path.append(os.path.join(os.path.dirname(__file__), '/doc/'))
2120
from jumpstart.utils import create_jumpstart_model_table
2221

23-
project = u"sagemaker"
22+
sys.path.append(os.path.join(os.path.dirname(__file__), "/doc/"))
23+
24+
project = "sagemaker"
2425
version = pkg_resources.require(project)[0].version
2526

2627
# Add any Sphinx extension module names here, as strings. They can be extensions
@@ -42,7 +43,7 @@
4243
source_suffix = ".rst" # The suffix of source filenames.
4344
master_doc = "index" # The master toctree document.
4445

45-
copyright = u"%s, Amazon" % datetime.now().year
46+
copyright = "%s, Amazon" % datetime.now().year
4647

4748
# The full version, including alpha/beta/rc tags.
4849
release = version
@@ -80,7 +81,7 @@
8081
]
8182

8283
html_css_files = [
83-
'https://cdn.datatables.net/1.10.23/css/jquery.dataTables.min.css',
84+
"https://cdn.datatables.net/1.10.23/css/jquery.dataTables.min.css",
8485
]
8586

8687
html_context = {"css_files": ["_static/theme_overrides.css"]}
@@ -94,5 +95,6 @@
9495
# autosectionlabel
9596
autosectionlabel_prefix_document = True
9697

98+
9799
def setup(app):
98-
create_jumpstart_model_table()
100+
create_jumpstart_model_table()

doc/jumpstart/utils.py

Lines changed: 38 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
from __future__ import absolute_import
12
import boto3
23
import json
34
from packaging.version import Version
@@ -21,6 +22,7 @@ def get_jumpstart_sdk_spec(key):
2122
spec = s3_client.get_object(Bucket=JUMPSTART_BUCKET, Key=key)["Body"].read().decode("utf-8")
2223
return json.loads(spec)
2324

25+
2426
def create_jumpstart_model_table():
2527
sdk_manifest = get_jumpstart_sdk_manifest()
2628
sdk_manifest_top_versions_for_models = {}
@@ -29,36 +31,47 @@ def create_jumpstart_model_table():
2931
if model["model_id"] not in sdk_manifest_top_versions_for_models:
3032
sdk_manifest_top_versions_for_models[model["model_id"]] = model
3133
else:
32-
if Version(sdk_manifest_top_versions_for_models[model["model_id"]]["version"]) < Version(
33-
model["version"]
34-
):
34+
if Version(
35+
sdk_manifest_top_versions_for_models[model["model_id"]]["version"]
36+
) < Version(model["version"]):
3537
sdk_manifest_top_versions_for_models[model["model_id"]] = model
3638

3739
f = open("jumpstart/jumpstart.rst", "w")
3840

39-
f.write('==================================\n')
40-
f.write('JumpStart Available Model Table\n')
41-
f.write('==================================\n')
42-
f.write('\n')
43-
f.write('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')
44-
f.write('\n')
45-
f.write('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')
46-
f.write('\n')
47-
f.write('.. list-table:: Available Models\n')
48-
f.write(' :widths: 50 20 20 20\n')
49-
f.write(' :header-rows: 1\n')
50-
f.write(' :class: datatable\n')
51-
f.write('\n')
52-
f.write(' * - Model ID\n')
53-
f.write(' - Fine Tunable?\n')
54-
f.write(' - Latest Version\n')
55-
f.write(' - Min SDK Version\n')
41+
f.write("==================================\n")
42+
f.write("JumpStart Available Model Table\n")
43+
f.write("==================================\n")
44+
f.write("\n")
45+
f.write(
46+
"""
47+
JumpStart for the SageMaker Python SDK uses model ids and model versions to access the necessary
48+
utilities. This table serves to provide the core material plus some extra information that can be useful
49+
in selecting the correct model id and corresponding parameters.\n
50+
"""
51+
)
52+
f.write("\n")
53+
f.write(
54+
"""
55+
If you want to automatically use the latest version of the model, use "*" for the `model_version` attribute.
56+
We highly suggest pinning an exact model version however.\n
57+
"""
58+
)
59+
f.write("\n")
60+
f.write(".. list-table:: Available Models\n")
61+
f.write(" :widths: 50 20 20 20\n")
62+
f.write(" :header-rows: 1\n")
63+
f.write(" :class: datatable\n")
64+
f.write("\n")
65+
f.write(" * - Model ID\n")
66+
f.write(" - Fine Tunable?\n")
67+
f.write(" - Latest Version\n")
68+
f.write(" - Min SDK Version\n")
5669

5770
for model in sorted(sdk_manifest, key=lambda elt: elt["model_id"]):
5871
model_spec = get_jumpstart_sdk_spec(model["spec_key"])
59-
f.write(' * - {}\n'.format(model["model_id"]))
60-
f.write(' - {}\n'.format(model_spec["training_supported"]))
61-
f.write(' - {}\n'.format(model["version"]))
62-
f.write(' - {}\n'.format(model["min_version"]))
72+
f.write(" * - {}\n".format(model["model_id"]))
73+
f.write(" - {}\n".format(model_spec["training_supported"]))
74+
f.write(" - {}\n".format(model["version"]))
75+
f.write(" - {}\n".format(model["min_version"]))
6376

64-
f.close()
77+
f.close()

0 commit comments

Comments
 (0)