Update README.md
Browse files
README.md
CHANGED
|
@@ -24,7 +24,7 @@ After pre-training, the model is instruction-tuned on two additional datasets (8
|
|
| 24 |
- an educational dataset based on an augmented version of Simple English Wikipedia (to be released soon).
|
| 25 |
|
| 26 |
|
| 27 |
-
This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
|
| 28 |
|
| 29 |
- **Developed by:** [More Information Needed]
|
| 30 |
- **Funded by [optional]:** [More Information Needed]
|
|
@@ -36,8 +36,10 @@ This is the model card of a 🤗 transformers model that has been pushed on the
|
|
| 36 |
|
| 37 |
### Model Sources [optional]
|
| 38 |
|
| 39 |
-
|
| 40 |
|
|
|
|
|
|
|
| 41 |
- **Repository:** [More Information Needed]
|
| 42 |
- **Paper [optional]:** [More Information Needed]
|
| 43 |
- **Demo [optional]:** [More Information Needed]
|
|
@@ -46,28 +48,33 @@ This is the model card of a 🤗 transformers model that has been pushed on the
|
|
| 46 |
|
| 47 |
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
| 48 |
|
|
|
|
| 49 |
### Direct Use
|
| 50 |
|
| 51 |
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
| 52 |
|
|
|
|
| 53 |
[More Information Needed]
|
| 54 |
|
| 55 |
### Downstream Use [optional]
|
| 56 |
|
| 57 |
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
| 58 |
|
|
|
|
| 59 |
[More Information Needed]
|
| 60 |
|
| 61 |
### Out-of-Scope Use
|
| 62 |
|
| 63 |
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
| 64 |
|
|
|
|
| 65 |
[More Information Needed]
|
| 66 |
|
| 67 |
## Bias, Risks, and Limitations
|
| 68 |
|
| 69 |
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
| 70 |
|
|
|
|
| 71 |
[More Information Needed]
|
| 72 |
|
| 73 |
### Recommendations
|
|
@@ -76,6 +83,7 @@ This is the model card of a 🤗 transformers model that has been pushed on the
|
|
| 76 |
|
| 77 |
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
| 78 |
|
|
|
|
| 79 |
## How to Get Started with the Model
|
| 80 |
|
| 81 |
Use the code below to get started with the model.
|
|
@@ -88,50 +96,57 @@ Use the code below to get started with the model.
|
|
| 88 |
|
| 89 |
<!-- 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. -->
|
| 90 |
|
|
|
|
| 91 |
[More Information Needed]
|
| 92 |
|
| 93 |
### Training Procedure
|
| 94 |
|
| 95 |
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
| 96 |
|
|
|
|
| 97 |
#### Preprocessing [optional]
|
| 98 |
|
| 99 |
[More Information Needed]
|
| 100 |
|
| 101 |
|
|
|
|
| 102 |
#### Training Hyperparameters
|
| 103 |
|
| 104 |
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
| 105 |
|
|
|
|
| 106 |
#### Speeds, Sizes, Times [optional]
|
| 107 |
|
| 108 |
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
| 109 |
-
|
| 110 |
[More Information Needed]
|
|
|
|
| 111 |
|
| 112 |
## Evaluation
|
| 113 |
|
| 114 |
The model has been submitted to the 2025 BabyLM Challenge – Interaction Track:
|
| 115 |
https://huggingface.co/spaces/BabyLM-community/babylm-leaderboard-2025-all-tasks
|
| 116 |
|
|
|
|
|
|
|
| 117 |
### Testing Data, Factors & Metrics
|
| 118 |
|
| 119 |
#### Testing Data
|
| 120 |
|
| 121 |
<!-- This should link to a Dataset Card if possible. -->
|
| 122 |
-
|
| 123 |
[More Information Needed]
|
| 124 |
|
| 125 |
#### Factors
|
| 126 |
|
| 127 |
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
| 128 |
-
|
| 129 |
[More Information Needed]
|
| 130 |
|
| 131 |
#### Metrics
|
| 132 |
|
| 133 |
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
| 134 |
-
|
| 135 |
[More Information Needed]
|
| 136 |
|
| 137 |
### Results
|
|
@@ -145,7 +160,7 @@ https://huggingface.co/spaces/BabyLM-community/babylm-leaderboard-2025-all-tasks
|
|
| 145 |
## Model Examination [optional]
|
| 146 |
|
| 147 |
<!-- Relevant interpretability work for the model goes here -->
|
| 148 |
-
|
| 149 |
[More Information Needed]
|
| 150 |
|
| 151 |
## Environmental Impact
|
|
@@ -153,7 +168,7 @@ https://huggingface.co/spaces/BabyLM-community/babylm-leaderboard-2025-all-tasks
|
|
| 153 |
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
| 154 |
|
| 155 |
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).
|
| 156 |
-
|
| 157 |
- **Hardware Type:** [More Information Needed]
|
| 158 |
- **Hours used:** [More Information Needed]
|
| 159 |
- **Cloud Provider:** [More Information Needed]
|
|
@@ -181,7 +196,7 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
|
|
| 181 |
## Citation [optional]
|
| 182 |
|
| 183 |
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
| 184 |
-
|
| 185 |
**BibTeX:**
|
| 186 |
|
| 187 |
[More Information Needed]
|
|
@@ -193,7 +208,7 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
|
|
| 193 |
## Glossary [optional]
|
| 194 |
|
| 195 |
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
| 196 |
-
|
| 197 |
[More Information Needed]
|
| 198 |
|
| 199 |
## More Information [optional]
|
|
@@ -206,4 +221,4 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
|
|
| 206 |
|
| 207 |
## Model Card Contact
|
| 208 |
|
| 209 |
-
[More Information Needed]
|
|
|
|
| 24 |
- an educational dataset based on an augmented version of Simple English Wikipedia (to be released soon).
|
| 25 |
|
| 26 |
|
| 27 |
+
<!-- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
|
| 28 |
|
| 29 |
- **Developed by:** [More Information Needed]
|
| 30 |
- **Funded by [optional]:** [More Information Needed]
|
|
|
|
| 36 |
|
| 37 |
### Model Sources [optional]
|
| 38 |
|
| 39 |
+
-->
|
| 40 |
|
| 41 |
+
<!-- Provide the basic links for the model. -->
|
| 42 |
+
<!--
|
| 43 |
- **Repository:** [More Information Needed]
|
| 44 |
- **Paper [optional]:** [More Information Needed]
|
| 45 |
- **Demo [optional]:** [More Information Needed]
|
|
|
|
| 48 |
|
| 49 |
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
| 50 |
|
| 51 |
+
<!--
|
| 52 |
### Direct Use
|
| 53 |
|
| 54 |
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
| 55 |
|
| 56 |
+
<!--
|
| 57 |
[More Information Needed]
|
| 58 |
|
| 59 |
### Downstream Use [optional]
|
| 60 |
|
| 61 |
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
| 62 |
|
| 63 |
+
<!--
|
| 64 |
[More Information Needed]
|
| 65 |
|
| 66 |
### Out-of-Scope Use
|
| 67 |
|
| 68 |
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
| 69 |
|
| 70 |
+
<!--
|
| 71 |
[More Information Needed]
|
| 72 |
|
| 73 |
## Bias, Risks, and Limitations
|
| 74 |
|
| 75 |
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
| 76 |
|
| 77 |
+
<!--
|
| 78 |
[More Information Needed]
|
| 79 |
|
| 80 |
### Recommendations
|
|
|
|
| 83 |
|
| 84 |
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
| 85 |
|
| 86 |
+
<!--
|
| 87 |
## How to Get Started with the Model
|
| 88 |
|
| 89 |
Use the code below to get started with the model.
|
|
|
|
| 96 |
|
| 97 |
<!-- 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. -->
|
| 98 |
|
| 99 |
+
<!--
|
| 100 |
[More Information Needed]
|
| 101 |
|
| 102 |
### Training Procedure
|
| 103 |
|
| 104 |
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
| 105 |
|
| 106 |
+
<!--
|
| 107 |
#### Preprocessing [optional]
|
| 108 |
|
| 109 |
[More Information Needed]
|
| 110 |
|
| 111 |
|
| 112 |
+
<!--
|
| 113 |
#### Training Hyperparameters
|
| 114 |
|
| 115 |
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
| 116 |
|
| 117 |
+
<!--
|
| 118 |
#### Speeds, Sizes, Times [optional]
|
| 119 |
|
| 120 |
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
| 121 |
+
<!--
|
| 122 |
[More Information Needed]
|
| 123 |
+
-->
|
| 124 |
|
| 125 |
## Evaluation
|
| 126 |
|
| 127 |
The model has been submitted to the 2025 BabyLM Challenge – Interaction Track:
|
| 128 |
https://huggingface.co/spaces/BabyLM-community/babylm-leaderboard-2025-all-tasks
|
| 129 |
|
| 130 |
+
|
| 131 |
+
<!--
|
| 132 |
### Testing Data, Factors & Metrics
|
| 133 |
|
| 134 |
#### Testing Data
|
| 135 |
|
| 136 |
<!-- This should link to a Dataset Card if possible. -->
|
| 137 |
+
<!--
|
| 138 |
[More Information Needed]
|
| 139 |
|
| 140 |
#### Factors
|
| 141 |
|
| 142 |
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
| 143 |
+
<!--
|
| 144 |
[More Information Needed]
|
| 145 |
|
| 146 |
#### Metrics
|
| 147 |
|
| 148 |
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
| 149 |
+
<!--
|
| 150 |
[More Information Needed]
|
| 151 |
|
| 152 |
### Results
|
|
|
|
| 160 |
## Model Examination [optional]
|
| 161 |
|
| 162 |
<!-- Relevant interpretability work for the model goes here -->
|
| 163 |
+
<!--
|
| 164 |
[More Information Needed]
|
| 165 |
|
| 166 |
## Environmental Impact
|
|
|
|
| 168 |
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
| 169 |
|
| 170 |
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).
|
| 171 |
+
<!--
|
| 172 |
- **Hardware Type:** [More Information Needed]
|
| 173 |
- **Hours used:** [More Information Needed]
|
| 174 |
- **Cloud Provider:** [More Information Needed]
|
|
|
|
| 196 |
## Citation [optional]
|
| 197 |
|
| 198 |
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
| 199 |
+
<!--
|
| 200 |
**BibTeX:**
|
| 201 |
|
| 202 |
[More Information Needed]
|
|
|
|
| 208 |
## Glossary [optional]
|
| 209 |
|
| 210 |
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
| 211 |
+
<!--
|
| 212 |
[More Information Needed]
|
| 213 |
|
| 214 |
## More Information [optional]
|
|
|
|
| 221 |
|
| 222 |
## Model Card Contact
|
| 223 |
|
| 224 |
+
[More Information Needed]-->
|