Auslaw Embed V1.0

🚀 AusLaw Embedding Model v1.0

このモデルは、sentence-transformers をベースとしたものです。文章や段落を384次元の密ベクトル空間にマッピングし、クラスタリングや意味検索などのタスクに使用できます。

このモデルは、Umar Butlerによる Open Australian Legal Corpus 内のHCA判例法を用いて、BAAI/bge-small-en をファインチューニングしたものです。PDF/OCRの判例は使用されていません。

判例は、bge-small-enのトークナイザと semchunk を使って、512未満のコンテキストチャンクに分割されました。

各コンテキストチャンクに対して、mistralai/Mixtral-8x7B-Instruct-v0.1 を用いて法的な質問が生成されました。

トレーニングには129,137個のコンテキスト - 質問ペアが使用され、評価には14,348個のコンテキスト - 質問ペアが使用されました（結果は下の表を参照）。

検証データセットの10%のサブセットを使用して、以下のヒット率のパフォーマンスが達成され、ベースモデルとOpenAIのデフォルトのada埋め込みモデルと比較されています。

🚀 クイックスタート

✨ 主な機能

このモデルは、文章や段落を384次元の密ベクトル空間にマッピングすることで、クラスタリングや意味検索などのタスクに利用できます。

📦 インストール

sentence-transformers をインストールすると、このモデルを簡単に使用できます。

pip install -U sentence-transformers

💻 使用例

基本的な使用法

from sentence_transformers import SentenceTransformer
sentences = ["This is an example sentence", "Each sentence is converted"]

model = SentenceTransformer('adlumal/auslaw-embed-v1.0')
embeddings = model.encode(sentences)
print(embeddings)

📚 ドキュメント

評価結果

モデルは利用可能なデータの10%を用いて評価されました。最終ステップの自動評価結果を以下に示します。

トレーニング

モデルは以下のパラメータでトレーニングされました。

DataLoader: torch.utils.data.dataloader.DataLoader の長さは2583で、以下のパラメータが使用されました。

{'batch_size': 50, 'sampler': 'torch.utils.data.sampler.SequentialSampler', 'batch_sampler': 'torch.utils.data.sampler.BatchSampler'}

Loss: sentence_transformers.losses.MultipleNegativesRankingLoss.MultipleNegativesRankingLoss が使用され、以下のパラメータが設定されました。

{'scale': 20.0, 'similarity_fct': 'cos_sim'}

fit() メソッドのパラメータ:

{
    "epochs": 2,
    "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": 516,
    "weight_decay": 0.01
}

🔧 技術詳細

モデルのアーキテクチャ

SentenceTransformer(
  (0): Transformer({'max_seq_length': 512, 'do_lower_case': True}) with Transformer model: BertModel 
  (1): Pooling({'word_embedding_dimension': 384, 'pooling_mode_cls_token': True, 'pooling_mode_mean_tokens': False, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False})
  (2): Normalize()
)

📄 ライセンス

このモデルは apache-2.0 ライセンスの下で提供されています。

引用と著者

@misc{malec-2024-auslaw-embed-v1,
    author = {Malec, Adrian Lucas},
    year = {2024},
    title = {AusLaw Embedding v1.0},
    publisher = {Hugging Face},
    version = {1.0},
    url = {https://huggingface.co/adlumal/auslaw-embed-v1.0}
}