RayanNan commited on
Commit
c260cc5
·
verified ·
1 Parent(s): 261e872

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +13 -132
README.md CHANGED
@@ -2,6 +2,12 @@
2
  library_name: transformers
3
  tags:
4
  - llama-factory
 
 
 
 
 
 
5
  ---
6
 
7
  # Model Card for Model ID
@@ -18,13 +24,12 @@ tags:
18
 
19
  This model is trained basing on Mistral, which is used to detect sentiment of social media.
20
 
21
- - **Developed by:** Nan Ye, Zhen Ma, Chi Zhang
22
- - **Funded by [optional]:** WenZhou Kean University
23
- - **Shared by [optional]:** [More Information Needed]
24
- - **Model type:** [More Inf
25
- - **Language(s) (NLP):** Only English
26
  - **License:** [More Information Needed]
27
- - **Finetuned from model [optional]:** [More Information Needed]
28
  -
29
 
30
 
@@ -45,7 +50,7 @@ This model is trained basing on Mistral, which is used to detect sentiment of so
45
  ## Bias, Risks, and Limitations
46
 
47
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
48
-
49
  [More Information Needed]
50
 
51
  ### Recommendations
@@ -54,133 +59,9 @@ This model is trained basing on Mistral, which is used to detect sentiment of so
54
 
55
  Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
56
 
57
- ## How to Get Started with the Model
58
-
59
- Use the code below to get started with the model.
60
-
61
- [More Information Needed]
62
-
63
  ## Training Details
64
 
65
  ### Training Data
66
 
67
  <!-- 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. -->
68
-
69
- [More Information Needed]
70
-
71
- ### Training Procedure
72
-
73
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
74
-
75
- #### Preprocessing [optional]
76
-
77
- [More Information Needed]
78
-
79
-
80
- #### Training Hyperparameters
81
-
82
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
83
-
84
- #### Speeds, Sizes, Times [optional]
85
-
86
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
87
-
88
- [More Information Needed]
89
-
90
- ## Evaluation
91
-
92
- <!-- This section describes the evaluation protocols and provides the results. -->
93
-
94
- ### Testing Data, Factors & Metrics
95
-
96
- #### Testing Data
97
-
98
- <!-- This should link to a Dataset Card if possible. -->
99
-
100
- [More Information Needed]
101
-
102
- #### Factors
103
-
104
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
105
-
106
- [More Information Needed]
107
-
108
- #### Metrics
109
-
110
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
111
-
112
- [More Information Needed]
113
-
114
- ### Results
115
-
116
- [More Information Needed]
117
-
118
- #### Summary
119
-
120
-
121
-
122
- ## Model Examination [optional]
123
-
124
- <!-- Relevant interpretability work for the model goes here -->
125
-
126
- [More Information Needed]
127
-
128
- ## Environmental Impact
129
-
130
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
131
-
132
- 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).
133
-
134
- - **Hardware Type:** [More Information Needed]
135
- - **Hours used:** [More Information Needed]
136
- - **Cloud Provider:** [More Information Needed]
137
- - **Compute Region:** [More Information Needed]
138
- - **Carbon Emitted:** [More Information Needed]
139
-
140
- ## Technical Specifications [optional]
141
-
142
- ### Model Architecture and Objective
143
-
144
- [More Information Needed]
145
-
146
- ### Compute Infrastructure
147
-
148
- [More Information Needed]
149
-
150
- #### Hardware
151
-
152
- [More Information Needed]
153
-
154
- #### Software
155
-
156
- [More Information Needed]
157
-
158
- ## Citation [optional]
159
-
160
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
161
-
162
- **BibTeX:**
163
-
164
- [More Information Needed]
165
-
166
- **APA:**
167
-
168
- [More Information Needed]
169
-
170
- ## Glossary [optional]
171
-
172
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
173
-
174
- [More Information Needed]
175
-
176
- ## More Information [optional]
177
-
178
- [More Information Needed]
179
-
180
- ## Model Card Authors [optional]
181
-
182
- [More Information Needed]
183
-
184
- ## Model Card Contact
185
-
186
- [More Information Needed]
 
2
  library_name: transformers
3
  tags:
4
  - llama-factory
5
+ datasets:
6
+ - RayanNan/Sentimentanalysis-endangeredspecies
7
+ language:
8
+ - en
9
+ metrics:
10
+ - accuracy
11
  ---
12
 
13
  # Model Card for Model ID
 
24
 
25
  This model is trained basing on Mistral, which is used to detect sentiment of social media.
26
 
27
+ - **Author and their Hugging Face Account:** Nan Ye(RayanNan), Zhen Ma(Mark01927), Chi Zhang(BillZhang0325), Jiayin Li(Moriacrafter)
28
+ - **Funded by:** WenZhou Kean University
29
+ - **Model type:** LLM
30
+ - **Language(s) (NLP):** English
 
31
  - **License:** [More Information Needed]
32
+ - **Finetuned from model [optional]:** e5-mistral-7b-instruct
33
  -
34
 
35
 
 
50
  ## Bias, Risks, and Limitations
51
 
52
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
53
+ The model we used to finetune the model is only considered about the Positive and Negative sentiment, the netural sentiment is not included
54
  [More Information Needed]
55
 
56
  ### Recommendations
 
59
 
60
  Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
61
 
 
 
 
 
 
 
62
  ## Training Details
63
 
64
  ### Training Data
65
 
66
  <!-- 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. -->
67
+ the model is trained basing on our own dataset with the link: RayanNan/Sentimentanalysis-endangeredspecies