Add pipeline tag, library name, paper link, and usage section

#1
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +36 -4
README.md CHANGED
@@ -1,11 +1,13 @@
1
  ---
 
 
 
 
 
2
  tags:
3
  - espnet
4
  - audio
5
  - classification
6
- datasets:
7
- - as2m
8
- license: cc-by-4.0
9
  ---
10
 
11
  ## ESPnet2 CLS model
@@ -14,6 +16,36 @@ license: cc-by-4.0
14
 
15
  This model was trained by Shikhar Bharadwaj using as2m recipe in [espnet](https://github.com/espnet/espnet/).
16
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
17
  ## CLS config
18
 
19
  <details><summary>expand</summary>
@@ -780,4 +812,4 @@ task: cls
780
 
781
 
782
 
783
- ```
 
1
  ---
2
+ datasets:
3
+ - as2m
4
+ license: cc-by-4.0
5
+ pipeline_tag: audio-classification
6
+ library_name: espnet
7
  tags:
8
  - espnet
9
  - audio
10
  - classification
 
 
 
11
  ---
12
 
13
  ## ESPnet2 CLS model
 
16
 
17
  This model was trained by Shikhar Bharadwaj using as2m recipe in [espnet](https://github.com/espnet/espnet/).
18
 
19
+ It is presented in the paper [OpenBEATs: A Fully Open-Source General-Purpose Audio Encoder](https://huggingface.co/papers/2507.14129).
20
+
21
+ * **GitHub Repository:** [Shikhar-S/OpenBEATs](https://github.com/Shikhar-S/OpenBEATs)
22
+
23
+ ### Usage
24
+
25
+ You can run this model using the `openbeats` library:
26
+
27
+ ```bash
28
+ pip install openbeats
29
+ ```
30
+
31
+ ```python
32
+ from openbeats.model import OpenBeats
33
+ from openbeats.utils import load_audio
34
+
35
+ # load model
36
+ model = OpenBeats.from_pretrained("espnet/OpenBEATS-Base-i3-as2m", device="cuda")
37
+
38
+ # from a file with any sample rate
39
+ out = model.encode_file("audio.wav") # pass chunk_seconds=10 for long audio
40
+
41
+ # or load the waveform in 16khz monoaural array with values in [-1,1]
42
+ wav, sr = load_audio("audio.wav")
43
+ # and pass it
44
+ out = model.encode(wav, sr)
45
+
46
+ print(out["patch_embeddings"].shape)
47
+ ```
48
+
49
  ## CLS config
50
 
51
  <details><summary>expand</summary>
 
812
 
813
 
814
 
815
+ ```