Update README.md

README.md

@@ -9,6 +9,9 @@ metrics:
 model-index:
 - name: stack-edu-classifier-c
   results: []
+language:
+- code
+library_name: transformers
 ---
 
 <!-- This model card has been generated automatically according to the information the Trainer had access to. You
@@ -16,29 +19,58 @@ should probably proofread and complete it, then remove this comment. -->
 
 # stack-edu-classifier-c
 
-This model is a fine-tuned version of [bigcode/starencoder](https://huggingface.co/bigcode/starencoder) on an unknown dataset.
-It achieves the following results on the evaluation set:
-- Loss: 0.4660
-- Precision: 0.4766
-- Recall: 0.3489
-- F1 Macro: 0.3689
-- Accuracy: 0.5471
-- F1 Binary Minimum3: 0.7028
+This is a classifier for scoring the educational value of code files in The Stack v2 dataset, it is a finetuned version of [bigcode/starencoder](https://huggingface.co/bigcode/starencoder) with a classification head on code files annotated by Llama3.1-70B-Instruct. We use this classifier for building Stack-Edu dataset used for training SmolLM2, see [paper](https://arxiv.org/pdf/2502.02737). Each classifier is trained on one programming language.
+
+### How to use in transformers
+To load the classifier, use the following code:
+
+```python
+from transformers import AutoTokenizer, AutoModelForSequenceClassification
+
+tokenizer = AutoTokenizer.from_pretrained(REPO_NAME)
+model = AutoModelForSequenceClassification.from_pretrained(REPO_NAME)
 
-## Model description
+text = "This is a test sentence."
+inputs = tokenizer(text, return_tensors="pt", padding="longest", truncation=True)
+outputs = model(**inputs)
+logits = outputs.logits.squeeze(-1).float().detach().numpy()
+score = logits.item()
+result = {
+    "text": text,
+    "score": score,
+    "int_score": int(round(max(0, min(score, 5)))),
+}
 
-More information needed
+print(result)
+# {'text': 'This is a test sentence.', 'score': 0.07964489609003067, 'int_score': 0}
+```
 
 ## Intended uses & limitations
 
-More information needed
+While the classifier performs well in distinguishing high-quality code in its target language (C in this case), there are some limitations:
 
-## Training and evaluation data
+- Scope: The model's performance might change for other datasets, in particular for out of distribution samples. The classifier's context is 1024 tokens, which might not be sufficient to assess the quality of some long code files.
+- Bias: The model's performance is dependent on the quality and representativeness of the training data and the LLM used for the annotation. Biases in both can affect the classifier's judgments. It might overfit to thoroughly commented code.
+- Context: The classifier evaluates individual code files without considering broader context, which might impact its effectiveness in certain scenarios.
 
-More information needed
+The training and inference code is available on GitHub 
+https://github.com/huggingface/cosmopedia/tree/main/classification
 
 ## Training procedure
 
+The classifier was trained on 500,000 pairs of code files and their scores from 0 to 5, generated by Llama3.1. The samples were annotated based on their educational quality with 1 being not educational and 5 being highly educational and relevant for teaching programming. You can find the prompt used for building the annotations in the appendix of [SmolLM2 paper](https://arxiv.org/pdf/2502.02737).
+
+We added a classification head with a single regression output to StarEncoder and trained the model for 20 epochs with a learning rate of 3e-4. During training, the embedding and encoder layers were frozen to focus on the classification head. 
+
+It achieves the following results on the evaluation set:
+- Loss: 0.4660
+- Precision: 0.4766
+- Recall: 0.3489
+- F1 Macro: 0.3689
+- Accuracy: 0.5471
+- F1 Binary Minimum3: 0.7028
+
+While the macro F1 scores across the 1-5 rating scale are relatively low due to the model's difficulty in distinguishing between higher-rated samples, the classifier performs well for our primary filtering task. When converting to binary classification, using a threshold of 2 achieves the F1 scores ranges between 0.8 and 0.9 for most Stack-Edu  classifiers, whereas a threshold of 3 yields F1 scores between 0.55 and 0.70. With the Highest being C and Python and the lowest being JavaScript and PhP.
 ### Training hyperparameters
 
 The following hyperparameters were used during training:
@@ -55,29 +87,19 @@ The following hyperparameters were used during training:
 - lr_scheduler_warmup_steps: 200
 - num_epochs: 20
 
-### Training results
-
-| Training Loss | Epoch   | Step  | Validation Loss | Precision | Recall | F1 Macro | Accuracy | F1 Binary Minimum3 |
-|:-------------:|:-------:|:-----:|:---------------:|:---------:|:------:|:--------:|:--------:|:------------------:|
-| No log        | 0       | 0     | 5.6344          | 0.0030    | 0.1667 | 0.0058   | 0.0178   | 0                  |
-| 0.5079        | 1.4493  | 1000  | 0.5017          | 0.4119    | 0.3155 | 0.3188   | 0.5307   | 0.6809             |
-| 0.5001        | 2.8986  | 2000  | 0.4960          | 0.4423    | 0.3275 | 0.3419   | 0.5208   | 0.7030             |
-| 0.4739        | 4.3478  | 3000  | 0.4846          | 0.4462    | 0.3255 | 0.3353   | 0.5374   | 0.6863             |
-| 0.4739        | 5.7971  | 4000  | 0.4784          | 0.4522    | 0.3223 | 0.3328   | 0.5354   | 0.6934             |
-| 0.4508        | 7.2464  | 5000  | 0.4890          | 0.4492    | 0.3423 | 0.3540   | 0.5409   | 0.6770             |
-| 0.4798        | 8.6957  | 6000  | 0.4746          | 0.4663    | 0.3353 | 0.3520   | 0.5308   | 0.7028             |
-| 0.4613        | 10.1449 | 7000  | 0.4775          | 0.4707    | 0.3254 | 0.3405   | 0.5385   | 0.6900             |
-| 0.4668        | 11.5942 | 8000  | 0.4934          | 0.4711    | 0.3347 | 0.3526   | 0.5149   | 0.7036             |
-| 0.4657        | 13.0435 | 9000  | 0.4690          | 0.4797    | 0.3330 | 0.3496   | 0.5390   | 0.7002             |
-| 0.4561        | 14.4928 | 10000 | 0.4676          | 0.4807    | 0.3375 | 0.3561   | 0.5398   | 0.7040             |
-| 0.4597        | 15.9420 | 11000 | 0.4668          | 0.4788    | 0.3336 | 0.3497   | 0.5413   | 0.7037             |
-| 0.4524        | 17.3913 | 12000 | 0.4680          | 0.4759    | 0.3353 | 0.3541   | 0.5370   | 0.7038             |
-| 0.4674        | 18.8406 | 13000 | 0.4660          | 0.4766    | 0.3489 | 0.3689   | 0.5471   | 0.7028             |
-
-
-### Framework versions
-
-- Transformers 4.43.4
-- Pytorch 2.4.0+cu121
-- Datasets 2.21.0
-- Tokenizers 0.19.1
+## License
+
+[Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0)
+
+## Citation
+```bash
+@misc{allal2025smollm2smolgoesbig,
+      title={SmolLM2: When Smol Goes Big -- Data-Centric Training of a Small Language Model}, 
+      author={Loubna Ben Allal and Anton Lozhkov and Elie Bakouch and Gabriel Martín Blázquez and Guilherme Penedo and Lewis Tunstall and Andrés Marafioti and Hynek Kydlíček and Agustín Piqueres Lajarín and Vaibhav Srivastav and Joshua Lochner and Caleb Fahlgren and Xuan-Son Nguyen and Clémentine Fourrier and Ben Burtenshaw and Hugo Larcher and Haojun Zhao and Cyril Zakka and Mathieu Morlon and Colin Raffel and Leandro von Werra and Thomas Wolf},
+      year={2025},
+      eprint={2502.02737},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL},
+      url={https://arxiv.org/abs/2502.02737}, 
+}
+```