Add Docstring in SnowStormDataset#868
Add Docstring in SnowStormDataset#868christianlocatelli wants to merge 9 commits intographnet-team:mainfrom
SnowStormDataset#868Conversation
…r _prepare_args. I removed a redundant line for event_counts{} (line 124)
sevmag
left a comment
sevmag
left a comment
There was a problem hiding this comment.
Hey, thanks for the contribution! I left some comments to clarify things further. Once you implement those, this will be a valuable contribution that hopefully leads to more people using this class! :))))))
| https://wiki.icecube.wisc.edu/index.php/SnowStorm_MC#File_Locations | ||
| This is a IceCube Collaboration simulation dataset. | ||
| Requires a username and password. | ||
| This module provides access to the SnowStorm simulation data and prepares it |
There was a problem hiding this comment.
It does not provide access to ALL SnowStorm simulations; it only provides access to a few run_ids (see the global variable AVAILABLE_RUN_IDS). Maybe clarify this in the comment :)
| Requires a username and password. | ||
| This module provides access to the SnowStorm simulation data and prepares it | ||
| for the training and evaluation of deep learning models in GraphNeT by parsing | ||
| the data into the GraphNeT-compatible CuratedDataset format. |
There was a problem hiding this comment.
The data is already parsed in GraphNeT-compatible format (SQLite). The CuratedDataset format is just a convenience wrapper that makes creating Datasets and Dataloaders straightforward. Very minor detail, but to avoid confusio,n you could clarify this :)
|
Hey Severin, thanks for the feedback I'll improve it asap! |
2 participants
I added more Information to the Docstring in
SnowStormDatasetand to the one in the function_prepare_args. I also removed the redundant line event_counts = {}.