ocf-data-sampler 0.0.42__py3-none-any.whl → 0.0.44__py3-none-any.whl

ocf_data_sampler/numpy_sample/collate.py

@@ -8,17 +8,15 @@ logger = logging.getLogger(__name__)
 
 
 
-def stack_np_examples_into_sample(dict_list):
+def stack_np_samples_into_batch(dict_list):
 #     """
-#     Stacks Numpy examples into a sample
-
-#     See also: `unstack_np_sample_into_examples()` for opposite
+#     Stacks Numpy samples into a batch
 
 #     Args:
-#         dict_list: A list of dict-like Numpy examples to stack
+#         dict_list: A list of dict-like Numpy samples to stack
 
 #     Returns:
-#         The stacked NumpySample object
+#         The stacked NumpySample object, aka a batch
 #     """
 
     if not dict_list:

ocf_data_sampler/numpy_sample/gsp.py

@@ -21,7 +21,7 @@ def convert_gsp_to_numpy_sample(da: xr.DataArray, t0_idx: int | None = None) ->
     """Convert from Xarray to NumpySample"""
 
    # Extract values from the DataArray
-    example = {
+    sample = {
         GSPSampleKey.gsp: da.values,
         GSPSampleKey.nominal_capacity_mwp: da.isel(time_utc=0)["nominal_capacity_mwp"].values,
         GSPSampleKey.effective_capacity_mwp: da.isel(time_utc=0)["effective_capacity_mwp"].values,
@@ -29,6 +29,6 @@ def convert_gsp_to_numpy_sample(da: xr.DataArray, t0_idx: int | None = None) ->
     }
 
     if t0_idx is not None:
-        example[GSPSampleKey.t0_idx] = t0_idx
+        sample[GSPSampleKey.t0_idx] = t0_idx
 
-    return example
+    return sample

ocf_data_sampler/numpy_sample/nwp.py

@@ -21,7 +21,7 @@ def convert_nwp_to_numpy_sample(da: xr.DataArray, t0_idx: int | None = None) ->
     """Convert from Xarray to NWP NumpySample"""
     
     # Create example and add t if available
-    example = {
+    sample = {
         NWPSampleKey.nwp: da.values,
         NWPSampleKey.channel_names: da.channel.values,
         NWPSampleKey.init_time_utc: da.init_time_utc.values.astype(float),
@@ -29,14 +29,14 @@ def convert_nwp_to_numpy_sample(da: xr.DataArray, t0_idx: int | None = None) ->
     }
 
     if "target_time_utc" in da.coords:
-        example[NWPSampleKey.target_time_utc] = da.target_time_utc.values.astype(float)
+        sample[NWPSampleKey.target_time_utc] = da.target_time_utc.values.astype(float)
 
     # TODO: Do we need this at all? Especially since it is only present in UKV data
     for sample_key, dataset_key in ((NWPSampleKey.y_osgb, "y_osgb"),(NWPSampleKey.x_osgb, "x_osgb"),):
         if dataset_key in da.coords:
-            example[sample_key] = da[dataset_key].values
+            sample[sample_key] = da[dataset_key].values
 
     if t0_idx is not None:
-        example[NWPSampleKey.t0_idx] = t0_idx
+        sample[NWPSampleKey.t0_idx] = t0_idx
         
-    return example
+    return sample

ocf_data_sampler/numpy_sample/satellite.py

@@ -13,7 +13,7 @@ class SatelliteSampleKey:
 
 def convert_satellite_to_numpy_sample(da: xr.DataArray, t0_idx: int | None = None) -> dict:
     """Convert from Xarray to NumpySample"""
-    example = {
+    sample = {
         SatelliteSampleKey.satellite_actual: da.values,
         SatelliteSampleKey.time_utc: da.time_utc.values.astype(float),
     }
@@ -22,9 +22,9 @@ def convert_satellite_to_numpy_sample(da: xr.DataArray, t0_idx: int | None = Non
          (SatelliteSampleKey.x_geostationary, "x_geostationary"),
         (SatelliteSampleKey.y_geostationary, "y_geostationary"),
     ):
-        example[sample_key] = da[dataset_key].values
+        sample[sample_key] = da[dataset_key].values
 
     if t0_idx is not None:
-        example[SatelliteSampleKey.t0_idx] = t0_idx
+        sample[SatelliteSampleKey.t0_idx] = t0_idx
 
-    return example
+    return sample

ocf_data_sampler/numpy_sample/site.py

@@ -18,13 +18,13 @@ def convert_site_to_numpy_sample(da: xr.DataArray, t0_idx: int | None = None) ->
     """Convert from Xarray to NumpySample"""
 
     # Extract values from the DataArray
-    example = {
+    sample = {
         SiteSampleKey.generation: da.values,
         SiteSampleKey.capacity_kwp: da.isel(time_utc=0)["capacity_kwp"].values,
         SiteSampleKey.time_utc: da["time_utc"].values.astype(float),
     }
 
     if t0_idx is not None:
-        example[SiteSampleKey.t0_idx] = t0_idx
+        sample[SiteSampleKey.t0_idx] = t0_idx
 
-    return example
+    return sample

{ocf_data_sampler-0.0.42.dist-info → ocf_data_sampler-0.0.44.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ocf_data_sampler
-Version: 0.0.42
+Version: 0.0.44
 Summary: Sample from weather data for renewable energy prediction
 Author: James Fulton, Peter Dudfield, and the Open Climate Fix team
 Author-email: info@openclimatefix.org
@@ -56,7 +56,7 @@ Requires-Dist: mkdocs-material>=8.0; extra == "docs"
 # ocf-data-sampler
  
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-9-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 [![tags badge](https://img.shields.io/github/v/tag/openclimatefix/ocf-data-sampler?include_prereleases&sort=semver&color=FFAC5F)](https://github.com/openclimatefix/ocf-data-sampler/tags)
@@ -134,6 +134,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/felix-e-h-p"><img src="https://avatars.githubusercontent.com/u/137530077?v=4?s=100" width="100px;" alt="Felix"/><br /><sub><b>Felix</b></sub></a><br /><a href="https://github.com/openclimatefix/ocf-data-sampler/commits?author=felix-e-h-p" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://timothyajaniportfolio-b6v3zq29k-timthegreat.vercel.app/"><img src="https://avatars.githubusercontent.com/u/60073728?v=4?s=100" width="100px;" alt="Ajani Timothy"/><br /><sub><b>Ajani Timothy</b></sub></a><br /><a href="https://github.com/openclimatefix/ocf-data-sampler/commits?author=Tim1119" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://rupeshmangalam.vercel.app/"><img src="https://avatars.githubusercontent.com/u/91172425?v=4?s=100" width="100px;" alt="Rupesh Mangalam"/><br /><sub><b>Rupesh Mangalam</b></sub></a><br /><a href="https://github.com/openclimatefix/ocf-data-sampler/commits?author=RupeshMangalam21" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>

{ocf_data_sampler-0.0.42.dist-info → ocf_data_sampler-0.0.44.dist-info}/RECORD

@@ -19,11 +19,11 @@ ocf_data_sampler/load/nwp/providers/ecmwf.py,sha256=2iR1Iy542lo51rC6XFLV-3pbUE68
 ocf_data_sampler/load/nwp/providers/ukv.py,sha256=79Bm7q-K_GJPYMy62SUIZbRWRF4-tIaB1dYPEgLD9vo,1207
 ocf_data_sampler/load/nwp/providers/utils.py,sha256=Sy2exG1wpXLLhMXYdsfR-DZMR3txG1_bBmBdchlc-yA,848
 ocf_data_sampler/numpy_sample/__init__.py,sha256=jWvN4BDYAgoFkdGBxjNrYioZdZNVbIcP4RsNGJCEGm0,345
-ocf_data_sampler/numpy_sample/collate.py,sha256=RSG6wedj31qMTO9I31fXRfcZd-PU8YSy1su4XHF0g10,2285
-ocf_data_sampler/numpy_sample/gsp.py,sha256=4ZckEN7S82UY36e9z6rp5DTp10SAn_cNISBNilpOADw,1008
-ocf_data_sampler/numpy_sample/nwp.py,sha256=eEIRXP09wY99Vq-ItnfQ6U9AY1vJPLYKfUOc83V6ICo,1302
-ocf_data_sampler/numpy_sample/satellite.py,sha256=WYG9_ryOk3RWHWjgcMjIaU-YahEhTXz2xN0rQm-_TTQ,914
-ocf_data_sampler/numpy_sample/site.py,sha256=E2MQKkgUXikbIlKYU4ueNCPoBYJC-vnkbrQ_IwP2hqw,792
+ocf_data_sampler/numpy_sample/collate.py,sha256=y8QFUhskaAfOMP22aVkexwyGAwLHbNE-q1pOZ6txWKA,2227
+ocf_data_sampler/numpy_sample/gsp.py,sha256=5UaWO_aGRRVQo82wnDaT4zBKHihOnIsXiwgPjM8vGFM,1005
+ocf_data_sampler/numpy_sample/nwp.py,sha256=_seQNWsut3IzPsrpipqImjnaM3XNHZCy5_5be6syivk,1297
+ocf_data_sampler/numpy_sample/satellite.py,sha256=8OaTvkPjzSjotcdKsa6BKmmlBKDBunbhDN4Pjo0Grxs,910
+ocf_data_sampler/numpy_sample/site.py,sha256=PIfmCtPA37dqpC8GArkryVqFrNAwqacj0iW2ikBOdSk,789
 ocf_data_sampler/numpy_sample/sun_position.py,sha256=UklhucCxCT6GMlAhCWL6c4cfWrdc1cWgegrYaqUoHOY,1611
 ocf_data_sampler/select/__init__.py,sha256=E4AJulEbO2K-o0UlG1fgaEteuf_1ZFjHTvrotXSb4YU,332
 ocf_data_sampler/select/dropout.py,sha256=HCx5Wzk8Oh2Z9vV94Jy-ALJsHtGduwvMaQOleQXp5z0,1142
@@ -49,7 +49,7 @@ tests/load/test_load_gsp.py,sha256=aT_nqaSXmUTcdHzuTT7AmXJr3R31k4OEN-Fv3eLxlQE,4
 tests/load/test_load_nwp.py,sha256=3qyyDkB1q9t3tyAwogfotNrxqUOpXXimco1CImoEWGg,753
 tests/load/test_load_satellite.py,sha256=STX5AqqmOAgUgE9R1xyq_sM3P1b8NKdGjO-hDhayfxM,524
 tests/load/test_load_sites.py,sha256=T9lSEnGPI8FQISudVYHHNTHeplNS62Vrx48jaZ6J_Jo,364
-tests/numpy_sample/test_collate.py,sha256=Oks9YxLBRX1Abz9wwGO36VT4-ftYxlDKVIQ9ra7xrhY,851
+tests/numpy_sample/test_collate.py,sha256=oWVNRR0LyF0iqaxjsq6hPMmkSGIyvGVlAM6q2rqvXqQ,840
 tests/numpy_sample/test_gsp.py,sha256=FLlq4SlJ-9cSRAepf4_ksA6PsUVKegnKEAc5pUojCJ0,1458
 tests/numpy_sample/test_nwp.py,sha256=yf4u7mAU0E3FQ4xAH6YjuHuHBzzFoXjHSFNkOVJUdSM,1455
 tests/numpy_sample/test_satellite.py,sha256=cCqtn5See-uSNfh89COGTUQNuFm6sIZ8QmBVHsuUeRI,1189
@@ -64,8 +64,8 @@ tests/torch_datasets/conftest.py,sha256=eRCzHE7cxS4AoskExkCGFDBeqItktAYNAdkfpMoF
 tests/torch_datasets/test_process_and_combine.py,sha256=mbjQdqzLhox-U2sc1Ec68xLz95b3XOyPa7WchgxUM88,4256
 tests/torch_datasets/test_pvnet_uk_regional.py,sha256=dLY861PMyQ_buTksP8d0UXzfKsZ_CFNgceSYVGXRIRs,2134
 tests/torch_datasets/test_site.py,sha256=TSmdpD0OFid6e8eRgeB5FGxglUN1L2t4cIuMTfjA7jE,4539
-ocf_data_sampler-0.0.42.dist-info/LICENSE,sha256=F-Q3UFCR-BECSocV55BFDpn4YKxve9PKrm-lTt6o_Tg,1073
-ocf_data_sampler-0.0.42.dist-info/METADATA,sha256=tLh8ajGI3CLruw5ZEasx7beUa3FiKs_fXSg9cRexgdQ,11055
-ocf_data_sampler-0.0.42.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-ocf_data_sampler-0.0.42.dist-info/top_level.txt,sha256=Faob6N6cFdPc5eUpCTYcXgCaNhi4XLLteUL5W5ayYmg,31
-ocf_data_sampler-0.0.42.dist-info/RECORD,,
+ocf_data_sampler-0.0.44.dist-info/LICENSE,sha256=F-Q3UFCR-BECSocV55BFDpn4YKxve9PKrm-lTt6o_Tg,1073
+ocf_data_sampler-0.0.44.dist-info/METADATA,sha256=DXdwieKe_o3sJ5BSZ8-zN8xawG3_1YDLQRHqgWV89xM,11431
+ocf_data_sampler-0.0.44.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+ocf_data_sampler-0.0.44.dist-info/top_level.txt,sha256=Faob6N6cFdPc5eUpCTYcXgCaNhi4XLLteUL5W5ayYmg,31
+ocf_data_sampler-0.0.44.dist-info/RECORD,,

tests/numpy_sample/test_collate.py

@@ -1,5 +1,5 @@
 from ocf_data_sampler.numpy_sample import GSPSampleKey, SatelliteSampleKey
-from ocf_data_sampler.numpy_sample.collate import stack_np_examples_into_sample
+from ocf_data_sampler.numpy_sample.collate import stack_np_samples_into_batch
 from ocf_data_sampler.torch_datasets import PVNetUKRegionalDataset
 
 
@@ -16,11 +16,11 @@ def test_pvnet(pvnet_config_filename):
     sample1 = dataset[0]
     sample2 = dataset[1]
 
-    sample = stack_np_examples_into_sample([sample1, sample2])
+    batch = stack_np_samples_into_batch([sample1, sample2])
 
-    assert isinstance(sample, dict)
-    assert "nwp" in sample
-    assert isinstance(sample["nwp"], dict)
-    assert "ukv" in sample["nwp"]
-    assert GSPSampleKey.gsp in sample
-    assert SatelliteSampleKey.satellite_actual in sample
+    assert isinstance(batch, dict)
+    assert "nwp" in batch
+    assert isinstance(batch["nwp"], dict)
+    assert "ukv" in batch["nwp"]
+    assert GSPSampleKey.gsp in batch
+    assert SatelliteSampleKey.satellite_actual in batch