Upload 5 files
Browse files- .gitattributes +1 -0
- README.md +168 -3
- USAGE_POLICY +1 -0
- special_tokens_map.json +5 -0
- tokenizer.json +3 -0
- tokenizer_config.json +183 -0
.gitattributes
CHANGED
@@ -33,3 +33,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
|
|
33 |
*.zip filter=lfs diff=lfs merge=lfs -text
|
34 |
*.zst filter=lfs diff=lfs merge=lfs -text
|
35 |
*tfevents* filter=lfs diff=lfs merge=lfs -text
|
|
|
|
33 |
*.zip filter=lfs diff=lfs merge=lfs -text
|
34 |
*.zst filter=lfs diff=lfs merge=lfs -text
|
35 |
*tfevents* filter=lfs diff=lfs merge=lfs -text
|
36 |
+
tokenizer.json filter=lfs diff=lfs merge=lfs -text
|
README.md
CHANGED
@@ -1,3 +1,168 @@
|
|
1 |
-
---
|
2 |
-
license: apache-2.0
|
3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
---
|
2 |
+
license: apache-2.0
|
3 |
+
pipeline_tag: text-generation
|
4 |
+
library_name: transformers
|
5 |
+
tags:
|
6 |
+
- vllm
|
7 |
+
---
|
8 |
+
|
9 |
+
<p align="center">
|
10 |
+
<img alt="gpt-oss-20b" src="https://raw.githubusercontent.com/openai/gpt-oss/main/docs/gpt-oss-20b.svg">
|
11 |
+
</p>
|
12 |
+
|
13 |
+
<p align="center">
|
14 |
+
<a href="https://gpt-oss.com"><strong>Try gpt-oss</strong></a> ·
|
15 |
+
<a href="https://cookbook.openai.com/topic/gpt-oss"><strong>Guides</strong></a> ·
|
16 |
+
<a href="https://openai.com/index/gpt-oss-model-card"><strong>Model card</strong></a> ·
|
17 |
+
<a href="https://openai.com/index/introducing-gpt-oss/"><strong>OpenAI blog</strong></a>
|
18 |
+
</p>
|
19 |
+
|
20 |
+
<br>
|
21 |
+
|
22 |
+
Welcome to the gpt-oss series, [OpenAI’s open-weight models](https://openai.com/open-models) designed for powerful reasoning, agentic tasks, and versatile developer use cases.
|
23 |
+
|
24 |
+
We’re releasing two flavors of these open models:
|
25 |
+
- `gpt-oss-120b` — for production, general purpose, high reasoning use cases that fit into a single H100 GPU (117B parameters with 5.1B active parameters)
|
26 |
+
- `gpt-oss-20b` — for lower latency, and local or specialized use cases (21B parameters with 3.6B active parameters)
|
27 |
+
|
28 |
+
Both models were trained on our [harmony response format](https://github.com/openai/harmony) and should only be used with the harmony format as it will not work correctly otherwise.
|
29 |
+
|
30 |
+
|
31 |
+
> [!NOTE]
|
32 |
+
> This model card is dedicated to the smaller `gpt-oss-20b` model. Check out [`gpt-oss-120b`](https://huggingface.co/openai/gpt-oss-120b) for the larger model.
|
33 |
+
|
34 |
+
# Highlights
|
35 |
+
|
36 |
+
* **Permissive Apache 2.0 license:** Build freely without copyleft restrictions or patent risk—ideal for experimentation, customization, and commercial deployment.
|
37 |
+
* **Configurable reasoning effort:** Easily adjust the reasoning effort (low, medium, high) based on your specific use case and latency needs.
|
38 |
+
* **Full chain-of-thought:** Gain complete access to the model’s reasoning process, facilitating easier debugging and increased trust in outputs. It’s not intended to be shown to end users.
|
39 |
+
* **Fine-tunable:** Fully customize models to your specific use case through parameter fine-tuning.
|
40 |
+
* **Agentic capabilities:** Use the models’ native capabilities for function calling, [web browsing](https://github.com/openai/gpt-oss/tree/main?tab=readme-ov-file#browser), [Python code execution](https://github.com/openai/gpt-oss/tree/main?tab=readme-ov-file#python), and Structured Outputs.
|
41 |
+
* **Native MXFP4 quantization:** The models are trained with native MXFP4 precision for the MoE layer, making `gpt-oss-120b` run on a single H100 GPU and the `gpt-oss-20b` model run within 16GB of memory.
|
42 |
+
|
43 |
+
---
|
44 |
+
|
45 |
+
# Inference examples
|
46 |
+
|
47 |
+
## Transformers
|
48 |
+
|
49 |
+
You can use `gpt-oss-120b` and `gpt-oss-20b` with Transformers. If you use the Transformers chat template, it will automatically apply the [harmony response format](https://github.com/openai/harmony). If you use `model.generate` directly, you need to apply the harmony format manually using the chat template or use our [openai-harmony](https://github.com/openai/harmony) package.
|
50 |
+
|
51 |
+
To get started, install the necessary dependencies to setup your environment:
|
52 |
+
|
53 |
+
```
|
54 |
+
pip install -U transformers kernels torch
|
55 |
+
```
|
56 |
+
|
57 |
+
Once, setup you can proceed to run the model by running the snippet below:
|
58 |
+
|
59 |
+
```py
|
60 |
+
from transformers import pipeline
|
61 |
+
import torch
|
62 |
+
|
63 |
+
model_id = "openai/gpt-oss-20b"
|
64 |
+
|
65 |
+
pipe = pipeline(
|
66 |
+
"text-generation",
|
67 |
+
model=model_id,
|
68 |
+
torch_dtype="auto",
|
69 |
+
device_map="auto",
|
70 |
+
)
|
71 |
+
|
72 |
+
messages = [
|
73 |
+
{"role": "user", "content": "Explain quantum mechanics clearly and concisely."},
|
74 |
+
]
|
75 |
+
|
76 |
+
outputs = pipe(
|
77 |
+
messages,
|
78 |
+
max_new_tokens=256,
|
79 |
+
)
|
80 |
+
print(outputs[0]["generated_text"][-1])
|
81 |
+
```
|
82 |
+
|
83 |
+
Alternatively, you can run the model via [`Transformers Serve`](https://huggingface.co/docs/transformers/main/serving) to spin up a OpenAI-compatible webserver:
|
84 |
+
|
85 |
+
```
|
86 |
+
transformers serve
|
87 |
+
transformers chat localhost:8000 --model-name-or-path openai/gpt-oss-20b
|
88 |
+
```
|
89 |
+
|
90 |
+
[Learn more about how to use gpt-oss with Transformers.](https://cookbook.openai.com/articles/gpt-oss/run-transformers)
|
91 |
+
|
92 |
+
## vLLM
|
93 |
+
|
94 |
+
vLLM recommends using [uv](https://docs.astral.sh/uv/) for Python dependency management. You can use vLLM to spin up an OpenAI-compatible webserver. The following command will automatically download the model and start the server.
|
95 |
+
|
96 |
+
```bash
|
97 |
+
uv pip install --pre vllm==0.10.1+gptoss \
|
98 |
+
--extra-index-url https://wheels.vllm.ai/gpt-oss/ \
|
99 |
+
--extra-index-url https://download.pytorch.org/whl/nightly/cu128 \
|
100 |
+
--index-strategy unsafe-best-match
|
101 |
+
|
102 |
+
vllm serve openai/gpt-oss-20b
|
103 |
+
```
|
104 |
+
|
105 |
+
[Learn more about how to use gpt-oss with vLLM.](https://cookbook.openai.com/articles/gpt-oss/run-vllm)
|
106 |
+
|
107 |
+
## PyTorch / Triton
|
108 |
+
|
109 |
+
To learn about how to use this model with PyTorch and Triton, check out our [reference implementations in the gpt-oss repository](https://github.com/openai/gpt-oss?tab=readme-ov-file#reference-pytorch-implementation).
|
110 |
+
|
111 |
+
## Ollama
|
112 |
+
|
113 |
+
If you are trying to run gpt-oss on consumer hardware, you can use Ollama by running the following commands after [installing Ollama](https://ollama.com/download).
|
114 |
+
|
115 |
+
```bash
|
116 |
+
# gpt-oss-20b
|
117 |
+
ollama pull gpt-oss:20b
|
118 |
+
ollama run gpt-oss:20b
|
119 |
+
```
|
120 |
+
|
121 |
+
[Learn more about how to use gpt-oss with Ollama.](https://cookbook.openai.com/articles/gpt-oss/run-locally-ollama)
|
122 |
+
|
123 |
+
#### LM Studio
|
124 |
+
|
125 |
+
If you are using [LM Studio](https://lmstudio.ai/) you can use the following commands to download.
|
126 |
+
|
127 |
+
```bash
|
128 |
+
# gpt-oss-20b
|
129 |
+
lms get openai/gpt-oss-20b
|
130 |
+
```
|
131 |
+
|
132 |
+
Check out our [awesome list](https://github.com/openai/gpt-oss/blob/main/awesome-gpt-oss.md) for a broader collection of gpt-oss resources and inference partners.
|
133 |
+
|
134 |
+
---
|
135 |
+
|
136 |
+
# Download the model
|
137 |
+
|
138 |
+
You can download the model weights from the [Hugging Face Hub](https://huggingface.co/collections/openai/gpt-oss-68911959590a1634ba11c7a4) directly from Hugging Face CLI:
|
139 |
+
|
140 |
+
```shell
|
141 |
+
# gpt-oss-20b
|
142 |
+
huggingface-cli download openai/gpt-oss-20b --include "original/*" --local-dir gpt-oss-20b/
|
143 |
+
pip install gpt-oss
|
144 |
+
python -m gpt_oss.chat model/
|
145 |
+
```
|
146 |
+
|
147 |
+
# Reasoning levels
|
148 |
+
|
149 |
+
You can adjust the reasoning level that suits your task across three levels:
|
150 |
+
|
151 |
+
* **Low:** Fast responses for general dialogue.
|
152 |
+
* **Medium:** Balanced speed and detail.
|
153 |
+
* **High:** Deep and detailed analysis.
|
154 |
+
|
155 |
+
The reasoning level can be set in the system prompts, e.g., "Reasoning: high".
|
156 |
+
|
157 |
+
# Tool use
|
158 |
+
|
159 |
+
The gpt-oss models are excellent for:
|
160 |
+
* Web browsing (using built-in browsing tools)
|
161 |
+
* Function calling with defined schemas
|
162 |
+
* Agentic operations like browser tasks
|
163 |
+
|
164 |
+
# Fine-tuning
|
165 |
+
|
166 |
+
Both gpt-oss models can be fine-tuned for a variety of specialized use cases.
|
167 |
+
|
168 |
+
This smaller model `gpt-oss-20b` can be fine-tuned on consumer hardware, whereas the larger [`gpt-oss-120b`](https://huggingface.co/openai/gpt-oss-120b) can be fine-tuned on a single H100 node.
|
USAGE_POLICY
ADDED
@@ -0,0 +1 @@
|
|
|
|
|
1 |
+
We aim for our tools to be used safely, responsibly, and democratically, while maximizing your control over how you use them. By using OpenAI gpt-oss-120b, you agree to comply with all applicable law.
|
special_tokens_map.json
ADDED
@@ -0,0 +1,5 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
{
|
2 |
+
"bos_token": "<|startoftext|>",
|
3 |
+
"eos_token": "<|return|>",
|
4 |
+
"pad_token": "<|endoftext|>"
|
5 |
+
}
|
tokenizer.json
ADDED
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
1 |
+
version https://git-lfs.github.com/spec/v1
|
2 |
+
oid sha256:0614fe83cadab421296e664e1f48f4261fa8fef6e03e63bb75c20f38e37d07d3
|
3 |
+
size 27868174
|
tokenizer_config.json
ADDED
@@ -0,0 +1,183 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
{
|
2 |
+
"added_tokens_decoder": {
|
3 |
+
"199998": {
|
4 |
+
"content": "<|startoftext|>",
|
5 |
+
"lstrip": false,
|
6 |
+
"normalized": false,
|
7 |
+
"rstrip": false,
|
8 |
+
"single_word": false,
|
9 |
+
"special": true
|
10 |
+
},
|
11 |
+
"199999": {
|
12 |
+
"content": "<|endoftext|>",
|
13 |
+
"lstrip": false,
|
14 |
+
"normalized": false,
|
15 |
+
"rstrip": false,
|
16 |
+
"single_word": false,
|
17 |
+
"special": true
|
18 |
+
},
|
19 |
+
"200000": {
|
20 |
+
"content": "<|reserved_200000|>",
|
21 |
+
"lstrip": false,
|
22 |
+
"normalized": false,
|
23 |
+
"rstrip": false,
|
24 |
+
"single_word": false,
|
25 |
+
"special": true
|
26 |
+
},
|
27 |
+
"200001": {
|
28 |
+
"content": "<|reserved_200001|>",
|
29 |
+
"lstrip": false,
|
30 |
+
"normalized": false,
|
31 |
+
"rstrip": false,
|
32 |
+
"single_word": false,
|
33 |
+
"special": true
|
34 |
+
},
|
35 |
+
"200002": {
|
36 |
+
"content": "<|return|>",
|
37 |
+
"lstrip": false,
|
38 |
+
"normalized": false,
|
39 |
+
"rstrip": false,
|
40 |
+
"single_word": false,
|
41 |
+
"special": true
|
42 |
+
},
|
43 |
+
"200003": {
|
44 |
+
"content": "<|constrain|>",
|
45 |
+
"lstrip": false,
|
46 |
+
"normalized": false,
|
47 |
+
"rstrip": false,
|
48 |
+
"single_word": false,
|
49 |
+
"special": true
|
50 |
+
},
|
51 |
+
"200004": {
|
52 |
+
"content": "<|reserved_200004|>",
|
53 |
+
"lstrip": false,
|
54 |
+
"normalized": false,
|
55 |
+
"rstrip": false,
|
56 |
+
"single_word": false,
|
57 |
+
"special": true
|
58 |
+
},
|
59 |
+
"200005": {
|
60 |
+
"content": "<|channel|>",
|
61 |
+
"lstrip": false,
|
62 |
+
"normalized": false,
|
63 |
+
"rstrip": false,
|
64 |
+
"single_word": false,
|
65 |
+
"special": true
|
66 |
+
},
|
67 |
+
"200006": {
|
68 |
+
"content": "<|start|>",
|
69 |
+
"lstrip": false,
|
70 |
+
"normalized": false,
|
71 |
+
"rstrip": false,
|
72 |
+
"single_word": false,
|
73 |
+
"special": true
|
74 |
+
},
|
75 |
+
"200007": {
|
76 |
+
"content": "<|end|>",
|
77 |
+
"lstrip": false,
|
78 |
+
"normalized": false,
|
79 |
+
"rstrip": false,
|
80 |
+
"single_word": false,
|
81 |
+
"special": true
|
82 |
+
},
|
83 |
+
"200008": {
|
84 |
+
"content": "<|message|>",
|
85 |
+
"lstrip": false,
|
86 |
+
"normalized": false,
|
87 |
+
"rstrip": false,
|
88 |
+
"single_word": false,
|
89 |
+
"special": true
|
90 |
+
},
|
91 |
+
"200009": {
|
92 |
+
"content": "<|reserved_200009|>",
|
93 |
+
"lstrip": false,
|
94 |
+
"normalized": false,
|
95 |
+
"rstrip": false,
|
96 |
+
"single_word": false,
|
97 |
+
"special": true
|
98 |
+
},
|
99 |
+
"200010": {
|
100 |
+
"content": "<|reserved_200010|>",
|
101 |
+
"lstrip": false,
|
102 |
+
"normalized": false,
|
103 |
+
"rstrip": false,
|
104 |
+
"single_word": false,
|
105 |
+
"special": true
|
106 |
+
},
|
107 |
+
"200011": {
|
108 |
+
"content": "<|reserved_200011|>",
|
109 |
+
"lstrip": false,
|
110 |
+
"normalized": false,
|
111 |
+
"rstrip": false,
|
112 |
+
"single_word": false,
|
113 |
+
"special": true
|
114 |
+
},
|
115 |
+
"200012": {
|
116 |
+
"content": "<|call|>",
|
117 |
+
"lstrip": false,
|
118 |
+
"normalized": false,
|
119 |
+
"rstrip": false,
|
120 |
+
"single_word": false,
|
121 |
+
"special": true
|
122 |
+
},
|
123 |
+
"200013": {
|
124 |
+
"content": "<|reserved_200013|>",
|
125 |
+
"lstrip": false,
|
126 |
+
"normalized": false,
|
127 |
+
"rstrip": false,
|
128 |
+
"single_word": false,
|
129 |
+
"special": true
|
130 |
+
},
|
131 |
+
"200014": {
|
132 |
+
"content": "<|reserved_200014|>",
|
133 |
+
"lstrip": false,
|
134 |
+
"normalized": false,
|
135 |
+
"rstrip": false,
|
136 |
+
"single_word": false,
|
137 |
+
"special": true
|
138 |
+
},
|
139 |
+
"200015": {
|
140 |
+
"content": "<|reserved_200015|>",
|
141 |
+
"lstrip": false,
|
142 |
+
"normalized": false,
|
143 |
+
"rstrip": false,
|
144 |
+
"single_word": false,
|
145 |
+
"special": true
|
146 |
+
},
|
147 |
+
"200016": {
|
148 |
+
"content": "<|reserved_200016|>",
|
149 |
+
"lstrip": false,
|
150 |
+
"normalized": false,
|
151 |
+
"rstrip": false,
|
152 |
+
"single_word": false,
|
153 |
+
"special": true
|
154 |
+
},
|
155 |
+
"200017": {
|
156 |
+
"content": "<|reserved_200017|>",
|
157 |
+
"lstrip": false,
|
158 |
+
"normalized": false,
|
159 |
+
"rstrip": false,
|
160 |
+
"single_word": false,
|
161 |
+
"special": true
|
162 |
+
},
|
163 |
+
"200018": {
|
164 |
+
"content": "<|endofprompt|>",
|
165 |
+
"lstrip": false,
|
166 |
+
"normalized": false,
|
167 |
+
"rstrip": false,
|
168 |
+
"single_word": false,
|
169 |
+
"special": true
|
170 |
+
}
|
171 |
+
},
|
172 |
+
"bos_token": "<|startoftext|>",
|
173 |
+
"clean_up_tokenization_spaces": false,
|
174 |
+
"eos_token": "<|return|>",
|
175 |
+
"extra_special_tokens": {},
|
176 |
+
"model_input_names": [
|
177 |
+
"input_ids",
|
178 |
+
"attention_mask"
|
179 |
+
],
|
180 |
+
"model_max_length": 1000000000000000019884624838656,
|
181 |
+
"pad_token": "<|endoftext|>",
|
182 |
+
"tokenizer_class": "PreTrainedTokenizerFast"
|
183 |
+
}
|