Skip to content

Commit

Permalink
Update documentation & versioning
Browse files Browse the repository at this point in the history
- makes setup.py consistent with Pipfile
- increments version number
- remove travis config, since travis-ci.org is going away and builds
  were already erroring
- verify that all sample code in README works
  • Loading branch information
thatandromeda committed Apr 28, 2021
1 parent 23ecc53 commit 5cbf679
Show file tree
Hide file tree
Showing 6 changed files with 57 additions and 73 deletions.
58 changes: 0 additions & 58 deletions .travis.yml

This file was deleted.

2 changes: 2 additions & 0 deletions Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ verify_ssl = true
keras = "*"
keras-applications = "*"
tensorflow = "~=2.4.0"
numpy = "*"
pillow = "*"

[requires]
python_version = "3.8"
42 changes: 41 additions & 1 deletion Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# keras-vggface [![Build Status](https://travis-ci.org/rcmalli/keras-vggface.svg?branch=master)](https://travis-ci.org/rcmalli/keras-vggface) [![PyPI Status](https://badge.fury.io/py/keras-vggface.svg)](https://badge.fury.io/py/keras-vggface) [![PyPI Status](https://pepy.tech/badge/keras-vggface)](https://pepy.tech/project/keras-vggface)
# keras-vggface [![PyPI Status](https://badge.fury.io/py/keras-vggface.svg)](https://badge.fury.io/py/keras-vggface) [![PyPI Status](https://pepy.tech/badge/keras-vggface)](https://pepy.tech/project/keras-vggface)

Oxford VGGFace Implementation using Keras Functional Framework v2+
Oxford VGGFace Implementation using Keras Functional Framework v2+

- Models are converted from original caffe networks.
- It supports only Tensorflow backend.
Expand All @@ -16,11 +16,12 @@ pip install keras_vggface
~~~


### Library Versions
### TensorFlow compatibility

- Keras v2.2.4
- Tensorflow v1.14.0
- **Warning: Theano backend is not supported/tested for now.**
Version 1.0+ supports TensorFlow 2+ (see `Pipfile.lock`). For TensorFlow 1
support, use version 0.6.

**Warning: Theano backend is not supported/tested for now.**

### Example Usage

Expand All @@ -43,7 +44,7 @@ vggface = VGGFace(model='senet50')


#### Feature Extraction

- Convolution Features

```python
Expand Down Expand Up @@ -115,7 +116,8 @@ vggface = VGGFace(model='senet50')
#custom parameters
nb_class = 2

vgg_model = VGGFace(include_top=False, input_shape=(224, 224, 3))
# Set model to `resnet50` or `senet50`
vgg_model = VGGFace(include_top=False, model='resnet50', input_shape=(224, 224, 3))
last_layer = vgg_model.get_layer('avg_pool').output
x = Flatten(name='flatten')(last_layer)
out = Dense(nb_class, activation='softmax', name='classifier')(x)
Expand Down Expand Up @@ -162,7 +164,7 @@ vggface = VGGFace(model='senet50')

- [Related Paper 2](http://www.robots.ox.ac.uk/~vgg/publications/2018/Cao18/cao18.pdf)

### Licence
### Licence

- Check Oxford Webpage for the license of the original models.

Expand All @@ -177,4 +179,3 @@ If you find this project useful, please include reference link in your work. You
- [How to Perform Face Recognition With VGGFace2 in Keras](https://machinelearningmastery.com/how-to-perform-face-recognition-with-vggface2-convolutional-neural-network-in-keras/)

- [An extremely small FaceRecog project for extreme beginners, and a few thoughts on the future](https://kevincodeidea.wordpress.com/2020/01/14/an-extremely-small-facerecog-project-for-extreme-beginners-and-a-few-thoughts-on-future-part-ii-transfer-learning-and-keras/)

4 changes: 2 additions & 2 deletions keras_vggface/version.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
__version__ = '0.6'
__version__ = '1.0'

def pretty_versions():
import keras
import tensorflow as tf
k_version = keras.__version__
t_version = tf.__version__
return "keras-vggface : {}, keras : {} , tensorflow : {} ".format(__version__,k_version,t_version)
return "keras-vggface : {}, keras : {} , tensorflow : {} ".format(__version__,k_version,t_version)
3 changes: 1 addition & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@
packages=find_packages(exclude=["tools", "training", "temp", "test", "data", "visualize","image",".venv",".github"]),
zip_safe=False,
install_requires=[
'numpy>=1.9.1', 'scipy>=0.14', 'h5py', 'pillow', 'keras',
'six>=1.9.0', 'pyyaml'
'keras', 'keras-applications', 'numpy', 'pillow', 'tensorflow~=2.4.0'
],
extras_require={
"tf": ["tensorflow"],
Expand Down

0 comments on commit 5cbf679

Please sign in to comment.