liaHa commited on
Commit
fe8df30
1 Parent(s): 8164980

upload model and model card

Browse files
.gitattributes CHANGED
@@ -33,3 +33,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
33
  *.zip filter=lfs diff=lfs merge=lfs -text
34
  *.zst filter=lfs diff=lfs merge=lfs -text
35
  *tfevents* filter=lfs diff=lfs merge=lfs -text
 
 
33
  *.zip filter=lfs diff=lfs merge=lfs -text
34
  *.zst filter=lfs diff=lfs merge=lfs -text
35
  *tfevents* filter=lfs diff=lfs merge=lfs -text
36
+ bertopic-base-finetuned-ecommerce-ergonomics-chair filter=lfs diff=lfs merge=lfs -text
bertopic-base-finetuned-ecommerce-ergonomics-chair ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:8cc4f4258effeeaed03d0665041c464c7b3b455d18440c64f3d495998a4f5139
3
+ size 870803268
bertopic-base-finetuned-ecommerce-ergonomics-chair_model_card.md ADDED
@@ -0,0 +1,252 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+
3
+ ---
4
+
5
+
6
+
7
+
8
+
9
+
10
+ # Model Card for bertopic-base-finetuned-ecommerce-ergonomics-chair
11
+
12
+ <!-- Provide a quick summary of what the model is/does. [Optional] -->
13
+ This a Bertopic base model , with embedding_model &#34;sentence-transformers/all-mpnet-base-v2&#34;, finetuned by embedding on ergonomics chair product reviews in English language.
14
+
15
+ This model is intended for direct use as a topic/cluster model for product reviews in ergonomics chair minor field, or for further finetuning on related clustering analysis tasks.
16
+
17
+ We replaced its head with our customer reviews to fine-tune it on 50,000+ rows of training set while validating it on 35,000 rows of dev set.
18
+
19
+
20
+
21
+
22
+ # Table of Contents
23
+
24
+ - [Model Card for bertopic-base-finetuned-ecommerce-ergonomics-chair](#model-card-for--model_id-)
25
+ - [Table of Contents](#table-of-contents)
26
+ - [Table of Contents](#table-of-contents-1)
27
+ - [Model Details](#model-details)
28
+ - [Model Description](#model-description)
29
+ - [Uses](#uses)
30
+ - [Direct Use](#direct-use)
31
+ - [Downstream Use [Optional]](#downstream-use-optional)
32
+ - [Out-of-Scope Use](#out-of-scope-use)
33
+ - [Bias, Risks, and Limitations](#bias-risks-and-limitations)
34
+ - [Recommendations](#recommendations)
35
+ - [Training Details](#training-details)
36
+ - [Training Data](#training-data)
37
+ - [Training Procedure](#training-procedure)
38
+ - [Preprocessing](#preprocessing)
39
+ - [Speeds, Sizes, Times](#speeds-sizes-times)
40
+ - [Evaluation](#evaluation)
41
+ - [Testing Data, Factors & Metrics](#testing-data-factors--metrics)
42
+ - [Testing Data](#testing-data)
43
+ - [Factors](#factors)
44
+ - [Metrics](#metrics)
45
+ - [Results](#results)
46
+ - [Model Examination](#model-examination)
47
+ - [Environmental Impact](#environmental-impact)
48
+ - [Technical Specifications [optional]](#technical-specifications-optional)
49
+ - [Model Architecture and Objective](#model-architecture-and-objective)
50
+ - [Compute Infrastructure](#compute-infrastructure)
51
+ - [Hardware](#hardware)
52
+ - [Software](#software)
53
+ - [Citation](#citation)
54
+ - [Glossary [optional]](#glossary-optional)
55
+ - [More Information [optional]](#more-information-optional)
56
+ - [Model Card Authors [optional]](#model-card-authors-optional)
57
+ - [Model Card Contact](#model-card-contact)
58
+ - [How to Get Started with the Model](#how-to-get-started-with-the-model)
59
+
60
+
61
+ # Model Details
62
+
63
+ ## Model Description
64
+
65
+ <!-- Provide a longer summary of what this model is/does. -->
66
+ This a Bertopic base model , with embedding_model &#34;sentence-transformers/all-mpnet-base-v2&#34;, finetuned by embedding on ergonomics chair product reviews in English language.
67
+
68
+ This model is intended for direct use as a topic/cluster model for product reviews in ergonomics chair minor field, or for further finetuning on related clustering analysis tasks.
69
+
70
+ We replaced its head with our customer reviews to fine-tune it on 50,000+ rows of training set while validating it on 35,000 rows of dev set.
71
+
72
+ - **Developed by:** More information needed
73
+ - **Shared by [Optional]:** More information needed
74
+ - **Model type:** Language model
75
+ - **Language(s) (NLP):** en
76
+ - **License:** mit
77
+ - **Parent Model:** More information needed
78
+ - **Resources for more information:** More information needed
79
+ - [GitHub Repo](https://github.com/yufei-ilariahuang/Ergonomics-Chair-project.git)
80
+
81
+
82
+ # Uses
83
+
84
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
85
+
86
+ ## Direct Use
87
+
88
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
89
+ <!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info needed." -->
90
+
91
+
92
+
93
+
94
+ ## Downstream Use [Optional]
95
+
96
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
97
+ <!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info needed." -->
98
+
99
+
100
+
101
+
102
+ ## Out-of-Scope Use
103
+
104
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
105
+ <!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info needed." -->
106
+
107
+
108
+
109
+
110
+ # Bias, Risks, and Limitations
111
+
112
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
113
+
114
+ Significant research has explored bias and fairness issues with language models (see, e.g., [Sheng et al. (2021)](https://aclanthology.org/2021.acl-long.330.pdf) and [Bender et al. (2021)](https://dl.acm.org/doi/pdf/10.1145/3442188.3445922)). Predictions generated by the model may include disturbing and harmful stereotypes across protected classes; identity characteristics; and sensitive, social, and occupational groups.
115
+
116
+
117
+ ## Recommendations
118
+
119
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
120
+
121
+
122
+
123
+
124
+
125
+ # Training Details
126
+
127
+ ## Training Data
128
+
129
+ <!-- This should link to a Data 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. -->
130
+
131
+ More information on training data needed
132
+
133
+
134
+ ## Training Procedure
135
+
136
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
137
+
138
+ ### Preprocessing
139
+
140
+ More information needed
141
+
142
+ ### Speeds, Sizes, Times
143
+
144
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
145
+
146
+ More information needed
147
+
148
+ # Evaluation
149
+
150
+ <!-- This section describes the evaluation protocols and provides the results. -->
151
+
152
+ ## Testing Data, Factors & Metrics
153
+
154
+ ### Testing Data
155
+
156
+ <!-- This should link to a Data Card if possible. -->
157
+
158
+ More information needed
159
+
160
+
161
+ ### Factors
162
+
163
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
164
+
165
+ More information needed
166
+
167
+ ### Metrics
168
+
169
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
170
+
171
+ More information needed
172
+
173
+ ## Results
174
+
175
+ More information needed
176
+
177
+ # Model Examination
178
+
179
+ More information needed
180
+
181
+ # Environmental Impact
182
+
183
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
184
+
185
+ 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).
186
+
187
+ - **Hardware Type:** More information needed
188
+ - **Hours used:** More information needed
189
+ - **Cloud Provider:** More information needed
190
+ - **Compute Region:** More information needed
191
+ - **Carbon Emitted:** More information needed
192
+
193
+ # Technical Specifications [optional]
194
+
195
+ ## Model Architecture and Objective
196
+
197
+ More information needed
198
+
199
+ ## Compute Infrastructure
200
+
201
+ More information needed
202
+
203
+ ### Hardware
204
+
205
+ More information needed
206
+
207
+ ### Software
208
+
209
+ More information needed
210
+
211
+ # Citation
212
+
213
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
214
+
215
+ **BibTeX:**
216
+
217
+ More information needed
218
+
219
+ **APA:**
220
+
221
+ More information needed
222
+
223
+ # Glossary [optional]
224
+
225
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
226
+
227
+ More information needed
228
+
229
+ # More Information [optional]
230
+
231
+ More information needed
232
+
233
+ # Model Card Authors [optional]
234
+
235
+ <!-- This section provides another layer of transparency and accountability. Whose views is this model card representing? How many voices were included in its construction? Etc. -->
236
+
237
+ More information needed
238
+
239
+ # Model Card Contact
240
+
241
+ More information needed
242
+
243
+ # How to Get Started with the Model
244
+
245
+ Use the code below to get started with the model.
246
+
247
+ <details>
248
+ <summary> Click to expand </summary>
249
+
250
+ More information needed
251
+
252
+ </details>