s8frbroy commited on
Commit
7b420a5
·
verified ·
1 Parent(s): ff15420

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +54 -176
README.md CHANGED
@@ -1,199 +1,77 @@
1
  ---
 
 
 
 
 
 
 
 
 
2
  library_name: transformers
3
- tags: []
 
 
 
4
  ---
5
 
6
- # Model Card for Model ID
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
 
9
 
 
10
 
 
11
 
12
- ## Model Details
13
-
14
- ### Model Description
15
-
16
- <!-- Provide a longer summary of what this model is. -->
17
-
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
-
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
-
28
- ### Model Sources [optional]
29
-
30
- <!-- Provide the basic links for the model. -->
31
-
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
-
36
- ## Uses
37
-
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
- ### Direct Use
41
-
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
-
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- [More Information Needed]
51
-
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
-
58
- ## Bias, Risks, and Limitations
59
-
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
-
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
 
171
- ## Citation [optional]
172
 
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
 
175
- **BibTeX:**
 
 
 
 
176
 
177
- [More Information Needed]
178
 
179
- **APA:**
180
 
181
- [More Information Needed]
182
 
183
- ## Glossary [optional]
184
 
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
 
186
 
187
- [More Information Needed]
 
 
188
 
189
- ## More Information [optional]
 
190
 
191
- [More Information Needed]
192
 
193
- ## Model Card Authors [optional]
194
 
195
- [More Information Needed]
 
 
196
 
197
- ## Model Card Contact
 
198
 
199
- [More Information Needed]
 
 
 
1
  ---
2
+ language: en
3
+ license: cc-by-4.0
4
+ tags:
5
+ - scientific-retrieval
6
+ - dense-passage-retrieval
7
+ - dual-encoder
8
+ - citation-prediction
9
+ - talk2ref
10
+ - SBERT
11
  library_name: transformers
12
+ pipeline_tag: feature-extraction
13
+ base_model: sentence-transformers/all-MiniLM-L6-v2
14
+ datasets:
15
+ - s8frbroy/talk2ref
16
  ---
17
 
18
+ # 📚 Talk2Ref Cited Paper Encoder
19
 
20
+ This model encodes **scientific papers** (titles, abstracts, and publication years) into dense embeddings for **Reference Prediction from Talks (RPT)** within the [Talk2Ref](https://huggingface.co/datasets/s8frbroy/talk2ref) framework.
21
+ It serves as the **key-side encoder** in a **dual-encoder (DPR-style)** retrieval setup, paired with the [Talk2Ref Query Talk Encoder](https://huggingface.co/s8frbroy/talk2ref_query_talk_encoder).
22
 
23
+ ---
24
 
25
+ ## 🧩 Model Overview
26
 
27
+ | Property | Description |
28
+ |-----------|-------------|
29
+ | **Architecture** | Sentence-BERT (all-MiniLM-L6-v2 backbone) |
30
+ | **Pooling** | Mean pooling |
31
+ | **Max sequence length** | 512 tokens |
32
+ | **Training data** | Talk2Ref dataset (≈ 43 k cited papers linked to 6 k talks) |
33
+ | **Objective** | Contrastive binary (DPR-style) loss |
34
+ | **Task** | Encode cited papers into a shared semantic space with talk transcripts |
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
35
 
36
+ ---
37
 
38
+ ## 🧠 Input Features
39
 
40
+ | Feature | Description |
41
+ |----------|-------------|
42
+ | **Title** | Title of the cited paper |
43
+ | **Abstract** | Abstract text content |
44
+ | **Year** | Publication year |
45
 
46
+ These inputs are short enough to fit within the model’s 512-token limit — no chunking required.
47
 
48
+ ---
49
 
50
+ ## 🧮 Training Setup
51
 
52
+ The cited-paper encoder was trained jointly with the query-talk encoder under a **dual-encoder contrastive framework** inspired by Dense Passage Retrieval (Karpukhin et al., 2020).
53
 
54
+ Each talk *Ti* and paper *Rj* is encoded into embeddings *fT(Ti)* and *fR(Rj)*.
55
+ Their dot-product similarity *sij = fT(Ti)·fR(Rj)* is optimized using a sigmoid-based binary loss supporting multiple positives per query:
56
 
57
+ \[
58
+ L = - \sum_i [y_i \log \sigma(s_i) + (1 - y_i)\log(1 - \sigma(s_i))]
59
+ \]
60
 
61
+ Negatives are sampled in-batch from other talk–paper pairs.
62
+ Before training, a **domain adaptation stage** aligned each talk with its own paper’s abstract to adapt to scientific and spoken-language data.
63
 
64
+ ---
65
 
66
+ ## 💡 Usage Example
67
 
68
+ ```python
69
+ from transformers import AutoTokenizer, AutoModel
70
+ import torch
71
 
72
+ model = AutoModel.from_pretrained("s8frbroy/talk2ref_ref_key_cited_paper_encoder")
73
+ tokenizer = AutoTokenizer.from_pretrained("sentence-transformers/all-MiniLM-L6-v2")
74
 
75
+ paper_text = "We propose a retrieval architecture for linking long spoken documents to their references..."
76
+ inputs = tokenizer(paper_text, return_tensors="pt", truncation=True, padding=True, max_length=512)
77
+ embeddings = model(**inputs).last_hidden_state.mean(dim=1) # mean pooling