fabelous-embeddings/README.md

50 lines
1.5 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Fabelous Embedder Mini
This repository contains a custom sentence transformer model named **fabelous-mini-embedder**, trained on 13 different programming languages and English.
## Description
The model was built using the Sentence Transformer library, which provides an easy-to-use interface for working with sentence embeddings, including pre-trained models.
In addition to **fabelous-mini-embedder**, we also have a proprietary model called **fabelous-embedder-base**. They are trained on a vast dataset covering various programming languages, including:
- Python
- Java
- Go
- C++
- TypeScript
## Example Usage
Heres how to use the model to generate sentence embeddings:
```python
from sentence_transformers import SentenceTransformer
model = SentenceTransformer("fabelous-mini-embedder")
instruction = "This is an example sentence"
embeddings = model.encode(instruction)
print(embeddings) # Output: (array of numerical embeddings)
```
The generated embeddings can be used for tasks like semantic search or classification.
## Future Improvements
We are currently working on the second generation of our model, focusing on:
- **Enhanced Multilingual Support:** Adding support for German in addition to English.
- **Expanded Dataset:** Increasing the code dataset significantly to improve model performance and accuracy.
We welcome contributions from the community to help us achieve these goals!
## Installation
To install the required libraries, run:
```bash
pip install sentence-transformers
```