replicate/rvc-trainer
Public
0
runs
Run replicate/rvc-trainer with an API
Use one of our client libraries to get started quickly. Clicking on a library will take you to the Playground tab where you can tweak different inputs, see the results, and copy the corresponding code to use in your own project.
Input schema
The fields you can use to run this model with an API. If you don't give a value for a field its default value will be used.
| Field | Type | Default value | Description |
|---|---|---|---|
| training_data |
string
|
ZIP or tar archive containing the artist audio used for training
|
|
| huggingface_dataset_id |
string
|
|
Hugging Face dataset containing audio files or audio archives; use instead of training_data
|
| dataset_revision |
string
|
|
Optional branch, tag, or commit for huggingface_dataset_id
|
| auto_demux |
boolean
|
True
|
Automatically isolate vocals before training; disable only for already-isolated vocals
|
| separation_method |
None
|
pymss
|
Vocal separator used when auto_demux or validation_auto_demux is enabled
|
| pymss_model |
string
|
model_bs_roformer_ep_368_sdr_12.9628
|
PyMSS catalog model used for vocal separation
|
| demucs_model |
None
|
htdemucs
|
Demucs model used when separation_method is demucs
|
| model_name |
string
|
RVC Voice Model
|
Display name stored in the portable RVCPipeline
|
| training_steps |
integer
|
1000
Min: 10 Max: 20000 |
RVC optimizer steps
|
| batch_size |
None
|
4
|
Training batch size
|
| learning_rate |
number
|
0.0001
Min: 0.000001 Max: 0.001 |
RVC learning rate
|
| max_seconds_per_file |
number
|
180
Min: 5 Max: 600 |
Maximum duration consumed from each training file
|
| build_index |
boolean
|
True
|
Build the retrieval index included with the trained model
|
| export_webui_model |
boolean
|
True
|
Also include a classic RVC WebUI .pth, retrieval index, and feature array in the result
|
| validation_data |
string
|
Optional ZIP or tar of audio to convert with the trained model before returning it
|
|
| validation_dataset_id |
string
|
|
Optional Hugging Face dataset of validation audio; use instead of validation_data
|
| validation_revision |
string
|
|
Optional branch, tag, or commit for validation_dataset_id
|
| validation_auto_demux |
boolean
|
True
|
Isolate and replace vocals in complete validation songs; disable for isolated vocal files
|
| validation_retrieval_strength |
number
|
0.75
Max: 1 |
Feature-index retrieval strength used for validation conversion
|
| validation_rms_mix_rate |
number
|
1
Max: 1 |
Preserve the source validation volume envelope at 0 or use the converted envelope at 1
|
| hf_token |
string
|
Hugging Face token for private datasets or optional model publishing
|
|
| hub_model_id |
string
|
|
Optional Hugging Face model ID where the resulting RVCPipeline will be published
|
| hub_private |
boolean
|
True
|
Create the Hugging Face model repository as private when publishing
|
{
"type": "object",
"title": "Input",
"properties": {
"hf_token": {
"type": "string",
"title": "Hf Token",
"format": "password",
"x-order": 20,
"nullable": true,
"writeOnly": true,
"description": "Hugging Face token for private datasets or optional model publishing",
"x-cog-secret": true
},
"auto_demux": {
"type": "boolean",
"title": "Auto Demux",
"default": true,
"x-order": 3,
"description": "Automatically isolate vocals before training; disable only for already-isolated vocals"
},
"batch_size": {
"enum": [
1,
2,
4,
8
],
"type": "integer",
"title": "batch_size",
"description": "Training batch size",
"default": 4,
"x-order": 9
},
"model_name": {
"type": "string",
"title": "Model Name",
"default": "RVC Voice Model",
"x-order": 7,
"description": "Display name stored in the portable RVCPipeline"
},
"build_index": {
"type": "boolean",
"title": "Build Index",
"default": true,
"x-order": 12,
"description": "Build the retrieval index included with the trained model"
},
"hub_private": {
"type": "boolean",
"title": "Hub Private",
"default": true,
"x-order": 22,
"description": "Create the Hugging Face model repository as private when publishing"
},
"pymss_model": {
"type": "string",
"title": "Pymss Model",
"default": "model_bs_roformer_ep_368_sdr_12.9628",
"x-order": 5,
"description": "PyMSS catalog model used for vocal separation"
},
"demucs_model": {
"enum": [
"htdemucs",
"htdemucs_ft",
"mdx_extra",
"mdx_extra_q"
],
"type": "string",
"title": "demucs_model",
"description": "Demucs model used when separation_method is demucs",
"default": "htdemucs",
"x-order": 6
},
"hub_model_id": {
"type": "string",
"title": "Hub Model Id",
"default": "",
"x-order": 21,
"description": "Optional Hugging Face model ID where the resulting RVCPipeline will be published"
},
"learning_rate": {
"type": "number",
"title": "Learning Rate",
"default": 0.0001,
"maximum": 0.001,
"minimum": 1e-06,
"x-order": 10,
"description": "RVC learning rate"
},
"training_data": {
"type": "string",
"title": "Training Data",
"format": "uri",
"x-order": 0,
"nullable": true,
"description": "ZIP or tar archive containing the artist audio used for training"
},
"training_steps": {
"type": "integer",
"title": "Training Steps",
"default": 1000,
"maximum": 20000,
"minimum": 10,
"x-order": 8,
"description": "RVC optimizer steps"
},
"validation_data": {
"type": "string",
"title": "Validation Data",
"format": "uri",
"x-order": 14,
"nullable": true,
"description": "Optional ZIP or tar of audio to convert with the trained model before returning it"
},
"dataset_revision": {
"type": "string",
"title": "Dataset Revision",
"default": "",
"x-order": 2,
"description": "Optional branch, tag, or commit for huggingface_dataset_id"
},
"separation_method": {
"enum": [
"pymss",
"demucs"
],
"type": "string",
"title": "separation_method",
"description": "Vocal separator used when auto_demux or validation_auto_demux is enabled",
"default": "pymss",
"x-order": 4
},
"export_webui_model": {
"type": "boolean",
"title": "Export Webui Model",
"default": true,
"x-order": 13,
"description": "Also include a classic RVC WebUI .pth, retrieval index, and feature array in the result"
},
"validation_revision": {
"type": "string",
"title": "Validation Revision",
"default": "",
"x-order": 16,
"description": "Optional branch, tag, or commit for validation_dataset_id"
},
"max_seconds_per_file": {
"type": "number",
"title": "Max Seconds Per File",
"default": 180,
"maximum": 600,
"minimum": 5,
"x-order": 11,
"description": "Maximum duration consumed from each training file"
},
"validation_auto_demux": {
"type": "boolean",
"title": "Validation Auto Demux",
"default": true,
"x-order": 17,
"description": "Isolate and replace vocals in complete validation songs; disable for isolated vocal files"
},
"validation_dataset_id": {
"type": "string",
"title": "Validation Dataset Id",
"default": "",
"x-order": 15,
"description": "Optional Hugging Face dataset of validation audio; use instead of validation_data"
},
"huggingface_dataset_id": {
"type": "string",
"title": "Huggingface Dataset Id",
"default": "",
"x-order": 1,
"description": "Hugging Face dataset containing audio files or audio archives; use instead of training_data"
},
"validation_rms_mix_rate": {
"type": "number",
"title": "Validation Rms Mix Rate",
"default": 1,
"maximum": 1,
"minimum": 0,
"x-order": 19,
"description": "Preserve the source validation volume envelope at 0 or use the converted envelope at 1"
},
"validation_retrieval_strength": {
"type": "number",
"title": "Validation Retrieval Strength",
"default": 0.75,
"maximum": 1,
"minimum": 0,
"x-order": 18,
"description": "Feature-index retrieval strength used for validation conversion"
}
}
}
Output schema
The shape of the response you’ll get when you run this model with an API.
Schema
{
"type": "string",
"title": "Output",
"format": "uri"
}