From 356e28c31fd2318657400603c7e6d651a86e1f34 Mon Sep 17 00:00:00 2001 From: Yin Li Date: Tue, 21 Apr 2020 12:34:14 -0400 Subject: [PATCH] Add TOC --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0775332..d8757cc 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,16 @@ Neural network emulators to transform field/map data +* [Installation](#installation) +* [Usage](#usage) + * [Data](#data) + * [Data normalization](#data-normalization) + * [Model](#model) + * [Training](#training) + * [Files generated](#files-generated) + * [Tracking](#tracking) + + ## Installation Install in editable mode @@ -17,7 +27,7 @@ Take a look at the examples in `scripts/*.slurm`, and the command line options in `map2map/args.py` or by `m2m.py -h`. -### data +### Data Structure your data to start with the channel axis and then the spatial dimensions. @@ -25,13 +35,13 @@ Put each sample in one file. Specify the data path with glob patterns. -#### data normalization +#### Data normalization Input and target (output) data can be normalized by functions defined in `map2map2/data/norms/`. -### model +### Model Find the models in `map2map/models/`. Customize the existing models, or add new models there and edit the `__init__.py`.