gpt-oss README

The project's README from github.com/openai/gpt-oss. As one markdown file: README.md.

gpt-oss-120

Try gpt-oss · Guides · Model card · OpenAI blog

Download gpt-oss-120b and gpt-oss-20b on Hugging Face


Welcome to the gpt-oss series, OpenAI's open-weight models designed for powerful reasoning, agentic tasks, and versatile developer use cases.

We're releasing two flavors of these open models:

Both models were trained using our harmony response format and should only be used with this format; otherwise, they will not work correctly.

Table of Contents

Highlights

Inference examples

Transformers

You can use gpt-oss-120b and gpt-oss-20b with the Transformers library. If you use Transformers' chat template, it will automatically apply the harmony response format. If you use model.generate directly, you need to apply the harmony format manually using the chat template or use our openai-harmony package.

from transformers import pipeline
import torch

model_id = "openai/gpt-oss-120b"

pipe = pipeline(
    "text-generation",
    model=model_id,
    torch_dtype="auto",
    device_map="auto",
)

messages = [
    {"role": "user", "content": "Explain quantum mechanics clearly and concisely."},
]

outputs = pipe(
    messages,
    max_new_tokens=256,
)
print(outputs[0]["generated_text"][-1])

Learn more about how to use gpt-oss with Transformers.

vLLM

vLLM recommends using uv for Python dependency management. You can use vLLM to spin up an OpenAI-compatible web server. The following command will automatically download the model and start the server.

uv pip install --pre vllm==0.10.1+gptoss \
    --extra-index-url https://wheels.vllm.ai/gpt-oss/ \
    --extra-index-url https://download.pytorch.org/whl/nightly/cu128 \
    --index-strategy unsafe-best-match

vllm serve openai/gpt-oss-20b

Learn more about how to use gpt-oss with vLLM.

Offline Serve Code:

# source .oss/bin/activate

import os
os.environ["VLLM_USE_FLASHINFER_SAMPLER"] = "0"

import json
from openai_harmony import (
    HarmonyEncodingName,
    load_harmony_encoding,
    Conversation,
    Message,
    Role,
    SystemContent,
    DeveloperContent,
)
 
from vllm import LLM, SamplingParams
import os

# --- 1) Render the prefill with Harmony ---
encoding = load_harmony_encoding(HarmonyEncodingName.HARMONY_GPT_OSS)
 
convo = Conversation.from_messages(
    [
        Message.from_role_and_content(Role.SYSTEM, SystemContent.new()),
        Message.from_role_and_content(
            Role.DEVELOPER,
            DeveloperContent.new().with_instructions("Always respond in riddles"),
        ),
        Message.from_role_and_content(Role.USER, "What is the weather like in SF?"),
    ]
)
 
prefill_ids = encoding.render_conversation_for_completion(convo, Role.ASSISTANT)
 
# Harmony stop tokens (pass to sampler so they won't be included in output)
stop_token_ids = encoding.stop_tokens_for_assistant_actions()
 
# --- 2) Run vLLM with prefill ---
llm = LLM(
    model="openai/gpt-oss-20b",
    trust_remote_code=True,
    gpu_memory_utilization = 0.95,
    max_num_batched_tokens=4096,
    max_model_len=5000,
    tensor_parallel_size=1
)
 
sampling = SamplingParams(
    max_tokens=128,
    temperature=1,
    stop_token_ids=stop_token_ids,
)
 
outputs = llm.generate(
    prompt_token_ids=[prefill_ids],   # batch of size 1
    sampling_params=sampling,
)
 
# vLLM gives you both text and token IDs
gen = outputs[0].outputs[0]
text = gen.text
output_tokens = gen.token_ids  # <-- these are the completion token IDs (no prefill)
 
# --- 3) Parse the completion token IDs back into structured Harmony messages ---
entries = encoding.parse_messages_from_completion_tokens(output_tokens, Role.ASSISTANT)
 
# 'entries' is a sequence of structured conversation entries (assistant messages, tool calls, etc.).
for message in entries:
    print(f"{json.dumps(message.to_dict())}")

PyTorch / Triton / Metal

