Aquila-Consortium/map2map
32
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix README order

Browse Source
This commit is contained in:
Yin Li 2020-06-14 18:13:34 -04:00
parent b1b3dbe41c
commit c3877ae982
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -7,10 +7,10 @@ Neural network emulators to transform field/map data
* [Data](#data) * [Data](#data)
* [Data normalization](#data-normalization) * [Data normalization](#data-normalization)
* [Model](#model) * [Model](#model)
* [Customization](#customization)
* [Training](#training) * [Training](#training)
* [Files generated](#files-generated) * [Files generated](#files-generated)
* [Tracking](#tracking) * [Tracking](#tracking)
* [Customization](#customization)
## Installation ## Installation
@ -67,20 +67,6 @@ follow [Customization](#customization).
### Training ### Training
### Customization
Models, criteria, optimizers and data normalizations can be customized
without modifying map2map.
They can be implemented as callbacks in a user directory which is then
passed by `--callback-at`.
The default locations are searched first before the callback directory.
So be aware of name collisions.
This approach is good for experimentation.
For example, one can play with a model `Bar` in `./foo.py`, by calling
`m2m.py` with `--model foo.Bar --callback-at .`
#### Files generated #### Files generated
* `*.out`: job stdout and stderr * `*.out`: job stdout and stderr
@ -101,3 +87,17 @@ tensorboard --logdir PATH --samples_per_plugin images=IMAGES --port PORT
directory for tensorboard to search recursively for multiple jobs. directory for tensorboard to search recursively for multiple jobs.
* Show `IMAGES` images, or all of them by setting it to 0. * Show `IMAGES` images, or all of them by setting it to 0.
* Pick a free `PORT`. For remote jobs, do ssh port forwarding. * Pick a free `PORT`. For remote jobs, do ssh port forwarding.
### Customization
Models, criteria, optimizers and data normalizations can be customized
without modifying map2map.
They can be implemented as callbacks in a user directory which is then
passed by `--callback-at`.
The default locations are searched first before the callback directory.
So be aware of name collisions.
This approach is good for experimentation.
For example, one can play with a model `Bar` in `path/to/foo.py`, by
calling `m2m.py` with `--model foo.Bar --callback-at path/to`.