yvelos commited on
Commit
a165f58
1 Parent(s): 52e9e2d

update readme

Browse files
Files changed (1) hide show
  1. README.md +146 -2
README.md CHANGED
@@ -1,4 +1,148 @@
1
  ---
2
- license: openrail
 
 
 
 
 
 
 
 
 
 
 
 
3
  ---
4
- # TSOTSALLM
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ license: mit
3
+ datasets:
4
+ - GAIR/lima
5
+ - OpenAssistant/oasst1
6
+ - databricks/databricks-dolly-15k
7
+ - cnn_dailymail
8
+ - ai2_arc
9
+ language:
10
+ - en
11
+ metrics:
12
+ - lhy/ranking_loss
13
+ library_name: transformers
14
+ pipeline_tag: text-generation
15
  ---
16
+ ---
17
+ # For reference on model card metadata, see the spec: https://github.com/huggingface/hub-docs/blob/main/modelcard.md?plain=1
18
+ # Doc / guide: https://huggingface.co/docs/hub/model-cards
19
+ {{ card_data }}
20
+ ---
21
+
22
+ # Model Card for TSOTSALLM
23
+
24
+ <!-- Provide a quick summary of what the model is/does. -->
25
+
26
+ ## Model Details
27
+
28
+ ### Model Description
29
+
30
+ <!-- Provide a longer summary of what this model is. -->
31
+
32
+ ### Model Sources [optional]
33
+
34
+ <!-- Provide the basic links for the model. -->
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
+ ### Downstream Use [optional]
45
+
46
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
47
+
48
+
49
+ ### Out-of-Scope Use
50
+
51
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
52
+
53
+ ## Bias, Risks, and Limitations
54
+
55
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
56
+
57
+ ### Recommendations
58
+
59
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
60
+
61
+ ## How to Get Started with the Model
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
+ ### Training Procedure
70
+
71
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
72
+
73
+ #### Preprocessing [optional]
74
+
75
+
76
+ #### Training Hyperparameters
77
+
78
+ #### Speeds, Sizes, Times [optional]
79
+
80
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
81
+
82
+ ## Evaluation
83
+
84
+ <!-- This section describes the evaluation protocols and provides the results. -->
85
+
86
+ ### Testing Data, Factors & Metrics
87
+
88
+ #### Testing Data
89
+
90
+ <!-- This should link to a Dataset Card if possible. -->
91
+
92
+ #### Factors
93
+
94
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
95
+
96
+
97
+ #### Metrics
98
+
99
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
100
+
101
+ {{ testing_metrics | default("[More Information Needed]", true)}}
102
+
103
+ ### Results
104
+
105
+ {{ results | default("[More Information Needed]", true)}}
106
+
107
+ #### Summary
108
+
109
+ {{ results_summary | default("", true) }}
110
+
111
+ ## Model Examination [optional]
112
+
113
+ <!-- Relevant interpretability work for the model goes here -->
114
+
115
+ {{ model_examination | default("[More Information Needed]", true)}}
116
+
117
+ ## Environmental Impact
118
+
119
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
120
+
121
+ 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).
122
+
123
+
124
+ ## Technical Specifications [optional]
125
+
126
+ ### Model Architecture and Objective
127
+
128
+ ### Compute Infrastructure
129
+
130
+ #### Hardware
131
+
132
+ #### Software
133
+
134
+ ## Citation [optional]
135
+
136
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
137
+
138
+ ## Glossary [optional]
139
+
140
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
141
+
142
+
143
+ ## More Information [optional]
144
+
145
+
146
+ ## Model Card Authors [optional]
147
+
148
+ ## Model Card Contact