Merge pull request #44 from openclimatefix/jacob/more-linting

Updated all docstrings

Still have flak8 and such to do

Author: jacobbieker

ocf_datapipes/batch/merge_batchml.py

@@ -1,2 +1,3 @@
+"""Convert to BatchML object"""
 from torchdata.datapipes import functional_datapipe
 from torchdata.datapipes.iter import IterDataPipe

ocf_datapipes/batch/merge_numpy_examples_to_batch.py

@@ -1,3 +1,4 @@
+"""Merge individual examples into a batch"""
 from torchdata.datapipes import functional_datapipe
 from torchdata.datapipes.iter import IterDataPipe
 
@@ -7,11 +8,21 @@
 
 @functional_datapipe("merge_numpy_examples_to_batch")
 class MergeNumpyExamplesToBatchIterDataPipe(IterDataPipe):
+    """Merge individual examples into a batch"""
+
     def __init__(self, source_datapipe: IterDataPipe, n_examples_per_batch: int):
+        """
+        Merge individual examples into a batch
+
+        Args:
+            source_datapipe: Datapipe of NumpyBatch data
+            n_examples_per_batch: Number of examples per batch
+        """
         self.source_datapipe = source_datapipe
         self.n_examples_per_batch = n_examples_per_batch
 
     def __iter__(self) -> NumpyBatch:
+        """Merge individual examples into a batch"""
         np_examples = []
         for np_batch in self.source_datapipe:
             np_examples.append(np_batch)

ocf_datapipes/batch/merge_numpy_modalities.py

@@ -1,3 +1,4 @@
+"""Merge multiple modalities together in NumpyBatch"""
 from torchdata.datapipes import functional_datapipe
 from torchdata.datapipes.iter import IterDataPipe, Zipper
 
@@ -6,10 +7,19 @@
 
 @functional_datapipe("merge_numpy_modalities")
 class MergeNumpyModalitiesIterDataPipe(IterDataPipe):
+    """Merge multiple modalities together in NumpyBatch"""
+
     def __init__(self, source_datapipes: [IterDataPipe]):
+        """
+        Merge multiple modalities together in NumpyBatch
+
+        Args:
+            source_datapipes: Set of datapipes to merge emitting NumpyBatch objects
+        """
         self.source_datapipes = source_datapipes
 
     def __iter__(self) -> NumpyBatch:
+        """Merge multiple modalities together in NumpyBatch"""
         for np_batches in Zipper(*self.source_datapipes):
             example: NumpyBatch = {}
             for np_batch in np_batches:

ocf_datapipes/convert/coordinates.py

@@ -1,3 +1,4 @@
+"""Convert coordinates Datapipes"""
 from typing import Union
 
 import xarray as xr

ocf_datapipes/convert/gsp.py

@@ -1,3 +1,4 @@
+"""Convert GSP to Numpy Batch"""
 from torchdata.datapipes import functional_datapipe
 from torchdata.datapipes.iter import IterDataPipe
 

ocf_datapipes/convert/nwp.py

@@ -1,3 +1,4 @@
+"""Convert NWP to NumpyBatch"""
 import numpy as np
 from torchdata.datapipes import functional_datapipe
 from torchdata.datapipes.iter import IterDataPipe

ocf_datapipes/convert/pv.py

@@ -1,3 +1,4 @@
+"""Convert PV to Numpy Batch"""
 import numpy as np
 from torchdata.datapipes import functional_datapipe
 from torchdata.datapipes.iter import IterDataPipe

ocf_datapipes/convert/satellite.py

@@ -1,3 +1,4 @@
+"""Convert Satellite to NumpyBatch"""
 from torchdata.datapipes import functional_datapipe
 from torchdata.datapipes.iter import IterDataPipe
 

ocf_datapipes/experimental/__init__.py

@@ -1,4 +1,7 @@
-"""Collection of experimental datapipes, explicitly not ready for production,
- but can be upgraded later, these might not be tested, and are to make quick experiments easier"""
+"""Experimental Datapipes
+
+Collection of experimental datapipes, explicitly not ready for production,
+but can be upgraded later, these might not be tested, and are to make quick experiments easier
+"""
 from .ensure_n_nwp_variables import EnsureNNWPVariables
 from .set_system_id_to_one import SetSystemIDsToOneIterDataPipe as SetSystemIDsToOne

ocf_datapipes/experimental/ensure_n_nwp_variables.py

@@ -1,5 +1,5 @@
+"""Ensure there are N NWP variables by tiling the data"""
 import numpy as np
-import xarray as xr
 from torchdata.datapipes import functional_datapipe
 from torchdata.datapipes.iter import IterDataPipe
 
@@ -8,11 +8,21 @@
 
 @functional_datapipe("ensure_n_nwp_variables")
 class EnsureNNWPVariables(IterDataPipe):
+    """Ensure there are N NWP variables by tiling the data"""
+
     def __init__(self, source_datapipe: IterDataPipe, num_variables: int):
+        """
+        Ensure there are N NWP variables by tiling the data
+
+        Args:
+            source_datapipe: NumpyBatch emitting NWP datapipe
+            num_variables: Number of variables needed
+        """
         self.source_datapipe = source_datapipe
         self.num_variables = num_variables
 
-    def __iter__(self):
+    def __iter__(self) -> NumpyBatch:
+        """Ensure there are N NWP variables by tiling the data"""
         for np_batch in self.source_datapipe:
             num_tiles = int(np.ceil(self.num_variables / len(np_batch[BatchKey.nwp_channel_names])))
             np_batch[BatchKey.nwp_channel_names] = np.tile(