These implementations are largely reference implementations for educational purposes and are not expected to be run in production.

Learn more below.

Ollama

If you are trying to run gpt-oss on consumer hardware, you can use Ollama by running the following commands after installing Ollama.

# gpt-oss-20b
ollama pull gpt-oss:20b
ollama run gpt-oss:20b

# gpt-oss-120b
ollama pull gpt-oss:120b
ollama run gpt-oss:120b

Learn more about how to use gpt-oss with Ollama.

LM Studio

If you are using LM Studio you can use the following commands to download.

# gpt-oss-20b
lms get openai/gpt-oss-20b
# gpt-oss-120b
lms get openai/gpt-oss-120b

Check out our awesome list for a broader collection of gpt-oss resources and inference partners.

About this repository

This repository provides a collection of reference implementations:

Setup

Requirements

Installation

If you want to try any of the code you can install it directly from PyPI

# if you just need the tools
pip install gpt-oss
# if you want to try the torch implementation
pip install gpt-oss[torch]
# if you want to try the triton implementation
pip install gpt-oss[triton]

If you want to modify the code or try the metal implementation set the project up locally:

git clone https://github.com/openai/gpt-oss.git
GPTOSS_BUILD_METAL=1 pip install -e ".[metal]"

Download the model

You can download the model weights from the Hugging Face Hub directly from Hugging Face CLI:

# gpt-oss-120b
hf download openai/gpt-oss-120b --include "original/*" --local-dir gpt-oss-120b/

# gpt-oss-20b
hf download openai/gpt-oss-20b --include "original/*" --local-dir gpt-oss-20b/

Reference PyTorch implementation

We include an inefficient reference PyTorch implementation in gpt_oss/torch/model.py. This code uses basic PyTorch operators to show the exact model architecture, with a small addition of supporting tensor parallelism in MoE so that the larger model can run with this code (e.g., on 4xH100 or 2xH200). In this implementation, we upcast all weights to BF16 and run the model in BF16.

To run the reference implementation, install the dependencies:

pip install -e ".[torch]"

And then run:

# On 4xH100:
torchrun --nproc-per-node=4 -m gpt_oss.generate gpt-oss-120b/original/

Reference Triton implementation (single GPU)

We also include an optimized reference implementation that uses an optimized triton MoE kernel that supports MXFP4. It also has some optimization on the attention code to reduce the memory cost. To run this implementation, the nightly version of triton and torch will be installed. This version can be run on a single 80GB GPU for gpt-oss-120b.

To install the reference Triton implementation run

# You need to install triton from source to use the triton implementation
git clone https://github.com/triton-lang/triton
cd triton/
pip install -r python/requirements.txt
pip install -e . --verbose --no-build-isolation
pip install -e python/triton_kernels

# Install the gpt-oss triton implementation
pip install -e ".[triton]"

And then run:

# On 1xH100
export PYTORCH_CUDA_ALLOC_CONF=expandable_segments:True
python -m gpt_oss.generate --backend triton gpt-oss-120b/original/

If you encounter torch.OutOfMemoryError, make sure to turn on the expandable allocator to avoid crashes when loading weights from the checkpoint.

Reference Metal implementation

Additionally we are providing a reference implementation for Metal to run on Apple Silicon. This implementation is not production-ready but is accurate to the PyTorch implementation.

The implementation will get automatically compiled when running the .[metal] installation on an Apple Silicon device:

GPTOSS_BUILD_METAL=1 pip install -e ".[metal]"

To perform inference you'll need to first convert the SafeTensor weights from Hugging Face into the right format using:

python gpt_oss/metal/scripts/create-local-model.py -s <model_dir> -d <output_file>

Or download the pre-converted weights:

hf download openai/gpt-oss-120b --include "metal/*" --local-dir gpt-oss-120b/metal/
hf download openai/gpt-oss-20b --include "metal/*" --local-dir gpt-oss-20b/metal/

To test it you can run:

python gpt_oss/metal/examples/generate.py gpt-oss-20b/metal/model.bin -p "why did the chicken cross the road?"

Harmony format & tools

