Doc updates and style updates

Author: Dan Choi

src/sagemaker/job.py

@@ -17,9 +17,16 @@
 
 
 class _Job(object):
-    def __init__(self, sagemaker_session, training_job_name):
+    """Handles creating, starting and waiting for Amazon SageMaker jobs to finish.
+
+    This class shouldn't be directly instantiated.
+
+    Subclasses must define a way to create, start and wait for an Amazon SageMaker job.
+    """
+
+    def __init__(self, sagemaker_session, job_name):
         self.sagemaker_session = sagemaker_session
-        self.job_name = training_job_name
+        self.job_name = job_name
 
     @abstractmethod
     def start_new(cls, estimator, inputs):
@@ -30,9 +37,14 @@ def start_new(cls, estimator, inputs):
             inputs (str): Parameters used when called  :meth:`~sagemaker.estimator.EstimatorBase.fit`.
 
         Returns:
-            sagemaker.estimator.Framework: Constructed object that captures all information about the started job.
+            sagemaker.job: Constructed object that captures all information about the started job.
         """
+        pass
 
+    @abstractmethod
+    def wait(self):
+        """Wait for the Amazon SageMaker job to finish.
+        """
         pass
 
     @staticmethod
@@ -88,22 +100,14 @@ def _prepare_output_config(s3_path, kms_key_id):
 
     @staticmethod
     def _prepare_resource_config(instance_count, instance_type, volume_size):
-        resource_config = {'InstanceCount': instance_count,
-                           'InstanceType': instance_type,
-                           'VolumeSizeInGB': volume_size}
-        return resource_config
+        return {'InstanceCount': instance_count,
+                'InstanceType': instance_type,
+                'VolumeSizeInGB': volume_size}
 
     @staticmethod
     def _prepare_stopping_condition(max_run):
-        stop_condition = {'MaxRuntimeInSeconds': max_run}
-        return stop_condition
+        return {'MaxRuntimeInSeconds': max_run}
 
     @property
     def name(self):
         return self.job_name
-
-    def wait(self, logs=True):
-        if logs:
-            self.sagemaker_session.logs_for_job(self.job_name, wait=True)
-        else:
-            self.sagemaker_session.wait_for_job(self.job_name)