Skip to content

Commit

Permalink
Polish README
Browse files Browse the repository at this point in the history
  • Loading branch information
raviqqe committed Dec 28, 2016
1 parent 53a220e commit f68cc6e
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ The framework is built on top of
[TF Learn](https://github.com/tensorflow/tensorflow/tree/master/tensorflow/contrib/learn/python/learn).
Especially if you are working on research projects using TensorFlow, you can
remove most of boilerplate code with this framework.
All you need to do is to define a model constructor `model_fn` and input
producer(s) `input_fn` to feed a dataset to the model.


## Features
Expand All @@ -22,10 +24,10 @@ remove most of boilerplate code with this framework.
- To infer labels or regression values with trained models
- Configuration of command line arguments to set hyperparameters of models etc.
- [Distributed TensorFlow](https://www.tensorflow.org/how_tos/distributed/)
(only for training and evaluation)
- Just set an optional argument `distributed ` of `def_train_and_evaluate()`
as `True`. (i.e. `def_train_and_evaluate(distributed=True)`)
as `True` (i.e. `def_train_and_evaluate(distributed=True)`) to enable it.
- Supports only data parallel training
- Only for training and evaluation but not for inference


## Installation
Expand Down

0 comments on commit f68cc6e

Please sign in to comment.