Skip to content

docs: fix documentation typos #1675

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Zhao73 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: fix documentation typos #1675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions HISTORY.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,15 @@ History
1.1.0 (2017-09-23)
------------------

* Will use dlib's 5-point face pose estimator when possible for speed (instead of 68-point face pose esimator)
* Will use dlib's 5-point face pose estimator when possible for speed (instead of 68-point face pose estimator)
* dlib v19.7 is now the minimum required version
* face_recognition_models v0.3.0 is now the minimum required version


1.0.0 (2017-08-29)
------------------

* Added support for dlib's CNN face detection model via model="cnn" parameter on face detecion call
* Added support for dlib's CNN face detection model via model="cnn" parameter on face detection call
* Added support for GPU batched face detections using dlib's CNN face detector model
* Added find_faces_in_picture_cnn.py to examples
* Added find_faces_in_batches.py to examples
Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ import face_recognition
image = face_recognition.load_image_file("my_picture.jpg")
face_locations = face_recognition.face_locations(image)

# face_locations is now an array listing the co-ordinates of each face!
# face_locations is now an array listing the coordinates of each face!
```

See [this example](https://github.com/ageitgey/face_recognition/blob/master/examples/find_faces_in_picture.py)
Expand All @@ -270,15 +270,15 @@ You can also opt-in to a somewhat more accurate deep-learning-based face detecti

Note: GPU acceleration (via NVidia's CUDA library) is required for good
performance with this model. You'll also want to enable CUDA support
when compliling `dlib`.
when compiling `dlib`.

```python
import face_recognition

image = face_recognition.load_image_file("my_picture.jpg")
face_locations = face_recognition.face_locations(image, model="cnn")

# face_locations is now an array listing the co-ordinates of each face!
# face_locations is now an array listing the coordinates of each face!
```

See [this example](https://github.com/ageitgey/face_recognition/blob/master/examples/find_faces_in_picture_cnn.py)
Expand Down
7 changes: 3 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ Automatically find all the faces in an image
image = face_recognition.load_image_file("my_picture.jpg")
face_locations = face_recognition.face_locations(image)

# face_locations is now an array listing the co-ordinates of each face!
# face_locations is now an array listing the coordinates of each face!

| See `this
example <https://github.com/ageitgey/face_recognition/blob/master/examples/find_faces_in_picture.py>`__
Expand All @@ -272,7 +272,7 @@ detection model.
| Note: GPU acceleration (via nvidia's CUDA library) is required for
good
| performance with this model. You'll also want to enable CUDA support
| when compliling ``dlib``.
| when compiling ``dlib``.

.. code:: python

Expand All @@ -281,7 +281,7 @@ detection model.
image = face_recognition.load_image_file("my_picture.jpg")
face_locations = face_recognition.face_locations(image, model="cnn")

# face_locations is now an array listing the co-ordinates of each face!
# face_locations is now an array listing the coordinates of each face!

| See `this
example <https://github.com/ageitgey/face_recognition/blob/master/examples/find_faces_in_picture_cnn.py>`__
Expand Down Expand Up @@ -489,4 +489,3 @@ Thanks
.. |image7| image:: https://cloud.githubusercontent.com/assets/896692/24430398/36f0e3f0-13cb-11e7-8258-4d0c9ce1e419.gif
.. |known| image:: https://cloud.githubusercontent.com/assets/896692/23582466/8324810e-00df-11e7-82cf-41515eba704d.png
.. |unknown| image:: https://cloud.githubusercontent.com/assets/896692/23582465/81f422f8-00df-11e7-8b0d-75364f641f58.png