Skip to content

Commit ae39722

Browse files
committed
update readme
1 parent 5c8bd1e commit ae39722

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

ReadMe.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,24 @@
11
# Tensorflow CNN's
2-
This library contains base methods for training various models in tensorflow using the following interface:
2+
This library contains base methods for training various models in [TensorFlow](https://github.com/tensorflow/tensorflow) using the following interface:
33

4-
```
5-
import tfmodels
6-
dataset = tfmodels.ImageMaskDataSet(...)
7-
model = tfmodels.VGGTraining(datset, ...)
8-
for _ in ...:
9-
model.train()
4+
```
5+
import tfmodels
6+
dataset = tfmodels.ImageMaskDataSet(...)
7+
model = tfmodels.VGGTraining(datset, ...)
8+
for _ in xrange(iterations):
9+
model.train()
1010
11-
model.snapshot()
11+
model.test()
12+
model.snapshot()
1213
13-
result = model.inference(images)
14-
```
14+
result = model.inference(images)
15+
```
1516

16-
To implement a new model, copy-paste one of the existing models and re-implement the `model()` method.
17+
To implement a new `segmentation` model, copy-paste `segmentation/TEMPLATE.py` and fill in the `__init__` and `model` methods.
1718

1819
In addition to semantic segmentation models, the library also contains base methods for training generative models including Generative Adversarial Networks and Variational Autoencoders, and for multiple-instance classifiers.
1920

20-
**Note** the default activation (set in `tfmodels/utilities/basemodel.py`) is SeLU. Accordingly, the inputs should be scaled to `[-1.0, 1.0]` in the dataset loading functions, and we should use `tf.contrib.nn.alpha_dropout` (TensorFlow 1.4.1).
21+
**Note** the default activation (set in `tfmodels/utilities/basemodel.py`) is [SeLU](https://arxiv.org/abs/1706.02515). Accordingly, the inputs should be scaled to `[-1.0, 1.0]` in the dataset loading functions, and we should use `tf.contrib.nn.alpha_dropout` (TensorFlow 1.4.1).
2122

2223
## Versioning
2324
```
@@ -29,7 +30,7 @@ opencv 3
2930

3031
## Getting started
3132
Example scripts for data set interface, training and testing various models are provided under `experiments/`.
32-
- N-class semantic segmentation
33+
- N-class semantic segmentation with various architectures (your data)
3334
- Generative Adversarial Networks (MNIST)
3435
- Variational Autoencoders (MNIST)
3536
- Multi-instance / bagged labels (MNIST)

0 commit comments

Comments
 (0)