claudios commited on
Commit
6025bb2
1 Parent(s): a2b1093

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +174 -190
README.md CHANGED
@@ -1,199 +1,183 @@
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:
3
+ - en
4
+ license: apache-2.0
5
  ---
6
 
7
+ This is an *unofficial* reupload of [microsoft/unixcoder-base](https://huggingface.co/microsoft/unixcoder-base) in the `SafeTensors` format using `transformers` `4.40.1`. The goal of this reupload is to prevent older models that are still relevant baselines from becoming stale as a result of changes in HuggingFace. Additionally, I may include minor corrections, such as model max length configuration.
8
 
9
+ Original model card below:
10
 
11
+ ---
12
 
13
+ # Model Card for UniXcoder-base
14
+
15
+
16
+
17
+ # Model Details
18
+
19
+ ## Model Description
20
+ UniXcoder is a unified cross-modal pre-trained model that leverages multimodal data (i.e. code comment and AST) to pretrain code representation.
21
+
22
+ - **Developed by:** Microsoft Team
23
+ - **Shared by [Optional]:** Hugging Face
24
+ - **Model type:** Feature Engineering
25
+ - **Language(s) (NLP):** en
26
+ - **License:** Apache-2.0
27
+ - **Related Models:**
28
+ - **Parent Model:** RoBERTa
29
+ - **Resources for more information:**
30
+ - [Associated Paper](https://arxiv.org/abs/2203.03850)
31
+
32
+ # Uses
33
+
34
+
35
+
36
+ ## Direct Use
37
+ Feature Engineering
38
+
39
+
40
+ ## Downstream Use [Optional]
41
+
42
+ More information needed
43
+
44
+ ## Out-of-Scope Use
45
+
46
+ More information needed
47
+
48
+ # Bias, Risks, and Limitations
49
+
50
+ 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.
51
+
52
+
53
+ ## Recommendations
54
+
55
+
 
 
 
 
 
 
 
 
 
 
 
 
 
 
56
  Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
57
+
58
+
59
+ # Training Details
60
+
61
+ ## Training Data
62
+
63
+ More information needed
64
+
65
+ ## Training Procedure
66
+
67
+ ### Preprocessing
68
+
69
+ More information needed
70
+
71
+ ### Speeds, Sizes, Times
72
+ More information needed
73
+
74
+ # Evaluation
75
+
76
+
77
+ ## Testing Data, Factors & Metrics
78
+
79
+ ### Testing Data
80
+ More information needed
81
+
82
+ ### Factors
83
+
84
+ The model creators note in the [associated paper](https://arxiv.org/abs/2203.03850):
85
+
86
+ > UniXcoder has slightly worse BLEU-4 scores on both code summarization and generation tasks. The main reasons may come from two aspects. One is the amount of NL-PL pairs in the pre-training data
87
+
88
+ ### Metrics
89
+
90
+ The model creators note in the [associated paper](https://arxiv.org/abs/2203.03850):
91
+
92
+ > We evaluate UniXcoder on five tasks over nine public datasets, including two understanding tasks, two generation tasks and an autoregressive task. To further evaluate the performance of code fragment embeddings, we also propose a new task called zero-shot code-to-code search.
93
+
94
+ ## Results
95
+
96
+ The model creators note in the [associated paper](https://arxiv.org/abs/2203.03850):
97
+
98
+ >Taking zero-shot code-code search task as an example, after removing contrastive learning, the performance drops from 20.45% to 13.73%.
99
+
100
+ # Model Examination
101
+
102
+ More information needed
103
+
104
+ # Environmental Impact
105
+
106
+
107
+
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
108
  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).
109
+
110
+ - **Hardware Type:** More information needed
111
+ - **Hours used:** More information needed
112
+ - **Cloud Provider:** More information needed
113
+ - **Compute Region:** More information needed
114
+ - **Carbon Emitted:** More information needed
115
+
116
+ # Technical Specifications [optional]
117
+
118
+ ## Model Architecture and Objective
119
+
120
+ More information needed
121
+
122
+ ## Compute Infrastructure
123
+
124
+ More information needed
125
+
126
+ ### Hardware
127
+
128
+ More information needed
129
+
130
+ ### Software
131
+
132
+ More information needed
133
+
134
+ # Citation
135
+
136
+
 
137
  **BibTeX:**
138
+ ```
139
+ @misc{https://doi.org/10.48550/arxiv.2203.03850,
140
+ doi = {10.48550/ARXIV.2203.03850},
141
+
142
+ url = {https://arxiv.org/abs/2203.03850},
143
+
144
+ author = {Guo, Daya and Lu, Shuai and Duan, Nan and Wang, Yanlin and Zhou, Ming and Yin, Jian},
145
+
146
+ keywords = {Computation and Language (cs.CL), Programming Languages (cs.PL), Software Engineering (cs.SE), FOS: Computer and information sciences, FOS: Computer and information sciences},
147
+
148
+ title = {UniXcoder: Unified Cross-Modal Pre-training for Code
149
+ ```
150
+
151
+
152
+ # Glossary [optional]
153
+
154
+ More information needed
155
+
156
+ # More Information [optional]
157
+
158
+ More information needed
159
+
160
+ # Model Card Authors [optional]
161
+
162
+ Microsoft Team in collaboration with Ezi Ozoani and the Hugging Face Team.
163
+
164
+ # Model Card Contact
165
+
166
+ More information needed
167
+
168
+ # How to Get Started with the Model
169
+
170
+ Use the code below to get started with the model.
171
+
172
+ <details>
173
+ <summary> Click to expand </summary>
174
+
175
+ ```python
176
+ from transformers import AutoTokenizer, AutoModel
177
+
178
+ tokenizer = AutoTokenizer.from_pretrained("microsoft/unixcoder-base")
179
+
180
+ model = AutoModel.from_pretrained("microsoft/unixcoder-base")
181
+
182
+ ```
183
+ </details>