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 許可證。