Update README.md

README.md

@@ -5,7 +5,7 @@ tags: []
 
 # Model Card for Model ID
 
-<!-- Provide a quick summary of what the model is/does. -->
+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.
 
 
 
@@ -13,10 +13,6 @@ tags: []
 
 ### 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]
@@ -27,8 +23,6 @@ This is the model card of a 🤗 transformers model that has been pushed on the
 
 ### Model Sources [optional]
 
-<!-- Provide the basic links for the model. -->
-
 - **Repository:** [More Information Needed]
 - **Paper [optional]:** [More Information Needed]
 - **Demo [optional]:** [More Information Needed]
@@ -37,23 +31,41 @@ This is the model card of a 🤗 transformers model that has been pushed on the
 
 <!-- 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]
+The model can be loaded with HuggingFace's Transformers library:
+``` python
+import transformers
+import torch
+
+model_id = "duke-nlp/Porb-Gen-8B"
+
+model = AutoModelForCausalLM.from_pretrained(
+	model_id,
+	device_map="auto",
+	torch_dtype=torch.bfloat16
+)
+
+tokenizer = AutoTokenizer.from_pretrained(
+	model_id, 
+	use_fast=False,
+	legacy=False
+)
+
+model_input = tokenizer(
+	"""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>""", 
+	return_tensors="pt",
+).to("cuda")
+
+model_output = model.generate(
+	model_input['input_ids'], 
+	max_new_tokens=256, 
+	do_sample=True,
+	...
+)
+
+tokenizer.batch_decode(model_output)
+```
 
 ## Bias, Risks, and Limitations
 
@@ -67,76 +79,109 @@ This is the model card of a 🤗 transformers model that has been pushed on the
 
 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]
-
 ## Training Details
 
 ### Training Data
 
 <!-- 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. -->
 
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### 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 -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[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]
+The model is finetuned on 3,644 GPT-4 generated 8th-grade problems, which are also annotated and evaluated by humans, an example of our data point is shown below: 
+``` json
+"options": [
+	{
+		"optionText": "Multiply 500 by 3/5 to get 300 tons.",
+		"correct": true
+	},
+	{
+		"optionText": "Divide 500 by 3 to get 166.67 tons.",
+		"correct": false
+	}
+],
+"problemContext": "Environmental issues",
+"evaluated_problem": "A town's recycling plant recycles plastic and glass in a ratio of 3:2. If the plant processes 500 tons of recyclables, how much of it is plastic?", 
+"unitTitle": "Solving Multi-Step Problems with Proportional Relationships"
+```
+
+### Prompting
+The model is trained by 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:
+```
+"Video Games",
+"Fashion",
+"Influencers/YouTubers",
+"Apps and Technology",
+"Movies/TV shows",
+"Sports",
+"Music and Concerts",
+"Social Media",
+"Environmental issues"
+```
+And the tested knowledge shown in the dataset are:
+```
+"Operations with Rational Numbers",
+"Expressions and Equations",
+"Surface Area and Volume",
+"Arithmetic in Base Ten",
+"Evaluating Numeric Expressions",
+"Properties and Theorems of Angles",
+"Data Sets",
+"Rational Number Arithmetic",
+"Functions and Volume",
+"Linear Equations and Linear Systems",
+"Representing Data and Distributions",
+"Algebraic Expressions",
+"Ratios and Rates",
+"Solving Equations and Systems of Equations",
+"Operations with Integers",
+"Scatter Plots",
+"Solving Percentage Problems with Proportional Relationships",
+"Associations in Data",
+"Expressions, Equations, and Inequalities",
+"Linear Relationships",
+"Representing Data",
+"Solving Multi-Step Problems with Proportional Relationships",
+"Dividing Fractions",
+"Area, Surface Area, and Volume",
+"Equivalent Algebraic Expressions",
+"Key Features of Linear Equations",
+"Proportional Relationships and Percentages",
+"Transformations",
+"Representing Proportional Relationships"
+```
 
 ### Results
 
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
+Here is an example passage from the training data:
+```
+Please generate a math problem and options for 8th graders with the following requirements:
+Problem context: Movies/TV shows
+Tested knowledge: Representing Data and Distributions
+Question: Lucas counted the number of episodes in 12 seasons of a TV show. He recorded: 48, 51, 52, 55, 56, 58, 59, 60, 61, 62, 65, 67. How should he create a frequency table for the number of episodes?
+Option 1: Group the data into intervals of 10, then count the number of seasons in each interval.
+Is correct: False
+Option 2: Group the data into intervals of 5 starting from 45, then count the number of seasons in each interval.
+Is correct: True
+```
+And here is an example passage generated from the fine-tuned model:
+```
+Please generate a math problem and 2 to 4 options for 8th graders with the following requirements:
+Problem context: Video Games
+Tested knowledge: Expressions and Equations
+Question: In a video game, the power of a character's weapon is calculated by the formula \(a^b\). If the weapon's power is \(2^{4}\), what is the value of \(a\) and \(b\)?
+Option 1: \(a = 2\) and \(b = 4\)
+Is correct: True
+Option 2: \(a = 4\) and \(b = 2\)
+Is correct: False
+Option 3: \(a = 2\) and \(b = 2\)
+Is correct: False
+Option 4: \(a = 2\) and \(b = 8\)
+Is correct: False
+```
 
 ## Environmental Impact