OASIS Code Embedding 1.5B

🚀 Kwaipilot OASIS-1.5B

Kwaipilot OASIS-1.5B 是一款先进的代码嵌入模型，通过独特的方法在代码搜索效率和准确性上树立了新标杆，适用于开发者和研究人员提升代码检索系统。

📢 最新消息

• 🔥 [2025/03/12] 我们最新的代码嵌入模型 OASIS-code-1.5B 现已发布。
• 🔥 [2025/03/12] 我们的预印本现已在 OASIS-arxiv 上公开。

📚 详细文档

模型详情

模型名称：OASIS（Order-Augmented Strategy for Improved Code Search）

简介

OASIS 是 Kwaipilot 开发的一款先进代码嵌入模型。该模型采用了独特的专有方法，包括仓库级程序分析、OASIS 指令数据合成算法和专门的融合损失函数，在代码搜索效率和准确性方面树立了新的标杆。

预期用途

该模型非常适合致力于改进代码检索系统的开发者和研究人员。OASIS 在需要对不同编程环境中的代码片段进行语义理解和检索的场景中表现出色。

训练与性能

OASIS 在通过仓库级分析创建的合成数据集上进行训练，确保对不同编码风格和语言有广泛的理解。它在最新的代码搜索基准测试中展现了先进的性能。

我们的预印本现已在 OASIS-arxiv 上公开。

性能表现

💻 使用示例

基础用法

pip install -U torch
pip install -U transformers

⚠️ 重要提示

使用 torch_dtype=torch.bfloat16 加载模型时，避免使用 torch=2.5.0。为获得最佳性能和稳定性，请使用 PyTorch 2.4.1 或更早版本，或升级到 2.5.1 或更高版本。

import torch
import torch.nn.functional as F
from torch import Tensor
from transformers import AutoModel, AutoTokenizer
def last_token_pool(last_hidden_states: Tensor, attention_mask: Tensor) -> Tensor:
    left_padding = (attention_mask[:, -1].sum() == attention_mask.shape[0])
    if left_padding:
        return last_hidden_states[:, -1]
    else:
        sequence_lengths = attention_mask.sum(dim=1) - 1
        batch_size = last_hidden_states.shape[0]
        return last_hidden_states[torch.arange(batch_size, device=last_hidden_states.device), sequence_lengths]
# Add query prompt
def get_query_prompt(query: str):
    query_description = 'Given a code search query, retrieve relevant code snippet that answer the query'
    prompt = f'Instruct: {query_description}\nQuery: {query}'
    return prompt
query = "How to do quicksort in python?"

code1 = """def bubble_sort(arr):
    n = len(arr)
    for i in range(n):
        swapped = False
        for j in range(1, n - i):
            if arr[j - 1] > arr[j]:
                arr[j - 1], arr[j] = arr[j], arr[j - 1]
                swapped = True
        if not swapped:
            break
    return arr"""
code2 = """def quick_sort(arr):
    if len(arr) <= 1:
        return arr
    else:
        pivot = arr[0]
        less = [x for x in arr[1:] if x <= pivot]
        greater = [x for x in arr[1:] if x > pivot]
        return quick_sort(less) + [pivot] + quick_sort(greater)"""
model = AutoModel.from_pretrained("Kwaipilot/OASIS-code-1.5B", output_hidden_states=True)
tokenizer = AutoTokenizer.from_pretrained("Kwaipilot/OASIS-code-1.5B")

# Tokenize and inference
inputs = tokenizer([get_query_prompt(query), code1, code2], max_length=1024, padding=True, truncation=True, return_tensors='pt')
outputs = model(**inputs)
# Last token pooling
embeddings = last_token_pool(outputs.hidden_states[-1], inputs['attention_mask'])
print(embeddings.shape)
# torch.Size([3, 1536])
embeddings = F.normalize(embeddings, dim=1, p=2)
similarity = embeddings @ embeddings.T
print(similarity[0, 1:])
# tensor([0.6895, 0.8240])

高级用法（Sentence Transformers）

首先安装 Sentence Transformers 库：

pip install -U sentence-transformers

然后你可以加载此模型并进行推理。

from sentence_transformers import SentenceTransformer
# Download from the 🤗 Hub
model = SentenceTransformer("Kwaipilot/OASIS-code-1.5B")#, model_kwargs={"torch_dtype": torch.bfloat16})
query = "How to do quicksort in python?"
code1 = """def bubble_sort(arr):
    n = len(arr)
    for i in range(n):
        swapped = False
        for j in range(1, n - i):
            if arr[j - 1] > arr[j]:
                arr[j - 1], arr[j] = arr[j], arr[j - 1]
                swapped = True
        if not swapped:
            break
    return arr"""
code2 = """def quick_sort(arr):
    if len(arr) <= 1:
        return arr
    else:
        pivot = arr[0]
        less = [x for x in arr[1:] if x <= pivot]
        greater = [x for x in arr[1:] if x > pivot]
        return quick_sort(less) + [pivot] + quick_sort(greater)"""
# Run inference
query_embedding = model.encode([query], prompt_name="query")
code_embeddings = model.encode([code1, code2])
print(code_embeddings.shape)
# (2, 1536)
# Get the similarity scores for the embeddings
print(model.similarity(query_embedding[0], code_embeddings[0]))
print(model.similarity(query_embedding[0], code_embeddings[1]))
# tensor([[0.6895]])
# tensor([[0.8240]])

BibTeX

@misc{kwaipilotoasis,
  title = {Optimized Augmentation Strategy for Improved code Search},
  author = {Kwaipilot team},
  year = {2024},
}

📄 许可证

本项目采用 MIT 许可证。