Browse Source

updated README

niksirbi 10 months ago
parent
commit
67b24b42c4
1 changed files with 46 additions and 0 deletions
  1. 46 0
      README.md

+ 46 - 0
README.md

@@ -1,2 +1,48 @@
 # NeuralPlayground
 
+Hosting data used for tests, examples and tutorials of the [NeuralPlayground](https://github.com/SainsburyWellcomeCentre/NeuralPlayground) project.
+
+All data are stored in the `data` folder, as ZIP archives.
+Each archive contains a single folder, with the same name as the archive.
+For example: `hafting_2008_full.zip` contains the folder `hafting_2008_full`
+
+We currently host experimental datasets and trained models.
+
+## Experimental datasets
+
+These were downloaded from the original sources, and then repackaged for convenience.
+
+All datasets are licensed under the [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) and all credits go to the original authors.
+
+| Name | Source | Versions |
+| --- | --- | --- |
+| `hafting_2008` | [NIRD Research Data Archive](https://archive.norstore.no/pages/public/datasetDetail.jsf?id=C43035A4-5CC5-44F2-B207-126922523FD9) | Provided both in "full" and as a downsized "subset" version |
+| `sargolini_2006` | [NIRD Research Data Archive](https://archive.norstore.no/pages/public/datasetDetail.jsf?id=8F6BE356-3277-475C-87B1-C7A977632DA7) | Provided both in "full" and as a downsized "subset" version |
+| `wernle_2018` | [NIRD Research Data Archive](https://archive.norstore.no/pages/public/datasetDetail.jsf?id=10.11582/2017.00023) | Only provided in "full" |
+
+The "full" ZIP archives were produced by unpacking the original TAR archives (as downloaded from the source) into a folder named as `<author_year>_full`, followed by zipping the folder into `<author_year>_full.zip`.
+
+For some of the larger datasets, we also provide "subset" ZIP archives, named as `<author_year>_subset.zip`. These were produced by the same process as above, but using only a subset of the source data.
+
+ZIP archives:
+- `hafting_2008_full.zip`
+- `hafting_2008_subset.zip` 
+- `sargolini_2006_full.zip` 
+- `sargolini_2006_subset.zip` 
+- `wernle_2018_full.zip`
+
+
+## Trained models
+ZIP archives:
+- `stachenfeld_2018_in_hafting2008`
+- `stachenfeld_2018_in_sargolini2006`
+- `weber_2018_in_hafting2008`
+- `weber_2018_in_merging_room.zip`
+- `weber_2018_in_sargolini2006.zip`
+- `weber_2018_in_simple2D.zip`
+- `weber_2018_in_wernle.zip`
+
+For more information on these models, please refer to the [NeuralPlayground repository on GitHub](https://github.com/SainsburyWellcomeCentre/NeuralPlayground).
+
+## Data integrity
+You can validate the sha256 checksums of ZIP archives against the ones listed in the `sha256sums.txt` file.