Vcecca commited on
Commit
06ef86b
·
verified ·
1 Parent(s): e970162

Add model card

Browse files
Files changed (1) hide show
  1. README.md +81 -199
README.md CHANGED
@@ -1,199 +1,81 @@
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
+ library_name: transformers
6
+ pipeline_tag: text-generation
7
+ tags:
8
+ - mamba
9
+ - state-space-model
10
+ - ssm
11
+ - causal-lm
12
+ - pytorch
13
+ - pretrained
14
+ datasets:
15
+ - wikimedia/wikipedia
16
+ ---
17
+
18
+ # Mamba-50M
19
+
20
+ A ~50M-parameter [Mamba](https://arxiv.org/abs/2312.00752) (selective state-space) causal
21
+ language model, **pretrained from scratch on English Wikipedia**. Mamba replaces the attention
22
+ mechanism of a Transformer with a selective state-space layer, giving linear-time sequence
23
+ processing instead of the quadratic cost of self-attention.
24
+
25
+ > **This is a base model: pretrained only.** It has **not** been fine-tuned, instruction-tuned,
26
+ > RLHF'd, or aligned in any way. It is a raw next-token predictor intended for research.
27
+
28
+ ## Model details
29
+
30
+ | | |
31
+ |---|---|
32
+ | Architecture | Mamba (selective SSM) |
33
+ | Parameters | ~50M |
34
+ | Context length | 512 tokens |
35
+ | Tokenizer | [GPT-NeoX-20B](https://huggingface.co/EleutherAI/gpt-neox-20b) (BPE, ~50k vocab) — the same tokenizer used by the original `state-spaces/mamba-*` models |
36
+ | Language | English |
37
+ | License | Apache-2.0 |
38
+
39
+ ## Limitations
40
+
41
+ - **Pretrained only.** No fine-tuning, instruction tuning, or alignment. It does not follow instructions and has no safety filtering; it simply continues text.
42
+ - **Small.** At ~50M parameters it has limited fluency and reasoning; expect frequent hallucination and repetition.
43
+ - **English only.** Trained solely on English Wikipedia; other languages are out of distribution.
44
+ - **Domain-narrow.** Only Wikipedia was used as training data.
45
+
46
+ ## Training data
47
+
48
+ Pretrained on the English subset of Wikipedia: over 3 million articles.
49
+
50
+ ### Training procedure
51
+
52
+ | Hyperparameter | Value |
53
+ |---|---|
54
+ | Learning rate | 5e-4 |
55
+ | Sequence length | 512 |
56
+ | Batch size | 64 |
57
+ | Tokenizer | GPT-NeoX-20B (`EleutherAI/gpt-neox-20b`) |
58
+ | Optimizer | `AdamW` |
59
+ | LR schedule / warmup | `constant` / `10000` |
60
+ | Total tokens seen | `~ 2.5-2.9B` |
61
+ | Hardware | `2x Nvidia Quadro RTX 6000 24GB` |
62
+
63
+ ## Evaluation
64
+
65
+ Evaluated on a held-out set of **10,000 Wikipedia articles** that were not seen during training.
66
+ The training and evaluation loss curves are shown below.
67
+
68
+ ![Training and evaluation loss](loss_curves.png)
69
+
70
+ ## Citation
71
+
72
+ If you use this model, please cite the Mamba paper:
73
+
74
+ ```bibtex
75
+ @article{gu2023mamba,
76
+ title={Mamba: Linear-Time Sequence Modeling with Selective State Spaces},
77
+ author={Gu, Albert and Dao, Tri},
78
+ journal={arXiv preprint arXiv:2312.00752},
79
+ year={2023}
80
+ }
81
+ ```