Update README.md

README.md

@@ -1,202 +1,172 @@
 ---
-base_model: Qwen/Qwen3-0.6B
+base_model: Qwen/Qwen3-1.7B
 library_name: peft
+datasets:
+- Skywork/Skywork-Reward-Preference-80K-v0.2
+- allenai/reward-bench
+language:
+- en
 ---
 
-# Model Card for Model ID
+# Model Card: j1-nano from Haize Labs
 
-<!-- Provide a quick summary of what the model is/does. -->
+`j1-nano` from Haize Labs is a dimunitive (0.6B) but mighty reward model. It is trained on Skywork Reward Preference 80K v0.2 by scaling judge-time compute. Uniquely, `j1-nano` proposes item-level evaluation criteria and reasoning before arriving at a final evaluation score.
 
+`j1-nano` is surprisingly cogent, especially given its small number of parameters. 
 
+`j1-nano` is competitive on RewardBench vis-à-vis **much** larger models including GPT-3.5-turbo-0125, ContextualAI/archangel_sft-dpo_llama30b, allenai/tulu-v2.5-13b-uf-rm, etc.
 
-## Model Details
-
-### Model Description
-
-<!-- Provide a longer summary of what this model is. -->
-
-
-
-- **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]
-
-## 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
+<p>
+<img src=https://cdn-uploads.huggingface.co/production/uploads/64c13ee9e98a5e02c93459ee/fsCrYb_0_k9T2GsmLnrrt.png width="400">
+</p>
 
-<!-- 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]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
+## Model Details
 
