From eb5ce4454cc899cf3c94c559e4d736f17ff3a6b8 Mon Sep 17 00:00:00 2001 From: Ftps Date: Sun, 21 Jan 2024 01:25:34 +0900 Subject: [PATCH] add flag on inference table --- README.md | 30 +++++++++++++++--------------- docs/jp/README.ja.md | 30 +++++++++++++++--------------- 2 files changed, 30 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index b952fb1..8c153c1 100644 --- a/README.md +++ b/README.md @@ -66,18 +66,18 @@ Finally, specify the location of the model in the env file, and you are done! rvc infer -m {model.pth} -i {input.wav} -o {output.wav} ``` -| option | type | default value | description | -|---------------|--------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| modelPath | Path | *required | Model path or filename (reads in the directory set in env) | -| inputPath | Path | *required | Input audio path or folder | -| outputPath | Path | *required | Output audio path or folder | -| sid | int | 0 | Speaker/Singer ID | -| f0_up_key | int | 0 | Transpose (integer, number of semitones, raise by an octave: 12, lower by an octave: -12) | -| f0_method | str | rmvpe | pitch extraction algorithm (pm, harvest, crepe, rmvpe | -| f0_file | Path \| None | None | F0 curve file (optional). One pitch per line. Replaces the default F0 and pitch modulation | -| index_file | Path \| None | None | Path to the feature index file | -| index_rate | float | 0.75 | Search feature ratio (controls accent strength, too high has artifacting) | -| filter_radius | int | 3 | If >=3: apply median filtering to the harvested pitch results. The value represents the filter radius and can reduce breathiness | -| resample_sr | int | 0 | Resample the output audio in post-processing to the final sample rate. Set to 0 for no resampling | -| rms_mix_rate | float | 0.25 | Adjust the volume envelope scaling. Closer to 0, the more it mimicks the volume of the original vocals. Can help mask noise and make volume sound more natural when set relatively low. Closer to 1 will be more of a consistently loud volume | -| protect | float | 0.33 | Protect voiceless consonants and breath sounds to prevent artifacts such as tearing in electronic music. Set to 0.5 to disable. Decrease the value to increase protection, but it may reduce indexing accuracy | \ No newline at end of file +| option | flag | type | default value | description | +|---------------|------|--------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| modelPath | -m | Path | *required | Model path or filename (reads in the directory set in env) | +| inputPath | -i | Path | *required | Input audio path or folder | +| outputPath | -o | Path | *required | Output audio path or folder | +| sid | -s | int | 0 | Speaker/Singer ID | +| f0_up_key | -fu | int | 0 | Transpose (integer, number of semitones, raise by an octave: 12, lower by an octave: -12) | +| f0_method | -fm | str | rmvpe | pitch extraction algorithm (pm, harvest, crepe, rmvpe | +| f0_file | -ff | Path \| None | None | F0 curve file (optional). One pitch per line. Replaces the default F0 and pitch modulation | +| index_file | -if | Path \| None | None | Path to the feature index file | +| index_rate | -if | float | 0.75 | Search feature ratio (controls accent strength, too high has artifacting) | +| filter_radius | -fr | int | 3 | If >=3: apply median filtering to the harvested pitch results. The value represents the filter radius and can reduce breathiness | +| resample_sr | -rsr | int | 0 | Resample the output audio in post-processing to the final sample rate. Set to 0 for no resampling | +| rms_mix_rate | -rmr | float | 0.25 | Adjust the volume envelope scaling. Closer to 0, the more it mimicks the volume of the original vocals. Can help mask noise and make volume sound more natural when set relatively low. Closer to 1 will be more of a consistently loud volume | +| protect | -p | float | 0.33 | Protect voiceless consonants and breath sounds to prevent artifacts such as tearing in electronic music. Set to 0.5 to disable. Decrease the value to increase protection, but it may reduce indexing accuracy | \ No newline at end of file diff --git a/docs/jp/README.ja.md b/docs/jp/README.ja.md index ac8d70c..d1b9b4f 100644 --- a/docs/jp/README.ja.md +++ b/docs/jp/README.ja.md @@ -68,18 +68,18 @@ rvc dlmodel {download_dir} rvc infer -m {model.pth} -i {input.wav} -o {output.wav} ``` -| option | type | default value | description | -|---------------|--------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| modelPath | Path | *required | Model path or filename (reads in the directory set in env) | -| inputPath | Path | *required | Input audio path or folder | -| outputPath | Path | *required | Output audio path or folder | -| sid | int | 0 | Speaker/Singer ID | -| f0_up_key | int | 0 | Transpose (integer, number of semitones, raise by an octave: 12, lower by an octave: -12) | -| f0_method | str | rmvpe | pitch extraction algorithm (pm, harvest, crepe, rmvpe | -| f0_file | Path \| None | None | F0 curve file (optional). One pitch per line. Replaces the default F0 and pitch modulation | -| index_file | Path \| None | None | Path to the feature index file | -| index_rate | float | 0.75 | Search feature ratio (controls accent strength, too high has artifacting) | -| filter_radius | int | 3 | If >=3: apply median filtering to the harvested pitch results. The value represents the filter radius and can reduce breathiness | -| resample_sr | int | 0 | Resample the output audio in post-processing to the final sample rate. Set to 0 for no resampling | -| rms_mix_rate | float | 0.25 | Adjust the volume envelope scaling. Closer to 0, the more it mimicks the volume of the original vocals. Can help mask noise and make volume sound more natural when set relatively low. Closer to 1 will be more of a consistently loud volume | -| protect | float | 0.33 | Protect voiceless consonants and breath sounds to prevent artifacts such as tearing in electronic music. Set to 0.5 to disable. Decrease the value to increase protection, but it may reduce indexing accuracy | \ No newline at end of file +| option | flag | type | default value | description | +|---------------|------|--------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| modelPath | -m | Path | *required | Model path or filename (reads in the directory set in env) | +| inputPath | -i | Path | *required | Input audio path or folder | +| outputPath | -o | Path | *required | Output audio path or folder | +| sid | -s | int | 0 | Speaker/Singer ID | +| f0_up_key | -fu | int | 0 | Transpose (integer, number of semitones, raise by an octave: 12, lower by an octave: -12) | +| f0_method | -fm | str | rmvpe | pitch extraction algorithm (pm, harvest, crepe, rmvpe | +| f0_file | -ff | Path \| None | None | F0 curve file (optional). One pitch per line. Replaces the default F0 and pitch modulation | +| index_file | -if | Path \| None | None | Path to the feature index file | +| index_rate | -if | float | 0.75 | Search feature ratio (controls accent strength, too high has artifacting) | +| filter_radius | -fr | int | 3 | If >=3: apply median filtering to the harvested pitch results. The value represents the filter radius and can reduce breathiness | +| resample_sr | -rsr | int | 0 | Resample the output audio in post-processing to the final sample rate. Set to 0 for no resampling | +| rms_mix_rate | -rmr | float | 0.25 | Adjust the volume envelope scaling. Closer to 0, the more it mimicks the volume of the original vocals. Can help mask noise and make volume sound more natural when set relatively low. Closer to 1 will be more of a consistently loud volume | +| protect | -p | float | 0.33 | Protect voiceless consonants and breath sounds to prevent artifacts such as tearing in electronic music. Set to 0.5 to disable. Decrease the value to increase protection, but it may reduce indexing accuracy | \ No newline at end of file