Create README.md

README.md

@@ -0,0 +1,116 @@
+---
+license: llama3.3
+datasets:
+- tokyotech-llm/swallow-code
+language:
+- en
+- ja
+base_model:
+- meta-llama/Llama-3.1-8B
+---
+
+# Model Card
+
+<img src="https://huggingface.co/datasets/tokyotech-llm/swallow-math/resolve/main/figures/swallow-code-math-log.png" alt="SwallowCodeMath Icon" width="600">
+
+<img src="https://huggingface.co/datasets/tokyotech-llm/swallow-code/resolve/main/assets/experiments.png" width="800">
+
+## Model Summary
+
+This model is a continual pre-training of Llama-3.1-8B on the SwallowCode ablation and multilingual text datasets.
+The model was trained to evaluate the performance of pylint-filtered Python code from The-Stack-v2 in the SwallowCode ablation experiments.
+
+It was trained on 50 billion tokens using a mix of 16% SwallowCode (Experiment 3) and 84% multilingual text, following the setup described in the SwallowCode paper.
+
+Training was performed using Megatron-LM.
+
+## Use
+
+### Intended Use
+
+This model is intended for text completion in English and Japanese, with a focus on code generation tasks due to its training on pylint-filtered Python code from The-Stack-v2. 
+It is part of the [SwallowCode ablation models](https://huggingface.co/collections/tokyotech-llm/swallowcode-6811c84ff647568547d4e443) (Experiment 3, exp3-linter-filtered) and evaluates the effect of pylint filtering in the SwallowCode pipeline. 
+It is not instruction-tuned and is best suited for research purposes.
+
+### Generation
+
+```python
+# pip install -q transformers
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+model = "tokyotech-llm/<model-name>"
+device = "cuda"  # for GPU usage or "cpu" for CPU usage
+
+tokenizer = AutoTokenizer.from_pretrained(model)
+model = AutoModelForCausalLM.from_pretrained(model).to(device)
+
+inputs = tokenizer.encode("def fibonacci(n):", return_tensors="pt").to(device)
+outputs = model.generate(inputs, max_length=100)
+print(tokenizer.decode(outputs[0]))
+```
+
+## Training
+
+### Model
+- **Architecture**: Llama-3.1
+- **Pretraining tokens**: 50B
+- **Precision**: bfloat16
+- **Sequence length**: 8,192
+- **Tokenizer**: Llama-3 tokenizer
+
+
+### Data
+The training mix consists of:
+
+- 16% Code: pylint filtered Python subset of The-Stack-v2-train-smol-ids (8B tokens), from SwallowCode, Experiment 3.
+- 84% Multilingual Text:
+   - Japanese Wikipedia (0.84B tokens)
+   - Japanese Swallow Corpus v2 (26.1B tokens)
+   - Laboro-ParaCorpus (0.22B tokens)
+   - English Wikipedia (1.1B tokens)
+   - English Cosmopedia (3.7B tokens)
+   - English DCLM (10.0B tokens)
+
+Details are in the paper’s Appendix.
+
+### Hardware
+- GPUs: 64 NVIDIA H100 (94GB)
+- Interconnect: InfiniBand NDR200
+- Supercomputer: TSUBAME, Institute of Science Tokyo
+
+### Software
+- Megatron-LM (version core_r0.9.0) for training
+- lm-evaluation-harness for evaluation
+- BigCodeBench for code evaluation
+
+## Evaluation
+The model was evaluated using the setup described in the SwallowCode paper, with the lm-evaluation-harness and BigCodeBench. Benchmarks include code generation (HumanEval, HumanEval+) and general tasks (OpenBookQA, TriviaQA, HellaSwag, SQuAD 2.0, XWINO, MMLU, GSM8K, BBH). Results are reported for checkpoints at 10B, 20B, 30B, 40B, and 50B tokens.
+
+Evaluation Results (Experiment 3)
+
+### Evaluation Results (Experiment 3)
+
+| Tokens (B) | OpenBookQA | TriviaQA | HellaSwag | SQuAD2.0 | XWINO | MMLU   | GSM8K  | BBH    | HumanEval | HumanEval+ |
+|------------|------------|----------|-----------|----------|-------|--------|--------|--------|-----------|------------|
+| 10         | 0.3560     | 0.6628   | 0.6010    | 0.3340   | 0.9071| 0.6235 | 0.4564 | 0.6007 | 0.3500    | 0.3488     |
+| 20         | 0.3500     | 0.6613   | 0.6015    | 0.3361   | 0.9054| 0.6237 | 0.4860 | 0.5838 | 0.3744    | 0.3787     |
+| 30         | 0.3620     | 0.6596   | 0.6008    | 0.3359   | 0.9080| 0.6307 | 0.4867 | 0.5921 | 0.3957    | 0.3878     |
+| 40         | 0.3720     | 0.6650   | 0.6030    | 0.3352   | 0.9058| 0.6326 | 0.4822 | 0.5990 | 0.3890    | 0.3915     |
+| 50         | 0.3740     | 0.6677   | 0.6054    | 0.3291   | 0.9019| 0.6327 | 0.4996 | 0.6145 | 0.3945    | 0.3902     |
+
+*Source: Table 4 from the SwallowCode paper, showing performance of the syntax-error and Pylint-filtered (score ≥ 7) Python subset.*
+
+
+## Citation
+
+```bibtex
+@misc{fujii2025rewritingpretrainingdata,
+      title={Rewriting Pre-Training Data: Boosting LLM Performance in Math and Code}, 
+      author={Kazuki Fujii and Yukito Tajima and Sakae Mizuki and Hinari Shimada and Taihei Shiotani and Koshiro Saito and Masanari Ohi and Masaki Kawamura and Taishi Nakamura and Takumi Okamoto and Shigeki Ishida and Kakeru Hattori and Youmi Ma and Hiroya Takamura and Rio Yokota and Naoaki Okazaki},
+      year={2025},
+      eprint={XXXX.XXXXX},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL},
+      url={https://arxiv.org/abs/XXXX.XXXXX}, 
+}
+```