Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pospielov committed Mar 24, 2021
1 parent 316400a commit 0cc6541
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,12 @@ gender recognition

# Getting Started with CompreFace

### Requirements

1. Docker and Docker compose (or Docker Desktop)
2. CompreFace could be run on most modern computers with [x86 processor](https://en.wikipedia.org/wiki/X86) and [AVX support](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions).
To check AVX support on Linux run `lscpu | grep avx` command

### To get started (Linux, MacOS):

1. Install Docker and Docker Compose
Expand Down
13 changes: 7 additions & 6 deletions docs/How-to-Use-CompreFace.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
# How to Use CompreFace

**Step 1.** Install and run CompreFace using our [Getting Started guide](../README.md#getting-started-with-compreface)

**Step 1.** You need to sign up for the system and log in into the account you’ve just created or use the one you already have. After that, the system redirects you to the main page.
**Step 2.** You need to sign up for the system and log in into the account you’ve just created or use the one you already have. After that, the system redirects you to the main page.

**Step 2.** Create an application (left section) using the "Create" link at the bottom of the page. An application is where you can create and manage your Face Collections.
**Step 3.** Create an application (left section) using the "Create" link at the bottom of the page. An application is where you can create and manage your Face Collections.

**Step 3.** Enter your application by clicking on its name. Here you will have two options: you can either add new users and manage
**Step 4.** Enter your application by clicking on its name. Here you will have two options: you can either add new users and manage
their access roles or create new [Face Services](Face-services-and-plugins.md).

**Step 4.** To recognize subjects among the known subjects, you need to create Face Recognition Service. After creating a new Face
**Step 5.** To recognize subjects among the known subjects, you need to create Face Recognition Service. After creating a new Face
Service, you will see it in the Services List with an appropriate name and API key.

**Step 5.** To add known subjects to your Face Collection of Face Recognition Service, you can use REST API.
**Step 6.** To add known subjects to your Face Collection of Face Recognition Service, you can use REST API.
Once you’ve uploaded all known faces, you can test the collection using REST API or the TEST page.
We recommend that you use an image size no higher than 5MB, as it could slow down the request process. The supported image formats include JPEG/PNG/JPG/ICO/BMP/GIF/TIF/TIFF.

**Step 6.** Upload your photo and let our open-source face recognition system match the image against the Face Collection. If you use a
**Step 7.** Upload your photo and let our open-source face recognition system match the image against the Face Collection. If you use a
UI for face recognition, you will see the original picture with marks near every face. If you use REST API, you will receive a response in JSON format.

JSON contains an array of objects that represent each recognized face. Each object has the following fields:
Expand Down

0 comments on commit 0cc6541

Please sign in to comment.