Add task categories metadata and sample usage

#1
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +28 -2
README.md CHANGED
@@ -1,4 +1,6 @@
1
  ---
 
 
2
  license: cc-by-4.0
3
  configs:
4
  - config_name: default
@@ -12,12 +14,12 @@ splits:
12
  num_examples: 1693423
13
  - name: hifitts2
14
  num_examples: 1220574
15
- language:
16
- - en
17
  pipeline_tag: text-to-speech
18
  tags:
19
  - voxtream
20
  - text-to-speech
 
 
21
  ---
22
 
23
  # Model Card for VoXtream training dataset
@@ -57,6 +59,30 @@ local_dir = snapshot_download('herimor/voxtream-train-9k', repo_type='dataset')
57
 
58
  Clone our [repo](https://github.com/herimor/voxtream) and follow the instructions in the README file.
59
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
60
  ## Citation
61
 
62
  ```
 
1
  ---
2
+ language:
3
+ - en
4
  license: cc-by-4.0
5
  configs:
6
  - config_name: default
 
14
  num_examples: 1693423
15
  - name: hifitts2
16
  num_examples: 1220574
 
 
17
  pipeline_tag: text-to-speech
18
  tags:
19
  - voxtream
20
  - text-to-speech
21
+ task_categories:
22
+ - text-to-speech
23
  ---
24
 
25
  # Model Card for VoXtream training dataset
 
59
 
60
  Clone our [repo](https://github.com/herimor/voxtream) and follow the instructions in the README file.
61
 
62
+ ## Sample Usage
63
+
64
+ The following examples demonstrate how to use the VoXtream model (trained on this dataset) for output streaming and full streaming.
65
+
66
+ ### Output streaming
67
+ ```bash
68
+ python run.py \
69
+ --prompt-audio assets/audio/male.wav \
70
+ --prompt-text "The liquor was first created as 'Brandy Milk', produced with milk, brandy and vanilla." \
71
+ --text "In general, however, some method is then needed to evaluate each approximation." \
72
+ --output "output_stream.wav"
73
+ ```
74
+ * Note: Initial run may take some additional time to prepare MFA alignment for the prompt.
75
+
76
+ ### Full streaming
77
+ ```bash
78
+ python run.py \
79
+ --prompt-audio assets/audio/female.wav \
80
+ --prompt-text "Betty Cooper helps Archie with cleaning a store room, when Reggie attacks her." \
81
+ --text "Staff do not always do enough to prevent violence." \
82
+ --output "full_stream.wav" \
83
+ --full-stream
84
+ ```
85
+
86
  ## Citation
87
 
88
  ```