Merge pull request mmistakes#7 from ArWeHei/README

README 2.0

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 The authors (Mimo Tilbich)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -11,7 +11,7 @@ A small framework for training and evaluating tensorflow models by Mimo Tilbich.
 3. [Example](#Example)
 4. [Other](#Other)
  1. [Parameters](#Parameters)
- 2. [Known Issues](#Known Issues)
+ 2. [Known Issues](#Known-Issues)
  3. [Compatibility](#Compatibility)
 5. [Contributions](#Contributions)
 6. [LICENSE](#LICENSE)
@@ -56,7 +56,21 @@ For more information, look into our [starter guide](link).
 ## Other
 
 ### Parameters
-### Knwon Issues
+
+- `--config path/to/config`
+
+ yaml file with all information see [Workflow][#Workflow]
+
+- `--checkpoint path/to/checkpoint to restore`
+
+- `--noeval`
+ only run training
+
+- `--retrain`
+ reset global step to zero
+
+
+### Known Issues
 ### Compatibility