linting

Author: bencrabtree

src/sagemaker/jumpstart/curated_hub/accessors/filegenerator.py

@@ -35,9 +35,9 @@ def __init__(
 
     @singledispatchmethod
     def format(self, file_input) -> List[FileInfo]:
-        """Dispatch method that takes in an input of either ``S3ObjectLocation`` or
-        ``JumpStartModelSpecs`` and is implemented in below registered functions.
-        """
+        """Dispatch method that is implemented in below registered functions.
+
+        Takes in an input of either ``S3ObjectLocation`` or ``JumpStartModelSpecs``."""
         # pylint: disable=W0107
         pass
 
@@ -81,10 +81,7 @@ def s3_format(self, file_input: S3ObjectLocation) -> List[FileInfo]:
     def specs_format(
         self, file_input: JumpStartModelSpecs, studio_specs: Dict[str, Any]
     ) -> List[FileInfo]:
-        """
-        Collects data locations from JumpStart public model specs and
-            converts into FileInfo.
-        """
+        """Collects data locations from JumpStart public model specs and converts into FileInfo."""
         public_model_data_accessor = PublicModelDataAccessor(
             region=self.region, model_specs=file_input, studio_specs=studio_specs
         )

src/sagemaker/jumpstart/curated_hub/accessors/sync.py

@@ -26,9 +26,7 @@ class FileSync:
     """Something."""
 
     def __init__(self, src_files: List[FileInfo], dest_files: List[FileInfo], dest_bucket: str):
-        """Instantiates a ``FileSync`` class.
-        Sorts src and dest files by name for easier
-        comparisons.
+        """Instantiates a ``FileSync`` class. Sorts src and dest files by name for comparisons.
 
         Args:
             src_files (List[FileInfo]): List of files to sync with destination
@@ -41,8 +39,7 @@ def __init__(self, src_files: List[FileInfo], dest_files: List[FileInfo], dest_b
         self.dest_bucket = dest_bucket
 
     def call(self) -> Generator[FileInfo, FileInfo, FileInfo]:
-        """This function performs the actual comparisons. Returns a list of FileInfo
-        to copy.
+        """This function performs the actual comparisons. Returns a list of FileInfo to copy.
 
         Algorithm:
             Loop over sorted files in the src directory. If at the end of dest directory,

src/sagemaker/jumpstart/curated_hub/accessors/synccomparator.py

@@ -38,14 +38,16 @@ def determine_should_sync(self, src_file: FileInfo, dest_file: FileInfo) -> bool
         return should_sync
 
     def compare_size(self, src_file: FileInfo, dest_file: FileInfo):
-        """
+        """Compares sizes of src and dest files.
+
         :returns: True if the sizes are the same.
             False otherwise.
         """
         return src_file.size == dest_file.size
 
     def compare_time(self, src_file: FileInfo, dest_file: FileInfo):
-        """
+        """Compares time delta between src and dest files.
+
         :returns: True if the file does not need updating based on time of
             last modification and type of operation.
             False if the file does need updating based on the time of