Spaces:
Runtime error
Runtime error
Delete docs
Browse files- docs/COMMAND_LINE_ARGUMENTS.md +0 -7
- docs/HOW_TO_USE.md +0 -100
- docs/img/ui_example.jpg +0 -0
docs/COMMAND_LINE_ARGUMENTS.md
DELETED
@@ -1,7 +0,0 @@
|
|
1 |
-
## List of Command Line Argument
|
2 |
-
|
3 |
-
| Option | Description |
|
4 |
-
|-----------------|--------------------------------------|
|
5 |
-
| `--share` | Launch with public link |
|
6 |
-
| `--api` | Launch with api |
|
7 |
-
| `--unsupported` | Force unsupported feature due to device being unsupported|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
docs/HOW_TO_USE.md
DELETED
@@ -1,100 +0,0 @@
|
|
1 |
-
## How to use?
|
2 |
-
|
3 |
-
### Simple
|
4 |
-
|
5 |
-
1. Delete the all file and folder inside the weights folder
|
6 |
-
2. Put all your model inside weights
|
7 |
-
|
8 |
-
```
|
9 |
-
rvc-inference/
|
10 |
-
ββ weights/
|
11 |
-
β ββ [your model folder #1]/ (Put your pth and index file here)
|
12 |
-
β ββ [your model folder #2]/ (Put your pth and index file here)
|
13 |
-
β ββ ...other model
|
14 |
-
ββ ...other stuff
|
15 |
-
```
|
16 |
-
4. Done
|
17 |
-
|
18 |
-
Note: Custom character/model name, image file and author may not be available for this.
|
19 |
-
|
20 |
-
### Advanced Only
|
21 |
-
|
22 |
-
This method is only for advanced user only.
|
23 |
-
1. Create folder_info.json inside weights and
|
24 |
-
create a category folder that contains list of character model.
|
25 |
-
|
26 |
-
```
|
27 |
-
rvc-inference/
|
28 |
-
ββ weights/
|
29 |
-
β ββ genshin impact/
|
30 |
-
β ββ folder_info.json
|
31 |
-
ββ ...other stuff
|
32 |
-
```
|
33 |
-
|
34 |
-
2. Inside folder_info.json
|
35 |
-
```json
|
36 |
-
"CATEGORY_TAB_NAME":{
|
37 |
-
"enable": true,
|
38 |
-
"title": "CATEGORY_TITLE",
|
39 |
-
"folder_path": "CATEGORY_FOLDER_PATH",
|
40 |
-
"description": "CATEGORY_DESCRIPTION"
|
41 |
-
}
|
42 |
-
```
|
43 |
-
|
44 |
-
folder_info.json info:
|
45 |
-
- CATEGORY_TAB_NAME = an category tab name (this one is just a name without spaces, but it wont affect the ui category title) [Required]
|
46 |
-
- enable = Enabled/Disabled cat [Required]
|
47 |
-
- title = Title of the category (this one affect the ui category title) [Required]
|
48 |
-
- folder_path = folder path to the category folder (ex. Genshin Impact) [Required]
|
49 |
-
- description = Description below the selected tab [Optional]
|
50 |
-
|
51 |
-
3. Create model_info.json inside the category folder
|
52 |
-
|
53 |
-
```
|
54 |
-
rvc-inference/
|
55 |
-
ββ weights/
|
56 |
-
β ββ genshin impact/
|
57 |
-
β β ββ model_info.json
|
58 |
-
β ββ folder_info.json
|
59 |
-
ββ ...other stuff
|
60 |
-
```
|
61 |
-
4. Inside model_info.json (If you have more than one model just duplicate and change the value)
|
62 |
-
```json
|
63 |
-
"FOLDER_PATH": {
|
64 |
-
"enable": true,
|
65 |
-
"model_path": "CHARACTER_BASEMODEL",
|
66 |
-
"title": "CHARACTER_NAME",
|
67 |
-
"cover": "CHARACTER_IMAGE",
|
68 |
-
"feature_retrieval_library": "CHARACTER_MODEL_INDEX",
|
69 |
-
"author": "MODEL_AUTHOR"
|
70 |
-
}
|
71 |
-
```
|
72 |
-
model_info.json info:
|
73 |
-
- FOLDER_PATH = folder path to the model [Required]
|
74 |
-
- enable = Enabled/Disabled model [Required]
|
75 |
-
- model_path = path to model file (ex. "venti.pth") [Required + must shown the extension]
|
76 |
-
- title = Title of the character/model (this one affect the ui category title) [Required + must shown the extension]
|
77 |
-
- cover = folder path to the image file (ex. "image.png") [Optional + must shown the extension]
|
78 |
-
- feature_retrieval_library = path to index file (ex. "added_IVF4198_Flat_nprobe_1_zhongli-jp_v2.index") [Required]
|
79 |
-
- author = Author of the model [Optional]
|
80 |
-
|
81 |
-
1. Put your desired model to your category folder
|
82 |
-
Example:
|
83 |
-
```
|
84 |
-
rvc-inference/
|
85 |
-
ββ weights/
|
86 |
-
β ββ genshin impact/
|
87 |
-
β β ββ [your model folder #1]/ (Put your pth and index file here)
|
88 |
-
β β ββ [your model folder #2]/ (Put your pth and index file here)
|
89 |
-
β β ββ ...other model
|
90 |
-
β β ββ model_info.json
|
91 |
-
β ββ folder_info.json
|
92 |
-
ββ ...other stuff
|
93 |
-
```
|
94 |
-
1. Done.
|
95 |
-
|
96 |
-
Note:
|
97 |
-
- To add image to the ui just put your image into the model folder and setting up the image path in the folder info.json.
|
98 |
-
|
99 |
-
More detail stuff:
|
100 |
-
![ui_example.jpg](./img/ui_example.jpg)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
docs/img/ui_example.jpg
DELETED
Binary file (274 kB)
|
|