Update README.md

README.md

@@ -11,7 +11,8 @@ language:
 pipeline_tag: text-generation
 ---
 
-# Model Card for llm.c gpt2_350M trained on 10b fineweb-edu interleaved with OpenHermes 2.5
+# Model Card for llm.c GPT2_350M
+## Instruction Pretraining: Fineweb-edu 10B interleaved with OpenHermes 2.5
 
 <!-- Provide a quick summary of what the model is/does. -->
 
@@ -20,67 +21,23 @@ pipeline_tag: text-generation
 
 ## Model Details
 
-### Model Description
-
-<!-- Provide a longer summary of what this model is. -->
-
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
-## Uses
-
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
-### Direct Use
-
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[More Information Needed]
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
 
 ## How to Get Started with the Model
 
 Use the code below to get started with the model.
 
-[More Information Needed]
+```python
+from transformers import pipeline
+p = pipeline("text-generation", "jrahn/gpt2_350M_edu_hermes")
+
+# instruction following
+p("<|im_start|>user\nTeach me to fish.<|im_end|>\n<|im_start|>assistant\n", max_lenght=128)
+#[{'generated_text': '<|im_start|>user\nTeach me to fish.<|im_end|>\n<|im_start|>assistant\nTo fish, you can start by learning the basics of fishing. First, you need to learn how to catch fish. Fish are a type of fish that are found in the ocean. They are also known as sea fish. They are a type of fish that are found in the ocean. They are a type of fish that are found in the ocean. They are a type of fish that are found in the ocean. They are a type of fish that are found in the ocean'}]
+
+# text completion
+p("In a shocking finding, scientist discovered a herd of unicorns living in a remote, previously unexplored valley, in the Andes Mountains. Even more surprising to the researchers was the fact that the unicorns spoke perfect English. ", max_length=128)
+# [{'generated_text': 'In a shocking finding, scientist discovered a herd of unicorns living in a remote, previously unexplored valley, in the Andes Mountains. Even more surprising to the researchers was the fact that the unicorns spoke perfect English. \nThe researchers believe that the animals were able to communicate with each other by using a unique vocalization system. The researchers believe that the animals were able to communicate with each other by using a unique vocalization system.\nThe researchers believe that the animals were able to communicate with each other by using a unique vocalization system. The researchers believe that the animals were able to communicate with each other by using a unique'}]
+```
 
 ## Training Details
 
@@ -88,13 +45,13 @@ Use the code below to get started with the model.
 
 <!-- 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. -->
 
-Fineweb-Edu 10B + OpenHermes 2.5 (chatml)
+Datasets used: Fineweb-Edu 10B + OpenHermes 2.5 (chatml)
 
-Dataset proportions:
-Part 1: FWE 4,836,050 + OH 100,000 (2.03%) = 4,936,050
-Part 2: FWE 4,336,051 + OH 400,000 (8.45%) = 4,736,051
-Part 3: FWE 500,000 + OH 501,551 (50.08%) = 1,001,551
-Total documents: 10,669,024
+Dataset proportions:  
+- Part 1: FWE 4,836,050 + OH 100,000 (2.03%) = 4,936,050  
+- Part 2: FWE 4,336,051 + OH 400,000 (8.45%) = 4,736,051  
+- Part 3: FWE 500,000 + OH 501,551 (50.08%) = 1,001,551  
+Total documents: 10,669,024  
 
 ### Training Procedure
 
@@ -102,120 +59,52 @@ Total documents: 10,669,024
 
 #### Preprocessing [optional]
 
-[More Information Needed]
+- Fineweb-Edu: none, just the "text" feature  
+- OpenHermes 2.5: applied ChatML prompt template to "conversations" to create the "text" feature
+
 
 
 #### Training Hyperparameters
 
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
+- **Training regime:**
+- bf16
+- per device batch size 16, global batch size 524288, gradient accumulation 16
+- zero stage 1
+- lr 3e-4, cosine schedule, 700 warmup steps
+- more details see [run script](run_gpt2_350M_edu_hermes.sh)
 
 #### Speeds, Sizes, Times [optional]
 
 <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
 
-Params: 355M -> Checkpoint: 700MB
+Params: 355M -> Checkpoint: 710MB  
+Tokens: ~10B  
+Total training time: 30hrs  
+Hardware: 2x RTX4090  
+MFU: 71% (110,000 tok/s)  
 
-Tokens: ~10B
-Total training time: 30hrs
-Hardware: 2x RTX4090
-MFU: 71%
-
-[More Information Needed]
 
 ## Evaluation
 
 <!-- This section describes the evaluation protocols and provides the results. -->
 
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
 ### Results
 
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-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).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
+HellaSwag: 34.4  
+- more details see [main.log](main.log)
 
 ## Technical Specifications [optional]
 
 ### Model Architecture and Objective
 
-[More Information Needed]
+GTP2 350M, Causal Language Modeling
 
 ### Compute Infrastructure
 
-[More Information Needed]
-
 #### Hardware
 
-[More Information Needed]
+2x RTX4090
 
 #### Software
 
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
-
-## Model Card Contact
-
-[More Information Needed]
+[llm.c](https://github.com/karpathy/llm.c)