Skip to content

doc: include FrameworkModel and ModelPackage in API docs #833

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 2 commits into from
Jun 10, 2019
Merged

doc: include FrameworkModel and ModelPackage in API docs #833

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
57522a5
doc: include FrameworkModel and ModelPackage in API docs
laurenyu Jun 5, 2019
11e31b4
Merge branch 'master' into model-docs
laurenyu Jun 9, 2019
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
10 changes: 10 additions & 0 deletions doc/model.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,13 @@ Model
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: sagemaker.model.FrameworkModel
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: sagemaker.model.ModelPackage
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion src/sagemaker/model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,7 @@ def __init__(self, model_data, image, role, entry_point, source_dir=None, predic
entry_point (str): Path (absolute or relative) to the Python source file which should be executed
as the entry point to model hosting. This should be compatible with either Python 2.7 or Python 3.5.
source_dir (str): Path (absolute or relative) to a directory with any other training
source code dependencies aside from tne entry point file (default: None). Structure within this
source code dependencies aside from the entry point file (default: None). Structure within this
directory will be preserved when training on SageMaker.
If the directory points to S3, no code will be uploaded and the S3 location will be used instead.
dependencies (list[str]): A list of paths to directories (absolute or relative) with
Expand Down