Skip to content

Commit 6081ff4

Browse files
committed
Add reference to test data in docs
1 parent b8a03df commit 6081ff4

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/examples/input_data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The `speckcn2` tool expects a set of **2D black-and-white squared** images along with their corresponding prediction labels.
44
In its main application, these images are speckle patterns, and the values represent turbulence strength. However, the tool can be adapted for any image regression task, as long as the data is provided in the correct format.
55

6-
Given the large amount of data, we use **hdf5** format for optimal storage.
6+
Given the large amount of data, we use **hdf5** format for optimal storage. You can find a small dataset in the [example submodule](https://github.com/MALES-project/examples_speckcn2) (`./data`), that you can use for testing.
77

88
Each image should be saved in a separate hdf5 file named `<NAME>-<ID>.h5`. The corresponding prediction value should be stored in a file named `<NAME>_label.h5`. Images with no corresponding label will be ignored.
99
Here, `<NAME>` is a common name for the dataset, so we can use `<NAME>='speckle_xxx'` for speckle patterns.

0 commit comments

Comments
 (0)