Skip to content
This repository was archived by the owner on Sep 11, 2023. It is now read-only.

Commit 3712f56

Browse files
committed
add function docs
1 parent 2913214 commit 3712f56

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

nowcasting_dataset/manager/manager_live.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,19 @@ class ManagerLive(ManagerBase):
4949
def create_files_specifying_spatial_and_temporal_locations_of_each_example(
5050
self, t0_datetime: datetime, n_gsps: Optional[int] = N_GSPS
5151
) -> None:
52-
"""Creates CSV files specifying the locations of each example if those files don't exist yet.
52+
"""
53+
Creates CSV files specifying the locations of each example if those files don't exist yet.
5354
5455
- Creates one file per split, in this location:
5556
`<output_data.filepath> / 'live' / spatial_and_temporal_locations_of_each_example.csv`
5657
- Creates the output directory if it does not exist.
5758
- This works on any compute environment.
59+
60+
Args:
61+
t0_datetime: The datetime for the batch
62+
n_gsps: the number of gsps we want to make, this is defaulted to N_GSPS=338
63+
64+
Returns: Nothing
5865
"""
5966

6067
logger.info(

0 commit comments

Comments
 (0)