Along with the model, we are also releasing a new chat format library harmony to interact with the model. Check this guide for more info about harmony.

We also include two system tools for the model: browsing and python container. Check gpt_oss/tools for the tool implementation.

Clients

Terminal Chat

The terminal chat application is a basic example of how to use the harmony format together with the PyTorch, Triton, and vLLM implementations. It also exposes both the python and browser tool as optional tools that can be used.

usage: python -m gpt_oss.chat [-h] [-r REASONING_EFFORT] [-a] [-b] [--show-browser-results] [-p] [--developer-message DEVELOPER_MESSAGE] [-c CONTEXT] [--raw] [--backend {triton,torch,vllm}] FILE

Chat example

positional arguments:
  FILE                  Path to the SafeTensors checkpoint

options:
  -h, --help            show this help message and exit
  -r REASONING_EFFORT, --reasoning-effort REASONING_EFFORT
                        Reasoning effort (default: low)
  -a, --apply-patch     Make apply_patch tool available to the model (default: False)
  -b, --browser         Use browser tool (default: False)
  --show-browser-results
                        Show browser results (default: False)
  -p, --python          Use python tool (default: False)
  --developer-message DEVELOPER_MESSAGE
                        Developer message (default: )
  -c CONTEXT, --context CONTEXT
                        Max context length (default: 8192)
  --raw                 Raw mode (does not render Harmony encoding) (default: False)
  --backend {triton,torch,vllm}
                        Inference backend (default: triton)

[!NOTE] The torch and triton implementations require original checkpoint under gpt-oss-120b/original/ and gpt-oss-20b/original/ respectively. While vLLM uses the Hugging Face converted checkpoint under gpt-oss-120b/ and gpt-oss-20b/ root directory respectively.

Responses API

We also include an example Responses API server. This server does not implement every feature and event of the Responses API but should be compatible with most of the basic use cases and serve as inspiration for anyone building their own server. Some of our inference partners are also offering their own Responses API.

You can start this server with the following inference backends:

usage: python -m gpt_oss.responses_api.serve [-h] [--checkpoint FILE] [--port PORT] [--inference-backend BACKEND]

Responses API server

options:
  -h, --help                    show this help message and exit
  --checkpoint FILE             Path to the SafeTensors checkpoint
  --port PORT                   Port to run the server on
  --inference-backend BACKEND   Inference backend to use

Codex

We support codex as a client for gpt-oss. To run the 20b version, set this to ~/.codex/config.toml:

disable_response_storage = true
show_reasoning_content = true

[model_providers.local]
name = "local"
base_url = "http://localhost:11434/v1"

[profiles.oss]
model = "gpt-oss:20b"
model_provider = "local"

This will work with any chat completions-API compatible server listening on port 11434, like ollama. Start the server and point codex to the oss model:

ollama run gpt-oss:20b
codex -p oss

Tools

Browser

[!WARNING] This implementation is purely for educational purposes and should not be used in production. You should implement your own equivalent of the YouComBackend or ExaBackend class with your own browsing environment. Currently we have available YouComBackend and ExaBackend.

Both gpt-oss models were trained with the capability to browse using the browser tool that exposes the following three methods:

Usage

To enable the browser tool, you'll have to place the definition into the system message of your harmony formatted prompt. You can either use the with_browser_tool() method if your tool implements the full interface or modify the definition using with_tools(). For example:

import datetime
import os
from gpt_oss.tools.simple_browser import SimpleBrowserTool
from gpt_oss.tools.simple_browser.backend import ExaBackend, YouComBackend
from openai_harmony import SystemContent, Message, Conversation, Role, load_harmony_encoding, HarmonyEncodingName

encoding = load_harmony_encoding(HarmonyEncodingName.HARMONY_GPT_OSS)

# You.com is the default browser backend and requires YDC_API_KEY.
# To use Exa instead, set BROWSER_BACKEND=exa and EXA_API_KEY.
tool_backend = os.getenv("BROWSER_BACKEND", "youcom")
if tool_backend == "youcom":
    backend = YouComBackend(source="web")
elif tool_backend == "exa":
    backend = ExaBackend(source="web")
