Update README.md

README.md

@@ -5,10 +5,9 @@ tags: []
 
 # Model Card for Model ID
 
-The Prob-Gen-8B Large Language Model (LLM) is a fine-tuned model of the [Llama-3-8B from Meta](https://huggingface.co/meta-llama/Meta-Llama-3-8B). The intend of the Prob-Gen-8B LLM is to generate math problems under different contexts and tested knowledge for 8th graders.
-
-
+This model is a fine-tuned based on [Llama-3-8B from Meta](https://huggingface.co/meta-llama/Meta-Llama-3-8B) for 3,644 GPT-4 generated grade school math word problems. The model generates math word problems with multiple choices under given contexts.
 
+<!-- 
 ## Model Details
 
 ### Model Description
@@ -25,7 +24,7 @@ The Prob-Gen-8B Large Language Model (LLM) is a fine-tuned model of the [Llama-3
 
 - **Repository:** [More Information Needed]
 - **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Demo [optional]:** [More Information Needed] -->
 
 ## Uses
 
@@ -67,19 +66,20 @@ model_output = model.generate(
 tokenizer.batch_decode(model_output)
 ```
 
-## Bias, Risks, and Limitations
+<!-- ## Bias, Risks, and Limitations
 
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
-### Recommendations
+<!-- ### Recommendations
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+<!-- 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.
+ --> 
 
-## Training Details
+<!-- ## Training Details -->
 
 ### Training Data
 
@@ -103,13 +103,13 @@ The model is finetuned on 3,644 GPT-4 generated 8th-grade problems, which are al
 ```
 
 ### Prompting
-The model is trained by the following prompt:
+The model can be evaluated by using the following prompt:
 ``` python
 """Please generate a math problem and 2 to 4 options for 8th graders with the following requirements:
 Problem context: <specified-context>
 Tested knowledge: <specified-knowledge>"""
 ```
-Where the contexts shown in the dataset are:
+The contexts used in the dataset are:
 ```
 "Video Games",
 "Fashion",
@@ -121,7 +121,7 @@ Where the contexts shown in the dataset are:
 "Social Media",
 "Environmental issues"
 ```
-And the tested knowledge shown in the dataset are:
+The tested knowledge in the dataset are:
 ```
 "Operations with Rational Numbers",
 "Expressions and Equations",
@@ -154,7 +154,7 @@ And the tested knowledge shown in the dataset are:
 "Representing Proportional Relationships"
 ```
 
-### Results
+### Sample Generation
 
 Here is an example passage from the training data:
 ```
@@ -182,63 +182,3 @@ Is correct: False
 Option 4: \(a = 2\) and \(b = 8\)
 Is correct: False
 ```
-
-## 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]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### 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]