Skip to content

Commit 5e5df1a

Browse files
committed
Updating README files
1 parent 8c7ca99 commit 5e5df1a

File tree

2 files changed

+18
-11
lines changed

2 files changed

+18
-11
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ See [this example](https://github.com/ageitgey/face_recognition/blob/master/exam
200200

201201
All the examples are available [here](https://github.com/ageitgey/face_recognition/tree/master/examples).
202202

203-
* [Find faces in an photograph](https://github.com/ageitgey/face_recognition/blob/master/examples/find_faces_in_picture.py)
203+
* [Find faces in a photograph](https://github.com/ageitgey/face_recognition/blob/master/examples/find_faces_in_picture.py)
204204
* [Identify specific facial features in a photograph](https://github.com/ageitgey/face_recognition/blob/master/examples/find_facial_features_in_picture.py)
205205
* [Apply (horribly ugly) digital make-up](https://github.com/ageitgey/face_recognition/blob/master/examples/digital_makeup.py)
206206
* [Find and recognize unknown faces in a photograph based on photographs of known people](https://github.com/ageitgey/face_recognition/blob/master/examples/recognize_faces_in_pictures.py)
@@ -212,7 +212,7 @@ depending on a black box library, [read my article](https://medium.com/@ageitgey
212212

213213
## Caveats
214214

215-
* The face recognition model is trained on adults and does not work very well on children. It tends to mix
215+
* The face recognition model is trained on adults and does not work very well on children. It tends to mix
216216
up children quite easy using the default comparison threshold of 0.6.
217217

218218
## Thanks

README.rst

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -77,28 +77,35 @@ Recognize who appears in each photo.
7777
Installation
7878
------------
7979

80-
| Python 3 is fully supported. Python 2 should also work. Only macOS and
80+
| Python 3 / Python 2 are fully supported. Only macOS and
8181
| Linux are tested. I have no idea if this will work on Windows.
8282
83-
You can install this module from pypi using ``pip3`` (or ``pip2`` for
83+
Step 1: Install the required machine learning models using ``pip3`` (or
84+
``pip2`` for Python 2):
85+
86+
.. code:: bash
87+
88+
pip3 install git+https://github.com/ageitgey/face_recognition_models
89+
90+
Step 2: Install this module from pypi using ``pip3`` (or ``pip2`` for
8491
Python 2):
8592

8693
.. code:: bash
8794
88-
$ pip3 install face_recognition
95+
pip3 install face_recognition
8996
90-
| It's very likely that you will run into problems when pip tries to
91-
compile
97+
| IMPORTANT NOTE: It's very likely that you will run into problems when
98+
pip tries to compile
9299
| the ``dlib`` dependency. If that happens, check out this guide to
93100
installing
94-
| dlib from source instead to fix the error:
101+
| dlib from source (instead of from pip) to fix the error:
95102
96103
`How to install dlib from
97104
source <https://gist.github.com/ageitgey/629d75c1baac34dfa5ca2a1928a7aeaf>`__
98105

99106
| After manually installing ``dlib``, try running
100107
``pip3 install face_recognition``
101-
| again.
108+
| again to complete your installation.
102109
103110
Usage
104111
-----
@@ -229,7 +236,7 @@ Python Code Examples
229236
All the examples are available
230237
`here <https://github.com/ageitgey/face_recognition/tree/master/examples>`__.
231238

232-
- `Find faces in an
239+
- `Find faces in a
233240
photograph <https://github.com/ageitgey/face_recognition/blob/master/examples/find_faces_in_picture.py>`__
234241
- `Identify specific facial features in a
235242
photograph <https://github.com/ageitgey/face_recognition/blob/master/examples/find_facial_features_in_picture.py>`__
@@ -275,7 +282,7 @@ Thanks
275282
for making Python project packaging way more tolerable.
276283

277284
.. |image0| image:: https://img.shields.io/pypi/v/face_recognition.svg
278-
.. |image1| image:: https://travis-ci.org/ageitgey/face_recognition
285+
.. |image1| image:: https://travis-ci.org/ageitgey/face_recognition.svg?branch=master
279286
.. |image2| image:: https://cloud.githubusercontent.com/assets/896692/23625227/42c65360-025d-11e7-94ea-b12f28cb34b4.png
280287
.. |image3| image:: https://cloud.githubusercontent.com/assets/896692/23625282/7f2d79dc-025d-11e7-8728-d8924596f8fa.png
281288
.. |image4| image:: https://cloud.githubusercontent.com/assets/896692/23625283/80638760-025d-11e7-80a2-1d2779f7ccab.png

0 commit comments

Comments
 (0)