bge-small-en

Fork of https://huggingface.co/BAAI/bge-small-en with ONNX weights to be compatible with Transformers.js. See JavaScript usage.

---

<h1 align="center">FlagEmbedding</h1> <h4 align="center"> <p> <a href=#model-list>Model List</a> | <a href=#usage>Usage</a> | <a href="#evaluation">Evaluation</a> | <a href="#train">Train</a> | <a href="#license">License</a> <p> </h4>

For more details please refer to our GitHub repo: FlagEmbedding.

English | 中文

FlagEmbedding can map any text to a low-dimensional dense vector which can be used for tasks like retrieval, classification, clustering, or semantic search. And it also can be used in vector databases for LLMs.

************* 🌟Updates🌟 *************

• 08/05/2023: Release base-scale and small-scale models, best performance among the models of the same size 🤗
• 08/02/2023: Release bge-large-*(short for BAAI General Embedding) Models, rank 1st on MTEB and C-MTEB benchmark! :tada: :tada:
• 08/01/2023: We release the Chinese Massive Text Embedding Benchmark (C-MTEB), consisting of 31 test dataset.

Model List

bge is short for BAAI general embedding.

Usage

This model can be used with both Python and JavaScript.

Python

Use with FlagEmbedding

pip install -U FlagEmbedding

See FlagEmbedding for more methods to install FlagEmbedding.

from FlagEmbedding import FlagModel
sentences = ["样例数据-1", "样例数据-2"]
model = FlagModel('Supabase/bge-small-en', query_instruction_for_retrieval="为这个句子生成表示以用于检索相关文章：")
embeddings = model.encode(sentences)
print(embeddings)

# for retrieval task, please use encode_queries() which will automatically add the instruction to each query
# corpus in retrieval task can still use encode() or encode_corpus()
queries = ['query_1', 'query_2']
passages = ["样例段落-1", "样例段落-2"]
q_embeddings = model.encode_queries(queries)
p_embeddings = model.encode(passages)
scores = q_embeddings @ p_embeddings.T

The value of argument query_instruction_for_retrieval see Model List.

FlagModel will use all available GPUs when encoding, please set os.environ["CUDA_VISIBLE_DEVICES"] to choose GPU.

Use with sentence-transformers

Using this model also is easy when you have sentence-transformers installed:

pip install -U sentence-transformers

from sentence_transformers import SentenceTransformer
sentences = ["样例数据-1", "样例数据-2"]
model = SentenceTransformer('Supabase/bge-small-en')
embeddings = model.encode(sentences, normalize_embeddings=True)
print(embeddings)

For retrieval task, each query should start with an instruction (instructions see Model List).

from sentence_transformers import SentenceTransformer
queries = ["手机开不了机怎么办？"]
passages = ["样例段落-1", "样例段落-2"]
instruction = "为这个句子生成表示以用于检索相关文章："

model = SentenceTransformer('Supabase/bge-small-en')
q_embeddings = model.encode([instruction+q for q in queries], normalize_embeddings=True)
p_embeddings = model.encode(passages, normalize_embeddings=True)
scores = q_embeddings @ p_embeddings.T

Use with Transformers and PyTorch

With transformers package, you can use the model like this: First, you pass your input through the transformer model, then you select the last hidden state of first token (i.e., [CLS]) as the sentence embedding.

from transformers import AutoTokenizer, AutoModel
import torch
# Sentences we want sentence embeddings for
sentences = ["样例数据-1", "样例数据-2"]

# Load model from HuggingFace Hub
tokenizer = AutoTokenizer.from_pretrained('Supabase/bge-small-en')
model = AutoModel.from_pretrained('Supabase/bge-small-en')

# Tokenize sentences
encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')
# for retrieval task, add an instruction to query
# encoded_input = tokenizer([instruction + q for q in queries], padding=True, truncation=True, return_tensors='pt')

# Compute token embeddings
with torch.no_grad():
    model_output = model(**encoded_input)
    # Perform pooling. In this case, cls pooling.
    sentence_embeddings = model_output[0][:, 0]
# normalize embeddings
sentence_embeddings = torch.nn.functional.normalize(sentence_embeddings, p=2, dim=1)
print("Sentence embeddings:", sentence_embeddings)

