Update README.md

README.md

@@ -10,162 +10,92 @@ tags:
   - pytorch
 ---
 
-# OpenCodeReasoning-14B
+# OpenCode-Nemotron-14B Overview
 
-## Model Overview 
+## Description 
 
-OpenCodeReasoning-14B-Instruct is a large language model (LLM) which is a derivative of [Qwen2.5-14B-Instruct](https://huggingface.co/Qwen/Qwen2.5-14B-Instruct) (AKA the *reference model*). 
+OpenCode-Nemotron-14B is a large language model (LLM) which is a derivative of [Qwen2.5-14B-Instruct](https://huggingface.co/Qwen/Qwen2.5-14B-Instruct) (AKA the *reference model*). 
 It is a reasoning model that is post trained for reasoning while code generation. The model supports a context length of 32K tokens.
 
 This model is ready for commercial use. 
 
-
-## License/Terms of Use
-
+### License/Terms of Use
 GOVERNING TERMS: Your use of this model is governed by the [NVIDIA Internal Scientific Research and Development Model License.](https://www.nvidia.com/en-us/agreements/enterprise-software/nvidia-internal-scientific-research-and-development-model-license/)
 
-**Model Developer:** NVIDIA
-
-**Model Dates:** Trained between February 2025 and March 2025
-
+### Deployment Geography:
+Global<br>
 
-### Use Case:
-This model is intended for developers and researchers building LLMs.  
+### Use Case: <br>
+This model is intended for developers and researchers building LLMs. <br>
 
-## Release Date: 
+### Release Date:  <br>
+Huggingface [04/25/2025] via https://huggingface.co/nvidia/OpenCode-Nemotron-14B/ <br>
 
-2025-04-21
 
 ## References
-
 - [\[2504.01943\] OpenCodeReasoning: Advancing Data Distillation for Competitive Coding](https://arxiv.org/abs/2504.01943)
 
+
 ## Model Architecture
 - Architecture Type: Dense decoder-only Transformer model
-- Network Architecture: Qwen
-
-**This model was developed based on Qwen2.5-14B-Instruct. <br>
-** This model has 14B of model parameters. <br>
-
-## Intended use
-
-OpenCodeReasoning-14B-Instruct is a competitive code generation focused reasoning and chat model intended to be used in English. 
-
-## Input  
-- **Input Type:** Text  
-- **Input Format:** String  
-- **Input Parameters:** One-Dimensional (1D)  
-- **Other Properties Related to Input:** Context length up to 32,768 tokens
-
-## Output  
-- **Output Type:** Text  
-- **Output Format:** String  
-- **Output Parameters:** One-Dimensional (1D)  
-- **Other Properties Related to Output:** Context length up to 32,768 tokens
-
-## Software Integration  
-- **Runtime Engine:** Transformers  
-- **Recommended Hardware Microarchitecture Compatibility:**   
-  - NVIDIA Hopper  
-  - NVIDIA Ampere  
-- **Preferred Operating System(s):** Linux 
-
-## Model Version  
-1.0 (4/21/2025)
-
-## Quick Start and Usage Recommendations:
-
-We recommend setting temperature to `0.6`, and Top P to `0.95` for inference on LiveCodeBench.
+- Network Architecture: Qwen2.5-14B-Instruct 
 
-### Use It with Transformers
-See the snippet below for usage with [Hugging Face Transformers](https://huggingface.co/docs/transformers/main/en/index) library. Please see the example below.
 
-We recommend using the *transformers* package with version 4.48.3.   
-Example:
+## Input
+**Input Type(s):** Text <br>
+**Input Format(s):** String <br>
+**Input Parameters:** One-Dimensional (1D) <br>
+**Other Properties Related to Input:** Context length up to 32,768 tokens <br>
 
-```py
-import torch
-import transformers
 
-model_id = "nvidia/OpenCodeReasoning-14B"
-model_kwargs = {"torch_dtype": torch.bfloat16, "trust_remote_code": True, "device_map": "auto"}
-tokenizer = transformers.AutoTokenizer.from_pretrained(model_id)
-tokenizer.pad_token_id = tokenizer.eos_token_id
+## Output
+**Output Type(s):** Text <br>
+**Output Format:** String <br>
+**Output Parameters:** One-Dimensional (1D) <br>
+**Other Properties Related to Output:** Context length up to 32,768 tokens <br> 
 
-pipeline = transformers.pipeline(
-   "text-generation",
-   model=model_id,
-   tokenizer=tokenizer,
-   max_new_tokens=32768,
-   temperature=0.6,
-   top_p=0.95,
-   **model_kwargs
-)
+Our AI models are designed and/or optimized to run on NVIDIA GPU-accelerated systems. By leveraging NVIDIA’s hardware (e.g. GPU cores) and software frameworks (e.g., CUDA libraries), the model achieves faster training and inference times compared to CPU-only solutions. <br> 
 
-print(pipeline([{"role": "user", "content": "Solve x*(sin(x)+2)=0"}]))
-```
-
-## Training and Evaluation Datasets
-
-## Training Datasets
-
-This model is trained using [OpenCodeReasoning](https://huggingface.co/datasets/nvidia/OpenCodeReasoning) dataset.
-
-**Data Collection for Training Datasets:**
-
-- Hybrid: Automated, Human, Synthetic
-
-**Data Labeling for Training Datasets:**
-
-- Hybrid: Automated, Human, Synthetic
 
-## Evaluation Datasets 
+## Software Integration
+* Runtime Engine: Transformers, vLLM <br>
+* Recommended Hardware Microarchitecture Compatibility: <br>
+  - NVIDIA Ampere
+  - NVIDIA Hopper
+* Preferred/Supported Operating System(s): Linux <br> 
 
-We used the datasets listed in the next section to evaluate Llama-3.1-Nemotron-Ultra-253B-v1. 
 
-Data Collection for Evaluation Datasets:
+## Model Version(s) 
+1.0 (4/25/2025)  <br>
 
-- Hybrid: Human/Synthetic
 
-Data Labeling for Evaluation Datasets:
+## Training Dataset
+The training corpus for OpenCode-Nemotron-14B is [OpenCodeReasoning](https://huggingface.co/datasets/nvidia/OpenCodeReasoning) dataset, which is composed of competitive programming questions and DeepSeek-R1 generated responses.
+* Data Collection Method: Hybrid: Automated, Human, Synthetic <br>
+* Data Labeling Method: Hybrid: Automated, Human, Synthetic <br>
 
-- Hybrid: Human/Synthetic/Automatic
 
+## Evaluation Dataset
+We used the datasets listed in the next section to evaluate OpenCodeReasoning-32B. <br>
+* Data Collection Method: Hybrid: Automated, Human, Synthetic <br>
+* Data Labeling Method: Hybrid: Automated, Human, Synthetic <br>
 
-## Evaluation Results
 
-### LiveCodeBench (20240801-20250201)
+### [LiveCodeBench](https://huggingface.co/datasets/livecodebench/code_generation_lite)
+| Easy  | Medium | Hard | Avg. |
+|:------|:------|:------|:-----|
+| 95.4 | 64.0| 18.0 | 51.3 |
 
-| Models | Pass@1 |
-|:--------------|:------------|
-| R1-Distill-Qwen-14B | 53.1 |
-| OpenCodeReasoning-14B | 59.4 | 
+### [CodeContests](https://huggingface.co/datasets/deepmind/code_contests)
+| Public  | Private | Generated | All |
+|:--------|:--------|:----------|:----|
+|   46.7  |   29.6  |    32.3   | 18.1|
 
-User Prompt Template (without starter code):
 
-````
-"You will be given a question (problem specification) and will generate a correct Python program that matches the specification and passes all tests.
+## Inference
+**Engine:** vLLM <br>
+**Test Hardware** NVIDIA H100-80GB <br>
 
-Question: {prompt}
-
-Read the inputs from stdin solve the problem and write the answer to stdout (do not directly test on the sample inputs). Enclose your code within delimiters as follows. Ensure that when the python program runs, it reads the inputs, runs the algorithm and writes output to STDOUT.
-```python
-# YOUR CODE HERE
-```
-````
-
-User Prompt Template (with starter code):
-
-````
-You will be given a question (problem specification) and will generate a correct Python program that matches the specification and passes all tests.
-
-Question: {prompt}
-
-You will use the following starter code to write the solution to the problem and enclose your code within delimiters.
-```python
-{starter_code}
-```
-````
 
 ## Ethical Considerations: