Update README.md
Browse files
README.md
CHANGED
|
@@ -23,42 +23,45 @@ See the paper for full details.
|
|
| 23 |
# Other Links
|
| 24 |
| Binary | Description |
|
| 25 |
|:-------|:------------|
|
| 26 |
-
| [trumancai/Revela-
|
| 27 |
-
| **trumancai/Revela-500M** | *← current repo* |
|
| 28 |
-
| [trumancai/Revela-135M](https://huggingface.co/trumancai/Revela-135M) | 135 M-parameter variant (SmolLM2-135M backbone). |
|
| 29 |
| [trumancai/Revela-code-1b](https://huggingface.co/trumancai/Revela-code-1b) | 1 B-parameter code-retriever. |
|
| 30 |
| [trumancai/Revela-code-500M](https://huggingface.co/trumancai/Revela-code-500M) | 500 M-parameter code-retriever. |
|
| 31 |
-
| [trumancai/Revela-
|
| 32 |
-
| [trumancai/
|
|
|
|
| 33 |
| [trumancai/revela_code_training_corpus](https://huggingface.co/datasets/trumancai/revela_code_training_corpus) | Code training corpus. |
|
|
|
|
|
|
|
| 34 |
|
| 35 |
# Usage
|
| 36 |
-
|
|
|
|
| 37 |
|
| 38 |
```python
|
| 39 |
from mteb.model_meta import ModelMeta
|
| 40 |
from mteb.models.repllama_models import RepLLaMAWrapper, _loader
|
| 41 |
-
import mteb, torch
|
| 42 |
|
| 43 |
-
|
| 44 |
loader=_loader(
|
| 45 |
RepLLaMAWrapper,
|
| 46 |
-
base_model_name_or_path="
|
| 47 |
-
peft_model_name_or_path="trumancai/Revela-
|
| 48 |
device_map="auto",
|
| 49 |
torch_dtype=torch.bfloat16,
|
| 50 |
),
|
| 51 |
-
name="trumancai/Revela-
|
| 52 |
languages=["eng_Latn"],
|
| 53 |
open_source=True,
|
| 54 |
-
revision="
|
| 55 |
release_date="2025-04-13",
|
| 56 |
)
|
| 57 |
-
|
| 58 |
|
| 59 |
-
mteb.MTEB(tasks=["SciFact", "NFCorpus"])
|
|
|
|
| 60 |
```
|
| 61 |
|
|
|
|
| 62 |
# Licence
|
| 63 |
|
| 64 |
# Citation
|
|
|
|
| 23 |
# Other Links
|
| 24 |
| Binary | Description |
|
| 25 |
|:-------|:------------|
|
| 26 |
+
| [trumancai/Revela-code-3b](https://huggingface.co/trumancai/Revela-code-3b) | 3 B-parameter code-retriever. |
|
|
|
|
|
|
|
| 27 |
| [trumancai/Revela-code-1b](https://huggingface.co/trumancai/Revela-code-1b) | 1 B-parameter code-retriever. |
|
| 28 |
| [trumancai/Revela-code-500M](https://huggingface.co/trumancai/Revela-code-500M) | 500 M-parameter code-retriever. |
|
| 29 |
+
| [trumancai/Revela-3b](https://huggingface.co/trumancai/Revela-3b) | 3 B-parameter Wikipedia retriever. |
|
| 30 |
+
| [trumancai/Revela-1b](https://huggingface.co/trumancai/Revela-1b) | 1 B-parameter Wikipedia retriever. |
|
| 31 |
+
| [trumancai/Revela-500M](https://huggingface.co/trumancai/Revela-500M) | 500 M-parameter Wikipedia retriever. |
|
| 32 |
| [trumancai/revela_code_training_corpus](https://huggingface.co/datasets/trumancai/revela_code_training_corpus) | Code training corpus. |
|
| 33 |
+
| [trumancai/revela_training_corpus](https://huggingface.co/datasets/trumancai/revela_training_corpus) | Wikipedia training corpus. |
|
| 34 |
+
|
| 35 |
|
| 36 |
# Usage
|
| 37 |
+
We can evaluate the trained models with customized [mteb](https://github.com/TRUMANCFY/mteb).
|
| 38 |
+
|
| 39 |
|
| 40 |
```python
|
| 41 |
from mteb.model_meta import ModelMeta
|
| 42 |
from mteb.models.repllama_models import RepLLaMAWrapper, _loader
|
|
|
|
| 43 |
|
| 44 |
+
revela_llama_3b = ModelMeta(
|
| 45 |
loader=_loader(
|
| 46 |
RepLLaMAWrapper,
|
| 47 |
+
base_model_name_or_path="meta-llama/Llama-3.2-3B",
|
| 48 |
+
peft_model_name_or_path="trumancai/Revela-3b",
|
| 49 |
device_map="auto",
|
| 50 |
torch_dtype=torch.bfloat16,
|
| 51 |
),
|
| 52 |
+
name="trumancai/Revela-3b",
|
| 53 |
languages=["eng_Latn"],
|
| 54 |
open_source=True,
|
| 55 |
+
revision="2b31c92f23acc46762587ea37cb55032da788561", # base-peft revision
|
| 56 |
release_date="2025-04-13",
|
| 57 |
)
|
| 58 |
+
revela_llama_3b_model = revela_llama_3b.loader()
|
| 59 |
|
| 60 |
+
evaluation = mteb.MTEB(tasks=["SciFact", "NFCorpus"])
|
| 61 |
+
evaluation.run(model=revela_llama_3b_model, output_folder="results/Revela-3b")
|
| 62 |
```
|
| 63 |
|
| 64 |
+
|
| 65 |
# Licence
|
| 66 |
|
| 67 |
# Citation
|