Skip to content

Commit 739b103

Browse files
committed
Moved Gathering-anonymous-statistics.md updates to docs
1 parent fb18ed3 commit 739b103

File tree

2 files changed

+22
-89
lines changed

2 files changed

+22
-89
lines changed

Gathering-anonymous-statistics.md

Lines changed: 0 additions & 75 deletions
This file was deleted.

docs/Face-services-and-plugins.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,15 @@ CompreFace supports these face services and plugins:
1111

1212
# Services
1313

14-
To use face service you need to create it in an application on UI. The type of service depends on your application needs. Each service has its own REST API context and there is no possibility to change the service type after creation. Here is a short description of each of them:
14+
To use face service you need to create it in an application on UI.
15+
The type of service depends on your application needs.
16+
Each service has its own REST API context and there is no possibility to change the service type after creation.
17+
Here is a short description of each of them:
1518

1619
## Face detection
1720

18-
Face detection service is used to detect all faces in the image. It doesn’t recognize faces, just finds them on the image.
21+
Face detection service is used to detect all faces in the image.
22+
It doesn’t recognize faces, just finds them on the image.
1923

2024
**Cases of use**
2125

@@ -24,6 +28,7 @@ The most useful cases include face plugins for face analysis:
2428
* gather statistics on among what ages your event is popular
2529
* get landmark information to know where customers look at
2630
* gather statistics on how many customers in the store
31+
* recognize if all customers wear masks properly
2732

2833
**How to test**
2934

@@ -33,20 +38,22 @@ The most useful cases include face plugins for face analysis:
3338
4. From the list of the services in the Services frame, select the service you created; you can use search field to filter the services.
3439
5. Click Test button near in the row of the service you want to launch.
3540
6. On the service page, open or drag-and-drop the picture to analyze.
36-
7. The service will display the original picture with marks near every face.
41+
7. The service will display the original picture with marks near every face.
3742

3843
**Output**
3944

4045
Below the picture, you can see the Request processed, and the Response to the request.
41-
The Response is the output which ComperFace provides via [API](Rest-API-description.md).
46+
The Response is the output which ComperFace provides via [API](Rest-API-description.md#face-detection-service).
4247

4348
Example:
4449

45-
![](pics/13h41m46s_001_.png)
50+
![Example](https://user-images.githubusercontent.com/3736126/146967067-c6413d3e-3b23-45ad-abe8-0f8bc8f4800f.png)
4651

4752
## Face recognition
4853

49-
Face recognition service is used for face identification. This means that you first need to upload known faces to faces collection and then recognize unknown faces among them. When you upload an unknown face, the service returns the most similar faces to it. Also, face recognition service supports verify endpoint to check if this person from face collection is the correct one.
54+
Face recognition service is used for face identification. This means that you first need to upload known faces to faces collection and
55+
then recognize unknown faces among them. When you upload an unknown face, the service returns the most similar faces to it.
56+
Also, face recognition service supports verify endpoint to check if this person from face collection is the correct one.
5057

5158
**Cases of use**
5259

@@ -62,21 +69,22 @@ The possible cases include:
6269
3. Enter the name of the service you are going to create.
6370
4. From the list of the services in the Services frame, select the service you created; you can use search field to filter the services.
6471
5. Click Test button near in the row of the service you want to launch.
65-
6. On the service page, open or drag-and-drop the picture to analyze.
72+
6. On the service page, open or drag-and-drop the picture to analyze.
6673
7. The service will display the original picture with marks near every face.
6774

6875
**Output**
6976

7077
Below the picture, you can see the Request processed, and the Response to the request.
71-
The Response is the output which ComperFace provides via [API](Rest-API-description.md).
78+
The Response is the output which ComperFace provides via [API](Rest-API-description.md#face-recognition-service).
7279

7380
Example:
7481

75-
![](pics/14h03m09s_002_.png)
82+
![image](https://user-images.githubusercontent.com/3736126/146967594-40684d12-e106-43b2-92ad-6a34176ddf87.png)
7683

7784
## Face verification
7885

79-
Face verification service is used to check if this person is the correct one. The service compares two faces you send to the rest endpoint and returns their similarity.
86+
Face verification service is used to check if this person is the correct one.
87+
The service compares two faces you send to the rest endpoint and returns their similarity.
8088

8189
**Cases of use**
8290

@@ -91,17 +99,17 @@ The possible cases include:
9199
3. Enter the name of the service you are going to create.
92100
4. From the list of the services in the Services frame, select the service you created; you can use search field to filter the services.
93101
5. Click Test button near in the row of the service you want to launch.
94-
6. On the service page, open or drag-and-drop two pictures to compare their content.
102+
6. On the service page, open or drag-and-drop two pictures to compare their content.
95103
7. The service will display the original picture with marks near every face.
96104

97105
**Output**
98106

99107
Below the picture, you can see the Request processed, and the Response to the request.
100-
The Response is the output which ComperFace provides via [API](Rest-API-description.md).
108+
The Response is the output which ComperFace provides via [API](Rest-API-description.md#face-verification-service).
101109

102110
Example:
103111

104-
![](pics/14h06m24s_003_.png)
112+
![image](https://user-images.githubusercontent.com/3736126/146967889-ba8bdd9b-359f-4970-bfe0-71f3e6d21692.png)
105113

106114
# Face plugins
107115

@@ -117,7 +125,7 @@ curl -X POST "http://localhost:8000/api/v1/recognition/recognize?face_plugins=a
117125
-F file=<local_file>
118126
```
119127

120-
This request will recognize faces on the image and return additional information about age, gender, and landmarks.
128+
This request will recognize faces on the image and return additional information about age, gender, face mask, and landmarks.
121129

122130
The list of possible plugins:
123131
* age - returns the supposed range of a person’s age in format [min, max]

0 commit comments

Comments
 (0)