diff --git a/README.md b/README.md index bc85e80..14d8526 100644 --- a/README.md +++ b/README.md @@ -77,6 +77,55 @@ pip install git+https://github.com/brianreicher/autoseg.git ### Usage +This package is used for training, predicting, & evaluating deep learning segmentation models. The models are compatible with Zarr & N5 chunked image files, and volumes should be stored in the following format: + +``` +your_dataset.zarr/ +|-- volumes/ +| |-- training_raw/ +| | |-- 0/ +| | | |-- +| | | |-- +| | | | ... +| | |-- 1/ +| | ... +|-- training_labels/ +| |-- 0/ +| | |-- +| | |-- +| | | ... +| |-- 1/ +| ... +|-- training_labels_masked/ +| |-- 0/ +| | |-- +| | |-- +| | | ... +| |-- 1/ +| ... +|-- training_labels_unmasked/ + |-- 0/ + | |-- + | |-- Config { - // Load configuration from JSON file let config_str = std::fs::read_to_string(config_path).expect("Error reading config file"); serde_json::from_str(&config_str).expect("Error parsing JSON") }