Skip to content

Commit

Permalink
Updated flag embedding
Browse files Browse the repository at this point in the history
  • Loading branch information
Ak-Gautam committed Jan 29, 2024
1 parent cc89443 commit 4aaea88
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions embedding-extractors/flag_embedding/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Flag Embedding extractor (BGE)

This extracctor uses FlagEmbedding that can map any text to a low-dimensional dense vector which can be used for tasks like retrieval, classification, clustering, or semantic search. It uses [BGE base model](https://huggingface.co/BAAI/bge-base-en) from [HuggingFace](https://huggingface.co/).

Example input:

```text
The quick brown fox jumps over the lazy dog.
```

Example output:

```json
{
"embedding": [
510.3,
240.2,
...
]
}
```

## Usage

Try out the extractor. Write your favorite (foreign) quote.

```bash
cd flag_embedding
indexify extractor extract --text "The quick brown fox jumps over the lazy dog."
```

## Container

* The container is not published yet. *

```bash
docker run -it indexify-extractors/flag_embedding extractor extract --text "The quick brown fox jumps over the lazy dog."
```

0 comments on commit 4aaea88

Please sign in to comment.