Update README.md
Browse files
README.md
CHANGED
|
@@ -6,17 +6,35 @@ datasets:
|
|
| 6 |
- allenai/scirepeval
|
| 7 |
---
|
| 8 |
|
| 9 |
-
#
|
| 10 |
|
| 11 |
-
|
| 12 |
|
| 13 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 14 |
|
| 15 |
**Dec 2023 Update:**
|
| 16 |
|
| 17 |
Model usage updated to be compatible with latest versions of transformers and adapters (newly released update to adapter-transformers) libraries.
|
| 18 |
|
| 19 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 20 |
## Usage
|
| 21 |
|
| 22 |
First, install `adapters`:
|
|
@@ -35,20 +53,6 @@ model = AutoAdapterModel.from_pretrained("allenai/specter2_aug2023refresh_base")
|
|
| 35 |
adapter_name = model.load_adapter("allenai/specter2_aug2023refresh_classification", source="hf", set_active=True)
|
| 36 |
```
|
| 37 |
|
| 38 |
-
**\*\*\*\*\*\*Update\*\*\*\*\*\***
|
| 39 |
-
|
| 40 |
-
This update introduces a new set of SPECTER 2.0 models with the base transformer encoder pre-trained on an extended citation dataset containing more recent papers.
|
| 41 |
-
For benchmarking purposes please use the existing SPECTER 2.0 [models](https://huggingface.co/allenai/specter2) w/o the **aug2023refresh** suffix.
|
| 42 |
-
|
| 43 |
-
# SPECTER 2.0 (Base)
|
| 44 |
-
SPECTER 2.0 is the successor to [SPECTER](https://huggingface.co/allenai/specter) and is capable of generating task specific embeddings for scientific tasks when paired with [adapters](https://huggingface.co/models?search=allenai/specter-2_).
|
| 45 |
-
This is the base model to be used along with the adapters.
|
| 46 |
-
Given the combination of title and abstract of a scientific paper or a short texual query, the model can be used to generate effective embeddings to be used in downstream applications.
|
| 47 |
-
|
| 48 |
-
**Note:For general embedding purposes, please use [allenai/specter2](https://huggingface.co/allenai/specter2).**
|
| 49 |
-
|
| 50 |
-
**To get the best performance on a downstream task type please load the associated adapter with the base model as in the example below.**
|
| 51 |
-
|
| 52 |
# Model Details
|
| 53 |
|
| 54 |
## Model Description
|
|
|
|
| 6 |
- allenai/scirepeval
|
| 7 |
---
|
| 8 |
|
| 9 |
+
## SPECTER2
|
| 10 |
|
| 11 |
+
<!-- Provide a quick summary of what the model is/does. -->
|
| 12 |
|
| 13 |
+
SPECTER2 is a family of models that succeeds [SPECTER](https://huggingface.co/allenai/specter) and is capable of generating task specific embeddings for scientific tasks when paired with [adapters](https://huggingface.co/models?search=allenai/specter-2_).
|
| 14 |
+
Given the combination of title and abstract of a scientific paper or a short texual query, the model can be used to generate effective embeddings to be used in downstream applications.
|
| 15 |
+
|
| 16 |
+
**Note:For general embedding purposes, please use [allenai/specter2](https://huggingface.co/allenai/specter2).**
|
| 17 |
+
|
| 18 |
+
**To get the best performance on a downstream task type please load the associated adapter () with the base model as in the example below.**
|
| 19 |
|
| 20 |
**Dec 2023 Update:**
|
| 21 |
|
| 22 |
Model usage updated to be compatible with latest versions of transformers and adapters (newly released update to adapter-transformers) libraries.
|
| 23 |
|
| 24 |
|
| 25 |
+
**\*\*\*\*\*\*Update\*\*\*\*\*\***
|
| 26 |
+
|
| 27 |
+
This update introduces a new set of SPECTER 2.0 models with the base transformer encoder pre-trained on an extended citation dataset containing more recent papers.
|
| 28 |
+
For benchmarking purposes please use the existing SPECTER 2.0 models w/o the **aug2023refresh** suffix viz. [allenai/specter2_base](https://huggingface.co/allenai/specter2_base).
|
| 29 |
+
|
| 30 |
+
|
| 31 |
+
# Adapter `allenai/specter2_aug2023refresh_classification` for `allenai/specter2_aug2023refresh_base`
|
| 32 |
+
|
| 33 |
+
An [adapter](https://adapterhub.ml) for the `None` model that was trained on the [allenai/scirepeval](https://huggingface.co/datasets/allenai/scirepeval/) dataset.
|
| 34 |
+
|
| 35 |
+
This adapter was created for usage with the **[adapter-transformers](https://github.com/Adapter-Hub/adapter-transformers)** library.
|
| 36 |
+
|
| 37 |
+
|
| 38 |
## Usage
|
| 39 |
|
| 40 |
First, install `adapters`:
|
|
|
|
| 53 |
adapter_name = model.load_adapter("allenai/specter2_aug2023refresh_classification", source="hf", set_active=True)
|
| 54 |
```
|
| 55 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 56 |
# Model Details
|
| 57 |
|
| 58 |
## Model Description
|