else:
    raise ValueError(f"Invalid tool backend: {tool_backend}")
browser_tool = SimpleBrowserTool(backend=backend)

# create a basic system prompt
system_message_content = SystemContent.new().with_conversation_start_date(
    datetime.datetime.now().strftime("%Y-%m-%d")
)

# if you want to use the browser tool
if use_browser_tool:
    # enables the tool
    system_message_content = system_message_content.with_tools(browser_tool.tool_config)
    # alternatively you could use the following if your tool is not stateless
    system_message_content = system_message_content.with_browser_tool()

# construct the system message
system_message = Message.from_role_and_content(Role.SYSTEM, system_message_content)

# create the overall prompt
messages = [system_message, Message.from_role_and_content(Role.USER, "What's the weather in SF?")]
conversation = Conversation.from_messages(messages)

# convert to tokens
token_ids = encoding.render_conversation_for_completion(conversation, Role.ASSISTANT)

# perform inference
# ...

# parse the output
messages = encoding.parse_messages_from_completion_tokens(output_tokens, Role.ASSISTANT)
last_message = messages[-1]
if last_message.recipient.startswith("browser"):
  # perform browser call
  response_messages = await browser_tool.process(last_message)

  # extend the current messages and run inference again
  messages.extend(response_messages)

Details

To control the context window size this tool uses a scrollable window of text that the model can interact with. So it might fetch the first 50 lines of a page and then scroll to the next 20 lines after that. The model has also been trained to then use citations from this tool in its answers.

To improve performance the tool caches requests so that the model can revisit a different part of a page without having to reload the page. For that reason you should create a new browser instance for every request.

Python

The model was trained to use a python tool to perform calculations and other actions as part of its chain-of-thought. During the training the model used a stateful tool which makes running tools between CoT loops easier. This reference implementation, however, uses a stateless mode. As a result the PythonTool defines its own tool description to override the definition in openai-harmony.

[!WARNING] This implementation runs in a permissive Docker container which could be problematic in cases like prompt injections. It's serving as an example and you should consider implementing your own container restrictions in production.

Usage

To enable the python tool, you'll have to place the definition into the system message of your harmony formatted prompt. You can either use the with_python() method if your tool implements the full interface or modify the definition using with_tools(). For example:

import datetime
from gpt_oss.tools.python_docker.docker_tool import PythonTool
from openai_harmony import SystemContent, Message, Conversation, Role, load_harmony_encoding, HarmonyEncodingName

encoding = load_harmony_encoding(HarmonyEncodingName.HARMONY_GPT_OSS)

python_tool = PythonTool()

# create a basic system prompt
system_message_content = SystemContent.new().with_conversation_start_date(
    datetime.datetime.now().strftime("%Y-%m-%d")
)

# if you want to use the python tool
if use_python_tool:
    # enables the tool making sure that the prompt gets set with the stateless tool description
    system_message_content = system_message_content.with_tools(python_tool.tool_config)
    # alternatively you could use the following if your tool is not stateless
    system_message_content = system_message_content.with_python()

# construct the system message
system_message = Message.from_role_and_content(Role.SYSTEM, system_message_content)

# create the overall prompt
messages = [system_message, Message.from_role_and_content(Role.USER, "What's the square root of 9001?")]
conversation = Conversation.from_messages(messages)

# convert to tokens
token_ids = encoding.render_conversation_for_completion(conversation, Role.ASSISTANT)

# perform inference
# ...

# parse the output
messages = encoding.parse_messages_from_completion_tokens(output_tokens, Role.ASSISTANT)
last_message = messages[-1]
if last_message.recipient == "python":
  # perform python call
  response_messages = await python_tool.process(last_message)

  # extend the current messages and run inference again
  messages.extend(response_messages)

Apply Patch

apply_patch can be used to create, update or delete files locally.

Other details

Precision format

We released the models with native quantization support. Specifically, we use MXFP4 for the linear projection weights in the MoE layer. We store the MoE tensor in two parts:

All other tensors will be in BF16. We also recommend using BF16 as the activation precision for the model.

We recommend sampling with temperature=1.0 and top_p=1.0.

