Skip to content

Update docstrings of logs_for_job and train methods #157

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 7 commits into from
Apr 26, 2018
Merged

Update docstrings of logs_for_job and train methods #157

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3a7df19
Fix indents of the resource_config docstring
Apr 19, 2018
95a70c6
Fix a default value of session.logs_for_job in docstring
Apr 19, 2018
7e00b40
Use a bulleted list in docstring
Apr 20, 2018
4874c6e
Add descriptions about resource_config keys
Apr 20, 2018
6f7fd42
Merge branch 'master' into fix-session_methods_docs
ChoiByungWook Apr 20, 2018
bb67694
Merge branch 'master' into fix-session_methods_docs
lukmis Apr 25, 2018
48eaa6c
Merge branch 'master' into fix-session_methods_docs
winstonaws Apr 25, 2018
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
6 changes: 3 additions & 3 deletions src/sagemaker/session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,8 +211,8 @@ def train(self, image, input_mode, input_config, role, job_name, output_config,
job_name (str): Name of the training job being created.
output_config (dict): The S3 URI where you want to store the training results and optional KMS key ID.
resource_config (dict): Contains values for ResourceConfig:
instance_count (int): Number of EC2 instances to use for training.
instance_type (str): Type of EC2 instance to use for training, for example, 'ml.c4.xlarge'.
instance_count (int): Number of EC2 instances to use for training.
instance_type (str): Type of EC2 instance to use for training, for example, 'ml.c4.xlarge'.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you put these in a bulleted list?

hyperparameters (dict): Hyperparameters for model training. The hyperparameters are made accessible as
a dict[str, str] to the training code on SageMaker. For convenience, this accepts other types for
keys and values, but ``str()`` will be called to convert them before training.
Expand Down Expand Up @@ -556,7 +556,7 @@ def logs_for_job(self, job_name, wait=False, poll=5): # noqa: C901 - suppress c

Args:
job_name (str): Name of the training job to display the logs for.
wait (bool): Whether to keep looking for new log entries until the job completes (default: True).
wait (bool): Whether to keep looking for new log entries until the job completes (default: False).
poll (int): The interval in seconds between polling for new log entries and job completion (default: 5).

Raises:
Expand Down