Instructions to use Kleva-ai/ItaLegalEmb_v2 with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- sentence-transformers
How to use Kleva-ai/ItaLegalEmb_v2 with sentence-transformers:
from sentence_transformers import SentenceTransformer model = SentenceTransformer("Kleva-ai/ItaLegalEmb_v2") sentences = [ "That is a happy person", "That is a happy dog", "That is a very happy person", "Today is a sunny day" ] embeddings = model.encode(sentences) similarities = model.similarity(embeddings, embeddings) print(similarities.shape) # [4, 4] - llama-cpp-python
How to use Kleva-ai/ItaLegalEmb_v2 with llama-cpp-python:
# !pip install llama-cpp-python from llama_cpp import Llama llm = Llama.from_pretrained( repo_id="Kleva-ai/ItaLegalEmb_v2", filename="ItaLegalEmb_v2.gguf", )
output = llm( "Once upon a time,", max_tokens=512, echo=True ) print(output)
- Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- llama.cpp
How to use Kleva-ai/ItaLegalEmb_v2 with llama.cpp:
Install (macOS, Linux)
curl -LsSf https://llama.app/install.sh | sh # Start a local OpenAI-compatible server with a web UI: llama serve -hf Kleva-ai/ItaLegalEmb_v2 # Run inference directly in the terminal: llama cli -hf Kleva-ai/ItaLegalEmb_v2
Install from WinGet (Windows)
winget install llama.cpp # Start a local OpenAI-compatible server with a web UI: llama serve -hf Kleva-ai/ItaLegalEmb_v2 # Run inference directly in the terminal: llama cli -hf Kleva-ai/ItaLegalEmb_v2
Use pre-built binary
# Download pre-built binary from: # https://github.com/ggerganov/llama.cpp/releases # Start a local OpenAI-compatible server with a web UI: ./llama-server -hf Kleva-ai/ItaLegalEmb_v2 # Run inference directly in the terminal: ./llama-cli -hf Kleva-ai/ItaLegalEmb_v2
Build from source code
git clone https://github.com/ggerganov/llama.cpp.git cd llama.cpp cmake -B build cmake --build build -j --target llama-server llama-cli # Start a local OpenAI-compatible server with a web UI: ./build/bin/llama-server -hf Kleva-ai/ItaLegalEmb_v2 # Run inference directly in the terminal: ./build/bin/llama-cli -hf Kleva-ai/ItaLegalEmb_v2
Use Docker
docker model run hf.co/Kleva-ai/ItaLegalEmb_v2
- LM Studio
- Jan
- Ollama
How to use Kleva-ai/ItaLegalEmb_v2 with Ollama:
ollama run hf.co/Kleva-ai/ItaLegalEmb_v2
- Unsloth Studio
How to use Kleva-ai/ItaLegalEmb_v2 with Unsloth Studio:
Install Unsloth Studio (macOS, Linux, WSL)
curl -fsSL https://unsloth.ai/install.sh | sh # Run unsloth studio unsloth studio -H 0.0.0.0 -p 8888 # Then open http://localhost:8888 in your browser # Search for Kleva-ai/ItaLegalEmb_v2 to start chatting
Install Unsloth Studio (Windows)
irm https://unsloth.ai/install.ps1 | iex # Run unsloth studio unsloth studio -H 0.0.0.0 -p 8888 # Then open http://localhost:8888 in your browser # Search for Kleva-ai/ItaLegalEmb_v2 to start chatting
Using HuggingFace Spaces for Unsloth
# No setup required # Open https://huggingface.co/spaces/unsloth/studio in your browser # Search for Kleva-ai/ItaLegalEmb_v2 to start chatting
- Atomic Chat new
- Docker Model Runner
How to use Kleva-ai/ItaLegalEmb_v2 with Docker Model Runner:
docker model run hf.co/Kleva-ai/ItaLegalEmb_v2
- Lemonade
How to use Kleva-ai/ItaLegalEmb_v2 with Lemonade:
Pull the model
# Download Lemonade from https://lemonade-server.ai/ lemonade pull Kleva-ai/ItaLegalEmb_v2
Run and chat with the model
lemonade run user.ItaLegalEmb_v2-{{QUANT_TAG}}List all available models
lemonade list
ItaLegalEmb_v2 ๐ฎ๐น
ItaLegalEmb_v2 is the second version of the ItaLegalEmb family embedding models. As his predecessor, it is a specialized embedding model specifically trained on a corpus of Italian legal documents.
ItalegalEmb_v2 is based on BAAI/bge-m3, a SOTA embedding model with outstanding multilingual skills.
Features: Dimensions: 1024 Sequence Lenght: 8192
Please note : any access request made using an organizational email address automatically grants us permission to list your organization as a user of our products and services on our website. If you do not agree with this policy, we ask that you refrain from requesting access to our materials.
Evaluation Results
In our evaluations on the specific domain, ItaLegalEmb_v2 scores 93%, while OpenAI stops at 79% and ItaLegalEmb at 85%.
As llama.cpp team has just released (early August 2024) a version which supports XLMRoberta embedding models (ItaLegalEmb_v2 belongs to this), a gguf Q8 version of the model is also included here ๐.
This is a sentence-transformers model: It can be used for tasks like clustering or semantic search.
Usage (Sentence-Transformers)
Using this model becomes easy when you have sentence-transformers installed:
pip install -U sentence-transformers
Then you can use the model like this:
from sentence_transformers import SentenceTransformer
sentences = ["This is an example sentence", "Each sentence is converted"]
model = SentenceTransformer('{MODEL_NAME}')
embeddings = model.encode(sentences)
print(embeddings)
DataLoader:
torch.utils.data.dataloader.DataLoader of length 190 with parameters:
{'batch_size': 10, 'sampler': 'torch.utils.data.sampler.SequentialSampler', 'batch_sampler': 'torch.utils.data.sampler.BatchSampler'}
Loss:
sentence_transformers.losses.MultipleNegativesRankingLoss.MultipleNegativesRankingLoss with parameters:
{'scale': 20.0, 'similarity_fct': 'cos_sim'}
Parameters of the fit()-Method:
{
"epochs": 3,
"evaluation_steps": 50,
"evaluator": "sentence_transformers.evaluation.InformationRetrievalEvaluator.InformationRetrievalEvaluator",
"max_grad_norm": 1,
"optimizer_class": "<class 'torch.optim.adamw.AdamW'>",
"optimizer_params": {
"lr": 2e-05
},
"scheduler": "WarmupLinear",
"steps_per_epoch": null,
"warmup_steps": 57,
"weight_decay": 0.01
}
Full Model Architecture
SentenceTransformer(
(0): Transformer({'max_seq_length': 8192, 'do_lower_case': False}) with Transformer model: XLMRobertaModel
(1): Pooling({'word_embedding_dimension': 1024, 'pooling_mode_cls_token': True, 'pooling_mode_mean_tokens': False, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False})
(2): Normalize()
)
Citing & Authors
@misc{ItaLegalEmb,
title = {Kleva-ai/ItaLegalEmb_v2: An embedding model fine-tuned on Italian legal documents.},
author = {Obiactum},
year = {2024},
publisher = {Kleva-ai},
journal = {HuggingFace repository},
howpublished = {\url{https://huggingface.co/Kleva-ai/ItaLegalEmb_v2}},
}
- Downloads last month
- -