JavaScript

This model can be used with JavaScript via Transformers.js.

Use with Deno or Supabase Edge Functions

import { serve } from 'https://deno.land/std@0.168.0/http/server.ts'
import { env, pipeline } from 'https://cdn.jsdelivr.net/npm/@xenova/transformers@2.5.0'
// Configuration for Deno runtime
env.useBrowserCache = false;
env.allowLocalModels = false;
const pipe = await pipeline(
  'feature-extraction',
  'Supabase/bge-small-en',
);
serve(async (req) => {
  // Extract input string from JSON body
  const { input } = await req.json();
  // Generate the embedding from the user input
  const output = await pipe(input, {
    pooling: 'mean',
    normalize: true,
  });
  // Extract the embedding output
  const embedding = Array.from(output.data);
  // Return the embedding
  return new Response(
    JSON.stringify({ embedding }),
    { headers: { 'Content-Type': 'application/json' } }
  );
});

Use within the browser (JavaScript Modules)

<script type="module">
import { pipeline } from 'https://cdn.jsdelivr.net/npm/@xenova/transformers@2.5.0';
const pipe = await pipeline(
  'feature-extraction',
  'Supabase/bge-small-en',
);
// Generate the embedding from text
const output = await pipe('Hello world', {
  pooling: 'mean',
  normalize: true,
});
// Extract the embedding output
const embedding = Array.from(output.data);
console.log(embedding);
</script>

Use within Node.js or a web bundler (Webpack, etc)

import { pipeline } from '@xenova/transformers';
const pipe = await pipeline(
  'feature-extraction',
  'Supabase/bge-small-en',
);
// Generate the embedding from text
const output = await pipe('Hello world', {
  pooling: 'mean',
  normalize: true,
});
// Extract the embedding output
const embedding = Array.from(output.data);
console.log(embedding);

Evaluation

baai-general-embedding models achieve state-of-the-art performance on both MTEB and C-MTEB leaderboard! More details and evaluation tools see our scripts.

• MTEB:

• C-MTEB:
  We create a benchmark C-MTEB for Chinese text embedding which consists of 31 datasets from 6 tasks. Please refer to C_MTEB for a detailed introduction.

Train

This section will introduce the way we used to train the general embedding. The training scripts are in FlagEmbedding, and we provide some examples to do pre-train and fine-tune.

1. RetroMAE Pre-train
We pre-train the model following the method retromae, which shows promising improvement in retrieval task (paper). The pre-training was conducted on 24 A100(40G) GPUs with a batch size of 720. In retromae, the mask ratio of encoder and decoder are 0.3, and 0.5 respectively. We used the AdamW optimizer and the learning rate is 2e-5.

Pre-training data:

• English:
  • Pile
  • wikipedia
  • msmarco
• Chinese:
  • Subset of wudao
  • baidu-baike

2. Finetune
We fine-tune the model using a contrastive objective. The format of input data is a triple(query, positive, negative). Besides the negative in the triple, we also adopt in-batch negatives strategy. We employ the cross-device negatives sharing method to share negatives among different GPUs, which can dramatically increase the number of negatives.

We trained our model on 48 A100(40G) GPUs with a large batch size of 32,768 (so there are 65,535 negatives for each query in a batch). We used the AdamW optimizer and the learning rate is 1e-5. The temperature for contrastive loss is 0.01.

For the version with *-instrcution, we add instruction to the query for retrieval task in the training. For english, the instruction is Represent this sentence for searching relevant passages: ; For chinese, the instruction is 为这个句子生成表示以用于检索相关文章：. In the evaluation, the instruction should be added for sentence to passages retrieval task, not be added for other tasks.

The finetune script is accessible in this repository: FlagEmbedding. You can easily finetune your model with it.

Training data:

• For English, we collect 230M text pairs from wikipedia, cc-net, and so on.

• For chinese, we collect 120M text pairs from wudao, simclue and so on.

The data collection is to be released in the future.

We will continually update the embedding models and training codes, hoping to promote the development of the embedding model community.

License

FlagEmbedding is licensed under MIT License. The released models can be used for commercial purposes free of charge.