Skip to content

Commit f06c5bf

Browse files
committed
Updated README.md file
1 parent 57a46ca commit f06c5bf

File tree

1 file changed

+38
-3
lines changed

1 file changed

+38
-3
lines changed

README.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,47 @@ to perform accurate and robust speaker identification.
1313
1. **Clone the Repository**
1414
```bash
1515
git clone https://github.com/your_username/your_repository_name.git
16-
cd your_repository_name```
16+
cd your_repository_name
1717

1818
2. **Install Dependencies**
1919
```bash
20-
pip install -r requirements.txt```
20+
pip install -r requirements.txt
2121
2222
3. **Verify the Installation**
2323
```bash
24-
python cli.py --help```
24+
python cli.py --help
25+
26+
## Usage
27+
28+
The Speaker Recognition Engine supports several commands for managing speaker audio data. Below are the available commands:
29+
30+
1. **Enroll a Speaker**: Enroll a new speaker using an audio file.
31+
2. **Recognize a Speaker**: Identify a speaker from a given audio file.
32+
3. **List Enrolled Speakers**: Display a list of all enrolled speakers.
33+
4. **Delete a Speaker**: Remove a speaker's data from the system.
34+
35+
Each command can be executed from the command line with the appropriate arguments. The general syntax for using the tool is:
36+
37+
```bash
38+
python cli.py <command> [arguments]
39+
40+
### Enroll a Speaker
41+
42+
To enroll a new speaker, use the `enroll` command followed by the speaker's name and the path to the audio file. Optionally, you can specify parameters like sample rate, number of filters, and number of MFCC coefficients.
43+
44+
**Syntax:**
45+
```bash
46+
python cli.py enroll <speaker_name> <audio_file_path> [optional parameters]
47+
48+
Optional Parameters:
49+
50+
--sample_rate: Sampling rate of the audio file (default: 16000)
51+
--num_filters: Number of Mel filters (default: 26)
52+
--num_ceps: Number of MFCC coefficients (default: 13)
53+
--n_fft: FFT size for audio processing (default: 512)
54+
--frame_size: Frame size in seconds (default: 0.025)
55+
--frame_step: Frame step (overlap) in seconds (default: 0.01)
56+
--n_mixtures: Number of Gaussian mixtures in GMM (default: 8)
57+
58+
Example:
59+
python cli.py enroll gena /home/gena/audio_files/gena.wav --sample_rate 16000 --num_filters 40 --num_ceps 13 --n_fft 512 --frame_size 0.025 --frame_step 0.01 --n_mixtures 8

0 commit comments

Comments
 (0)