Contributing

The reference implementations in this repository are meant as a starting point and inspiration. Outside of bug fixes we do not intend to accept new feature contributions. If you build implementations based on this code such as new tool implementations you are welcome to contribute them to the awesome-gpt-oss.md file.

Citation

@misc{openai2025gptoss120bgptoss20bmodel,
      title={gpt-oss-120b & gpt-oss-20b Model Card}, 
      author={OpenAI},
      year={2025},
      eprint={2508.10925},
      archivePrefix={arXiv},
      primaryClass={cs.CL},
      url={https://arxiv.org/abs/2508.10925}, 
}

gpt-oss (openai/gpt-oss)

Searching Database…

20.5K ·GitHub
这是什么?gpt-oss 系列:OpenAI 推出的两个开放权重语言模型——gpt-oss-120b 和 gpt-oss-20b——专为强大的推理能力、智能体任务以及多样的开发者使用场景而构建。这个仓库本身则提供了围绕这些模型的参考实现、工具和示例客户端。
模型本身在这个仓库里,还是只有运行它们的代码?权重存放在 Hugging Face Hub 上——这个仓库是围绕它们的代码:PyTorch、Triton 和 Metal 的参考实现、harmony 聊天格式库、参考智能体工具,以及示例客户端(一个终端聊天程序和一个示例 Responses API 服务器)。
我该怎么运行其中一个模型?在消费级硬件上,最简单的方式是 Ollama 或 LM Studio。如果要部署服务,vLLM 可以启动一个兼容 OpenAI 的 Web 服务器,并自动下载模型;仓库自带的参考代码则通过 PyPI 安装,权重用 Hugging Face CLI 拉取。
如果我想运行这个仓库里的参考代码,需要什么?基础要求是 Python 3.12;macOS 还需要安装 Xcode 命令行工具(xcode-select --install),Linux 的参考实现则需要 CUDA。
基于这些模型开发之前,有什么坑要注意吗?提示词必须使用 harmony 响应格式——用其他格式模型将无法正常工作,不过 Transformers 的聊天模板会自动套用它。参考代码在 Windows 上未经测试(README 建议Windows 用户改用 Ollama),而纯 PyTorch 实现仅用于教学目的,按原样运行需要 4 张 H100。
拿到权重之后,是一切都在我自己的电脑上运行,还是要调用 OpenAI?推理完全在本地进行:推荐的运行环境——Ollama、LM Studio、vLLM、Transformers——都是在你自己的硬件上执行权重,这正是 20b 模型主打的本地使用定位。
这些模型可以商用吗?可以——采用 Apache 2.0 许可证,选择它的目的就是宽松:没有 copyleft 限制或专利风险,并且明确将商业部署列为预期使用场景。
我自己的电脑带得动吗,还是需要数据中心的 GPU?20b 模型在 16GB 内存内就能运行,普通电脑通过 Ollama 或 LM Studio 就能跑起来。120b 是生产级的,需要一块 80GB 显存的 GPU(NVIDIA H100 或 AMD MI300X)——正是 MXFP4 量化让它能塞得下。
在智能体方面,这些模型能做什么?函数调用、网页浏览、Python 代码执行和结构化输出(Structured Outputs)都是原生能力。推理力度可以配置(low、medium、high),完整的思维链也会暴露出来供调试——但它并不是给最终用户看的。
这个仓库为此提供了哪些工具?包括浏览器工具的参考实现(search、open、find——带请求缓存和训练过的引用行为)、在宽松配置的 Docker 容器中运行的无状态 Python 工具,以及用于本地文件编辑的 applypatch。
我能微调它们吗?有推荐的采样参数吗?两个模型都可以针对你的使用场景充分微调。权重的 MoE 层以 MXFP4 量化提供,其余部分为 BF16,OpenAI 建议采样时使用 temperature 1.0 和 topp 1.0。
What are similar projects?Qwen3.8, Qwen3, airllm, unsloth, NeoHorse, MiniCPM, halo, DeepSeek-V3
Creator
openai
Size
10.6 MB
Stars
20.5K
Age
1y
Commits · 90 Days