Hervé BREDIN commited on
Commit
b064c81
1 Parent(s): 6126e13

doc: update README

Browse files
Files changed (1) hide show
  1. README.md +13 -8
README.md CHANGED
@@ -15,14 +15,13 @@ tags:
15
  - resegmentation
16
  license: mit
17
  inference: false
18
- extra_gated_prompt: "The collected information will help acquire a better knowledge of pyannote.audio userbase and help its maintainers improve it further. If you are an academic researcher, please cite the relevant papers in your own publications using the model. If you work for a company, please consider contributing back to pyannote.audio development (e.g. through unrestricted gifts). We also provide scientific consulting services around speaker diarization and machine listening."
19
  extra_gated_fields:
20
  Company/university: text
21
  Website: text
22
- I plan to use this model for (task, type of audio data, etc): text
23
  ---
24
 
25
- We propose (paid) scientific [consulting services](https://herve.niderb.fr/consulting.html) to companies willing to make the most of their data and open-source speech processing toolkits (and `pyannote` in particular).
26
 
27
  # 🎹 "Powerset" speaker segmentation
28
 
@@ -53,15 +52,21 @@ It has been trained by Séverin Baroudi with [pyannote.audio](https://github.com
53
 
54
  This [companion repository](https://github.com/FrenchKrab/IS2023-powerset-diarization/) by [Alexis Plaquet](https://frenchkrab.github.io/) also provides instructions on how to train or finetune such a model on your own data.
55
 
 
 
 
 
 
 
 
56
  ## Usage
57
 
58
  ```python
59
- # 1. visit hf.co/pyannote/segmentation-3.0 and accept user conditions
60
- # 2. visit hf.co/settings/tokens to create an access token
61
- # 3. instantiate pretrained model
62
  from pyannote.audio import Model
63
- model = Model.from_pretrained("pyannote/segmentation-3.0",
64
- use_auth_token="ACCESS_TOKEN_GOES_HERE")
 
65
  ```
66
 
67
  ### Speaker diarization
 
15
  - resegmentation
16
  license: mit
17
  inference: false
18
+ extra_gated_prompt: "The collected information will help acquire a better knowledge of pyannote.audio userbase and help its maintainers improve it further. Though this model uses MIT license and will always remain open-source, we will occasionnally email you about premium models and paid services around pyannote."
19
  extra_gated_fields:
20
  Company/university: text
21
  Website: text
 
22
  ---
23
 
24
+ Using this open-source model in production? Make the most of it thanks to our [consulting services](https://herve.niderb.fr/consulting.html).
25
 
26
  # 🎹 "Powerset" speaker segmentation
27
 
 
52
 
53
  This [companion repository](https://github.com/FrenchKrab/IS2023-powerset-diarization/) by [Alexis Plaquet](https://frenchkrab.github.io/) also provides instructions on how to train or finetune such a model on your own data.
54
 
55
+ ## Requirements
56
+
57
+ 1. Install [`pyannote.audio`](https://github.com/pyannote/pyannote-audio) `3.0` with `pip install pyannote.audio`
58
+ 2. Accept [`pyannote/segmentation-3.0`](https://hf.co/pyannote/segmentation-3.0) user conditions
59
+ 3. Create access token at [`hf.co/settings/tokens`](https://hf.co/settings/tokens).
60
+
61
+
62
  ## Usage
63
 
64
  ```python
65
+ # instantiate the model
 
 
66
  from pyannote.audio import Model
67
+ model = Model.from_pretrained(
68
+ "pyannote/segmentation-3.0",
69
+ use_auth_token="HUGGINGFACE_ACCESS_TOKEN_GOES_HERE")
70
  ```
71
 
72
  ### Speaker diarization