-[More Information Needed]
+- Base Model: `j1-nano` is a LoRA [SPCT](https://arxiv.org/abs/2504.02495)-finetune off of `Qwen/Qwen3-0.6B`
+- Github: https://github.com/haizelabs/j1-micro
+- Performance: by far the smallest model to achieve >60% accuracy on RewardBench
+- Development Time: 1 Day
+- Development Resources: 1 A100 80GB GPU
+- Developer: Haize Labs Inc.
+
+## Results
+
+<div>
+
+| Model | RewardBench Score |
+|-------|:-------------:|
+| Tulu-2-70b | 77.20% |
+| Claude-3-Opus-20240229 | 80.10% |
+| GPT-4o-mini-2024-07-18 | 80.10% |
+| Llama-3-70B-Instruct | 77.00% |
+| Qwen3-1.7B | 29.51% |
+| Qwen3-1.7B (Soft Match) | 69.38% |
+| **j1-micro** | **80.70%** |
+
+<em>Table 1: RewardBench scores for `j1-micro` (1.7B). `j1-micro` is competitive with models several orders of magnitude larger.</em>
+
+</div>
+
+<br>
+
+<div>
+
+| Model | RewardBench Score |
+|-------|:-------------:|
+| allenai/tulu-v2.5-13b-uf-rm | 46.1% |
+| ContextualAI/archangel_sft-dpo_llama30b | 56.10% |
+| Qwen/Qwen1.5-4B-Chat | 56.00% |
+| GPT-3.5-turbo-0125 | 65.30% |
+| Qwen3-0.6B | 0% |
+| Qwen3-0.6B (Soft Match) | 0% |
+| **j1-nano** | **62.35%** |
+
+<em>Table 2: RewardBench scores for `j1-nano` (0.6B). To our knowledge, `j1-nano` is by far the smallest model to achieve >60% accuracy on RewardBench.</em>
+
+</div>
+
+## Using j1-nano
+
+First, spin up a local vLLM server:
+
+```bash
+vllm serve Qwen/Qwen3-0.6B --enable-lora --lora-modules j1-nano=[path-to-snapshot]
+```
+
+
+Run the [test script](https://github.com/haizelabs/j1-micro/blob/master/test_j1.py) provided in the repository:
+
+```bash
+python test_j1.py --model-name j1-nano
+```
+
+The test script uses the following prompts:
+
+```python
+judge_system_prompt = """
+    You are an expert XML wrangler. You must respond in the following format, regardless of the input:
+    
+    <specific_criteria>
+    ...
+    </specific_criteria>
+    <analysis>
+    ...
+    </analysis>
+    <scores>
+    \\boxed{{..., ...}}
+    </scores>
+
+    Please only respond in English.
+    """
+
+judge_prompt_template = """
+    You are a skilled little expert at scoring responses. You should evaluate given responses based on the given judging criteria.
+    Given the context of the conversation (the last round is the User's query) and multiple responses from the Assistant, you need to refer to the [General Evaluation Criteria] to score the responses. Based on the general evaluation criteria, state potential other specific criteria to the query, the weights of different criteria, and then provide an overall comprehensive score upon them.
+    Each score is an integer between 1 and 10, with a higher score indicating that the response meets the relevant criteria more closely. For example, a score of 1 means the response does not meet the criteria at all, a score of 6 means the response meets only some parts, and a score of 10 means the response perfectly meets the evaluation criteria.
+    Before scoring, please analyze step by step. Your scoring needs to be as strict as possible.
+
+    #### Evaluation Criteria ####
+    1. Instruction Adherence:
+    - Fully Adhered (9-10 points): The response fully complies with all instructions and requirements of the question.
+    - Partially Adhered (6-8 points): The response meets most of the instructions but has some omissions or misunderstandings.
+    - Basically Adhered (3-5 points): The response meets some instructions, but the main requirements are not fulfilled.
+    - Not Adhered (1-2 points): The response does not meet any instructions.
+    Example: If the question requires three examples and the response provides only one, it falls under "Partially Adhered."
+    2. Usefulness:
+    - Highly Useful (9-10 points): The response provides comprehensive and accurate information, fully addressing the issue.
+    - Useful but Incomplete (6-8 points): The response provides some useful information, but lacks details or accuracy.
+    - Limited Usefulness (3-5 points): The response offers little useful information, with most content being irrelevant or incorrect.
+    - Useless or Incorrect (1-2 points): The response is completely irrelevant or incorrect.
+    Example: If there are factual errors in the response but the overall direction is correct, it falls under "Useful but Incomplete."
+    3. Level of Detail:
+    - Very Detailed (9-10 points): The response includes ample details covering all aspects of the issue.
+    - Detailed but Slightly Lacking (6-8 points): The response is fairly detailed but misses some important details.
+    - Basically Detailed (3-5 points): The response provides some details but is not thorough enough overall.
+    - Not Detailed (1-2 points): The response is very brief and lacks necessary details.
+    Example: If the response provides only a simple conclusion without an explanation, it falls under "Not Detailed."
+    4. Relevance:
+    - Highly Relevant (9-10 points): The response is highly relevant to the question, with information closely aligned with the topic.
+    - Generally Relevant (6-8 points): The response is generally relevant but includes some unnecessary information.
+    - Partially Relevant (3-5 points): The response has a lot of content that deviates from the topic.
+    - Not Relevant (1-2 points): The response is completely irrelevant.
+    Example: If the response strays from the topic but still provides some relevant information, it falls under "Partially Relevant."
+
+    #### Conversation Context ####
+    {conversation_context_query}
+    #### Responses to be Scored ####
+    [The Begin of Response A]
+    {response_a}
+    [The End of Response A]
+    [The Begin of Response B]
+    {response_b}
+    [The End of Response B]
+    #### Output Format Requirements ####
+
+    Output with three lines
+    <specific_criteria>
+    [Other potential criteria specific to the query and the context, and the weights of each criteria.]
+    </specific_criteria>
+    <analysis>
+    [Compare different responses based on given Criteria.]
+    </analysis>
+    <scores>
+    [The overall comprehensive score of all responses in order, separate by comma in the boxed, e.g., \\boxed{{x, x}} if there exists 2 responses.]
+    </scores>
+    """
+```
 
 ## 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]
+```bibtex
+@misc{j1micro2025,
+    title = {j1-micro and j1-nano: Tiny Generalist Reward Models via Inference-Time Rubric Proposal},
+    author = {Haize Labs},
+    url = {https://github.com/haizelabs/j1-micro},
+    month = {May},
+    year = {2025}
+}
+```
 
 ## Model Card Contact
 
-[More Information Needed]
-### Framework versions
-
-- PEFT 0.14.0
+[leonardtang.me](https://leonardtang.me/)