Package: pveagledemo
Eagle Speaker Recognition DemosMade in Vancouver, Canada byPicovoiceEagleEagle is an on-device speaker recognition engine. Eagle is:Private; All voice processing runs locally.Cross-Platform:Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64)Android and iOSChrome, Safari, Firefox, and EdgeRaspberry Pi (5, 4, 3) and NVIDIA Jetson NanoCompatibilityPython 3.7+Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64), Raspberry Pi (5, 4, 3), and NVIDIA Jetson Nano.Installationpip3 install pveagledemoAccessKeyEagle requires a valid PicovoiceAccessKeyat initialization.AccessKeyacts as your credentials when using Eagle
SDKs. You can get yourAccessKeyfor free. Make sure to keep yourAccessKeysecret.
Signup or Login toPicovoice Consoleto get yourAccessKey.OverviewEagle consists of two distinct steps: Enrollment and Recognition. In the enrollment step, Eagle analyzes a series of
utterances from a particular speaker to learn their unique voiceprint. This step results in anEagleProfileobject,
which can be stored and utilized during inference. During the Recognition step, Eagle compares the incoming frames of
audio to the voiceprints of all enrolled speakers in real-time to determine the similarity between them.Microphone DemoThe microphone demo captures audio input from a microphone that is connected. To run the demo, use the following command
in the terminal:eagle_demo_mic {enroll, test} --access_key ${ACCESS_KEY} ...Replace${ACCESS_KEY}with yours obtained from Picovoice Console.The commandsenrollandtestare used to create a speaker profile and perform speaker recognition, respectively.
Detailed explanations of these commands will be provided in their respective sections.Furthermore, the demo offers optional arguments, which can be accessed by utilizing the--helpargument. By doing so,
you will receive a comprehensive listing of the available arguments along with their corresponding descriptions.eagle_demo_mic --helpSpeaker EnrollmentIf the demo is executed in the enrollment mode by using theenrollcommand, it will initiate the enrollment process
using the audio captured from the microphone. It will display the progress percentage in the terminal until it reaches
100%. Once completed, it will save the profile of the enrolled speaker to the disk.eagle_demo_mic enroll --access_key ${ACCESS_KEY} --output_profile_path ${OUTPUT_PROFILE_PATH}Replace${OUTPUT_PROFILE_PATH}with the absolute path where the generated profile should be written.Speaker RecognitionOnce the speaker profile for all speakers are created, the demo can be run in thetestmode by running the following
command:eagle_demo_mic test --access_key ${ACCESS_KEY} --input_profile_paths ${INPUT_PROFILE_PATH_1 ...}In this mode, you can include multiple speaker profiles by specifying them with the--input_profile_pathsoption.
Eagle will assess and provide a distinct score for each profile, which will be displayed in the terminal.File DemoSimilar to the mic demo, the file demo can be run in two modes:enrollandtesteagle_demo_file {enroll,test} --access_key ${ACCESS_KEY} ...Replace${ACCESS_KEY}with yours obtained from Picovoice Console.The commandsenrollandtestare used to create a speaker profile and perform speaker recognition, respectively, and
will be discussed in detail in their respective sections.To view the optional arguments for the demo, use the--helpargument. This will display a list of available arguments
and their descriptions.eagle_demo_file --helpSpeaker EnrollmentTo run the demo inenrollmode, you need two additional input arguments along with the AccessKey.eagle_demo_file enroll --access_key ${ACCESS_KEY} \--output_profile_path ${OUTPUT_PROFILE_PATH} --enroll_audio_paths ${ENROLL_AUDIO_PATH_1 ...}In this command,{ENROLL_AUDIO_PATH_1 ...}represents the absolute paths to the enroll audio files. If multiple files
are provided, Eagle will process all of them. Once the specified files are processed, the demo will generate a profile at${OUTPUT_PROFILE_PATH}.Speaker RecognitionThe file demo requires a test audio and one or more speaker profiles that were created during the enrollment step.To run the demo, use the following command in the console:eagle_demo_file test --access_key ${ACCESS_KEY} \--input_profile_paths ${INPUT_PROFILE_PATH_1 ...} --test_audio_path ${TEST_AUDIO_PATH}The demo will display the result for each enrolled speaker in the terminal.Optionally, you can also generate a.csvfile for further analysis by including the--csv_output_pathparameter:eagle_demo_file test --access_key ${ACCESS_KEY} \--input_profile_paths ${INPUT_PROFILE_PATH_1 ...} --test_audio_path ${TEST_AUDIO_PATH} \--csv_output_path ${CSV_OUTPUT_PATH}