Skip to content

Commit 607059d

Browse files
Shotaro KohamaChoiByungWook
authored andcommitted
Update docstrings of logs_for_job and train methods (#157)
1 parent b925720 commit 607059d

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/sagemaker/session.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -212,8 +212,10 @@ def train(self, image, input_mode, input_config, role, job_name, output_config,
212212
job_name (str): Name of the training job being created.
213213
output_config (dict): The S3 URI where you want to store the training results and optional KMS key ID.
214214
resource_config (dict): Contains values for ResourceConfig:
215-
instance_count (int): Number of EC2 instances to use for training.
216-
instance_type (str): Type of EC2 instance to use for training, for example, 'ml.c4.xlarge'.
215+
* instance_count (int): Number of EC2 instances to use for training.
216+
The key in resource_config is 'InstanceCount'.
217+
* instance_type (str): Type of EC2 instance to use for training, for example, 'ml.c4.xlarge'.
218+
The key in resource_config is 'InstanceType'.
217219
hyperparameters (dict): Hyperparameters for model training. The hyperparameters are made accessible as
218220
a dict[str, str] to the training code on SageMaker. For convenience, this accepts other types for
219221
keys and values, but ``str()`` will be called to convert them before training.
@@ -557,7 +559,7 @@ def logs_for_job(self, job_name, wait=False, poll=10): # noqa: C901 - suppress
557559
558560
Args:
559561
job_name (str): Name of the training job to display the logs for.
560-
wait (bool): Whether to keep looking for new log entries until the job completes (default: True).
562+
wait (bool): Whether to keep looking for new log entries until the job completes (default: False).
561563
poll (int): The interval in seconds between polling for new log entries and job completion (default: 5).
562564
563565
Raises:

0 commit comments

Comments
 (0)