ZenQin commited on
Commit
0ca21e9
1 Parent(s): d26372d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +75 -0
README.md CHANGED
@@ -31,6 +31,81 @@ In April 2024, we release OpenVoice V2, which includes all features in V1 and ha
31
  ### How to Use
32
  Please see [usage](https://github.com/myshell-ai/OpenVoice/blob/main/docs/USAGE.md) for detailed instructions.
33
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
34
  ### Links
35
  - [Github](https://github.com/myshell-ai/OpenVoice)
36
  - [HFDemo](https://huggingface.co/spaces/myshell-ai/OpenVoiceV2)
 
31
  ### How to Use
32
  Please see [usage](https://github.com/myshell-ai/OpenVoice/blob/main/docs/USAGE.md) for detailed instructions.
33
 
34
+ # Usage
35
+
36
+ ## Table of Content
37
+
38
+ - [Quick Use](#quick-use): directly use OpenVoice without installation.
39
+ - [Linux Install](#linux-install): for researchers and developers only.
40
+ - [V1](#openvoice-v1)
41
+ - [V2](#openvoice-v2)
42
+ - [Install on Other Platforms](#install-on-other-platforms): unofficial installation guide contributed by the community
43
+
44
+ ## Quick Use
45
+
46
+ The input speech audio of OpenVoice can be in **Any Language**. OpenVoice can clone the voice in that speech audio, and use the voice to speak in multiple languages. For quick use, we recommend you to try the already deployed services:
47
+
48
+ - [British English](https://app.myshell.ai/widget/vYjqae)
49
+ - [American English](https://app.myshell.ai/widget/nEFFJf)
50
+ - [Indian English](https://app.myshell.ai/widget/V3iYze)
51
+ - [Australian English](https://app.myshell.ai/widget/fM7JVf)
52
+ - [Spanish](https://app.myshell.ai/widget/NNFFVz)
53
+ - [French](https://app.myshell.ai/widget/z2uyUz)
54
+ - [Chinese](https://app.myshell.ai/widget/fU7nUz)
55
+ - [Japanese](https://app.myshell.ai/widget/IfIB3u)
56
+ - [Korean](https://app.myshell.ai/widget/q6ZjIn)
57
+
58
+ ## Linux Install
59
+
60
+ This section is only for developers and researchers who are familiar with Linux, Python and PyTorch. Clone this repo, and run
61
+
62
+ ```
63
+ conda create -n openvoice python=3.9
64
+ conda activate openvoice
65
+ git clone git@github.com:myshell-ai/OpenVoice.git
66
+ cd OpenVoice
67
+ pip install -e .
68
+ ```
69
+
70
+ No matter if you are using V1 or V2, the above installation is the same.
71
+
72
+ ### OpenVoice V1
73
+
74
+ Download the checkpoint from [here](https://myshell-public-repo-hosting.s3.amazonaws.com/openvoice/checkpoints_1226.zip) and extract it to the `checkpoints` folder.
75
+
76
+ **1. Flexible Voice Style Control.**
77
+ Please see [`demo_part1.ipynb`](https://github.com/myshell-ai/OpenVoice/blob/main/demo_part1.ipynb) for an example usage of how OpenVoice enables flexible style control over the cloned voice.
78
+
79
+ **2. Cross-Lingual Voice Cloning.**
80
+ Please see [`demo_part2.ipynb`](https://github.com/myshell-ai/OpenVoice/blob/main/demo_part2.ipynb) for an example for languages seen or unseen in the MSML training set.
81
+
82
+ **3. Gradio Demo.**. We provide a minimalist local gradio demo here. We strongly suggest the users to look into `demo_part1.ipynb`, `demo_part2.ipynb` and the [QnA](QA.md) if they run into issues with the gradio demo. Launch a local gradio demo with `python -m openvoice_app --share`.
83
+
84
+ ### OpenVoice V2
85
+
86
+ Download the checkpoint from [here](https://myshell-public-repo-hosting.s3.amazonaws.com/openvoice/checkpoints_v2_0417.zip) and extract it to the `checkpoints_v2` folder.
87
+
88
+ Install [MeloTTS](https://github.com/myshell-ai/MeloTTS):
89
+ ```
90
+ pip install git+https://github.com/myshell-ai/MeloTTS.git
91
+ python -m unidic download
92
+ ```
93
+
94
+ **Demo Usage.** Please see [`demo_part3.ipynb`](https://github.com/myshell-ai/OpenVoice/blob/main/demo_part3.ipynb) for example usage of OpenVoice V2. Now it natively supports English, Spanish, French, Chinese, Japanese and Korean.
95
+
96
+
97
+ ## Install on Other Platforms
98
+
99
+ This section provides the unofficial installation guides by open-source contributors in the community:
100
+
101
+ - Windows
102
+ - [Guide](https://github.com/Alienpups/OpenVoice/blob/main/docs/USAGE_WINDOWS.md) by [@Alienpups](https://github.com/Alienpups)
103
+ - You are welcome to contribute if you have a better installation guide. We will list you here.
104
+ - Docker
105
+ - [Guide](https://github.com/StevenJSCF/OpenVoice/blob/update-docs/docs/DF_USAGE.md) by [@StevenJSCF](https://github.com/StevenJSCF)
106
+ - You are welcome to contribute if you have a better installation guide. We will list you here.
107
+
108
+
109
  ### Links
110
  - [Github](https://github.com/myshell-ai/OpenVoice)
111
  - [HFDemo](https://huggingface.co/spaces/myshell-ai/OpenVoiceV2)