Update README.md
Browse files
README.md
CHANGED
|
@@ -15,6 +15,29 @@ An [adapter](https://adapterhub.ml) for the [`allenai/specter2_base`](https://hu
|
|
| 15 |
|
| 16 |
This adapter was created for usage with the **[adapter-transformers](https://github.com/Adapter-Hub/adapter-transformers)** library.
|
| 17 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 18 |
## Usage
|
| 19 |
|
| 20 |
First, install `adapter-transformers`:
|
|
@@ -33,30 +56,6 @@ model = AutoAdapterModel.from_pretrained("allenai/specter2_base")
|
|
| 33 |
adapter_name = model.load_adapter("allenai/specter2_classification", source="hf", set_active=True)
|
| 34 |
```
|
| 35 |
|
| 36 |
-
## SPECTER 2.0
|
| 37 |
-
|
| 38 |
-
<!-- Provide a quick summary of what the model is/does. -->
|
| 39 |
-
|
| 40 |
-
**Aug 2023 Update:**
|
| 41 |
-
1. The SPECTER 2.0 Base and proximity adapter models have been renamed in Hugging Face based upon usage patterns as follows:
|
| 42 |
-
|
| 43 |
-
|Old Name|New Name|
|
| 44 |
-
|--|--|
|
| 45 |
-
|allenai/specter2|[allenai/specter2_base](https://huggingface.co/allenai/specter2_base)|
|
| 46 |
-
|allenai/specter2_proximity|[allenai/specter2](https://huggingface.co/allenai/specter2)|
|
| 47 |
-
|
| 48 |
-
2. We have a parallel version (termed [aug2023refresh](https://huggingface.co/allenai/specter2_aug2023refresh)) where the base transformer encoder version is pre-trained on a collection of newer papers (published after 2018).
|
| 49 |
-
However, for benchmarking purposes, please continue using the current version.
|
| 50 |
-
|
| 51 |
-
|
| 52 |
-
|
| 53 |
-
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_).
|
| 54 |
-
This is the base model to be used along with the adapters.
|
| 55 |
-
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.
|
| 56 |
-
|
| 57 |
-
**Note:For general embedding purposes, please use [allenai/specter2](https://huggingface.co/allenai/specter2).**
|
| 58 |
-
|
| 59 |
-
**To get the best performance on a downstream task type please load the associated adapter with the base model as in the example below.**
|
| 60 |
|
| 61 |
# Model Details
|
| 62 |
|
|
|
|
| 15 |
|
| 16 |
This adapter was created for usage with the **[adapter-transformers](https://github.com/Adapter-Hub/adapter-transformers)** library.
|
| 17 |
|
| 18 |
+
**Aug 2023 Update:**
|
| 19 |
+
1. **The SPECTER 2.0 Base and proximity adapter models have been renamed in Hugging Face based upon usage patterns as follows:**
|
| 20 |
+
|
| 21 |
+
|Old Name|New Name|
|
| 22 |
+
|--|--|
|
| 23 |
+
|allenai/specter2|[allenai/specter2_base](https://huggingface.co/allenai/specter2_base)|
|
| 24 |
+
|allenai/specter2_proximity|[allenai/specter2](https://huggingface.co/allenai/specter2)|
|
| 25 |
+
|
| 26 |
+
2. **We have a parallel version (termed [aug2023refresh](https://huggingface.co/allenai/specter2_aug2023refresh)) where the base transformer encoder version is pre-trained on a collection of newer papers (published after 2018).
|
| 27 |
+
However, for benchmarking purposes, please continue using the current version.**
|
| 28 |
+
|
| 29 |
+
## SPECTER 2.0
|
| 30 |
+
|
| 31 |
+
<!-- Provide a quick summary of what the model is/does. -->
|
| 32 |
+
|
| 33 |
+
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_).
|
| 34 |
+
This is the base model to be used along with the adapters.
|
| 35 |
+
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.
|
| 36 |
+
|
| 37 |
+
**Note:For general embedding purposes, please use [allenai/specter2](https://huggingface.co/allenai/specter2).**
|
| 38 |
+
|
| 39 |
+
**To get the best performance on a downstream task type please load the associated adapter with the base model as in the example below.**
|
| 40 |
+
|
| 41 |
## Usage
|
| 42 |
|
| 43 |
First, install `adapter-transformers`:
|
|
|
|
| 56 |
adapter_name = model.load_adapter("allenai/specter2_classification", source="hf", set_active=True)
|
| 57 |
```
|
| 58 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 59 |
|
| 60 |
# Model Details
|
| 61 |
|