FlameF0X commited on
Commit
97172ac
·
verified ·
1 Parent(s): 371cb65

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +143 -0
README.md ADDED
@@ -0,0 +1,143 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language:
3
+ - en
4
+ base_model:
5
+ - google/gemma-2-2b-it
6
+ pipeline_tag: text-generation
7
+ ---
8
+ # Model Card for Model ID
9
+
10
+ <!-- Provide a quick summary of what the model is/does. -->
11
+
12
+ This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
13
+
14
+ ## Model Details
15
+
16
+ ### Model Description
17
+
18
+ <!-- Provide a longer summary of what this model is. -->
19
+
20
+
21
+
22
+ - **Developed by:** [More Information Needed]
23
+ - **Funded by [optional]:** [More Information Needed]
24
+ - **Shared by [optional]:** [More Information Needed]
25
+ - **Model type:** [More Information Needed]
26
+ - **Language(s) (NLP):** [More Information Needed]
27
+ - **License:** [More Information Needed]
28
+ - **Finetuned from model [optional]:** [More Information Needed]
29
+
30
+ ### Model Sources [optional]
31
+
32
+ <!-- Provide the basic links for the model. -->
33
+
34
+ - **Repository:** [More Information Needed]
35
+ - **Paper [optional]:** [More Information Needed]
36
+ - **Demo [optional]:** [More Information Needed]
37
+
38
+ ## Uses
39
+
40
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
41
+
42
+ ### Direct Use
43
+
44
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
45
+
46
+ [More Information Needed]
47
+
48
+ ### Out-of-Scope Use
49
+
50
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
51
+
52
+ [More Information Needed]
53
+
54
+ ## Bias, Risks, and Limitations
55
+
56
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
57
+
58
+ [More Information Needed]
59
+
60
+ ### Recommendations
61
+
62
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
63
+
64
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
65
+
66
+ ## How to Get Started with the Model
67
+
68
+ Use the code below to get started with the model.
69
+
70
+ [More Information Needed]
71
+
72
+ ## Training Details
73
+
74
+ ### Training Data
75
+
76
+ <!-- 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. -->
77
+
78
+ [More Information Needed]
79
+
80
+ ### Training Procedure
81
+
82
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
83
+
84
+ #### Training Hyperparameters
85
+
86
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
87
+
88
+ ## Evaluation
89
+
90
+ <!-- This section describes the evaluation protocols and provides the results. -->
91
+
92
+ ### Testing Data, Factors & Metrics
93
+
94
+ #### Testing Data
95
+
96
+ <!-- This should link to a Dataset Card if possible. -->
97
+
98
+ [More Information Needed]
99
+
100
+ #### Factors
101
+
102
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
103
+
104
+ [More Information Needed]
105
+
106
+ #### Metrics
107
+
108
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
109
+
110
+ [More Information Needed]
111
+
112
+ ### Results
113
+
114
+ [More Information Needed]
115
+
116
+ #### Summary
117
+
118
+
119
+ [More Information Needed]
120
+
121
+ ## Environmental Impact
122
+
123
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
124
+
125
+ 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).
126
+
127
+ - **Hardware Type:** [More Information Needed]
128
+ - **Hours used:** [More Information Needed]
129
+ - **Cloud Provider:** [More Information Needed]
130
+ - **Compute Region:** [More Information Needed]
131
+ - **Carbon Emitted:** [More Information Needed]
132
+
133
+ ### Compute Infrastructure
134
+
135
+ [More Information Needed]
136
+
137
+ #### Hardware
138
+
139
+ [More Information Needed]
140
+
141
+ #### Software
142
+
143
+ [More Information Needed]