aps6992 commited on
Commit
ad56a5e
1 Parent(s): 98ff564

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +24 -19
README.md CHANGED
@@ -6,16 +6,34 @@ datasets:
6
  - allenai/scirepeval
7
  ---
8
 
9
- # Adapter `allenai/specter2_aug2023refresh` for `allenai/specter2_aug2023refresh_base`
10
 
11
- An [adapter](https://adapterhub.ml) for the allenai/specter2_aug2023refresh_base model that was trained on the [allenai/scirepeval](https://huggingface.co/datasets/allenai/scirepeval/) dataset.
12
 
13
- This adapter was created for usage with the **[adapters](https://github.com/adapter-hub/adapters)** library.
 
 
 
 
 
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
  ## Usage
20
 
21
  First, install `adapters`:
@@ -34,20 +52,6 @@ model = AutoAdapterModel.from_pretrained("allenai/specter2_aug2023refresh_base")
34
  adapter_name = model.load_adapter("allenai/specter2_aug2023refresh", source="hf", set_active=True)
35
  ```
36
 
37
- **\*\*\*\*\*\*Update\*\*\*\*\*\***
38
-
39
- This update introduces a new set of SPECTER2 models with the base transformer encoder pre-trained on an extended citation dataset containing more recent papers.
40
- For benchmarking purposes please use the existing SPECTER2 [models](https://huggingface.co/allenai/specter2) w/o the **aug2023refresh** suffix.
41
-
42
- # SPECTER2 (Base)
43
- SPECTER2 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_).
44
- This is the base model to be used along with the adapters.
45
- 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.
46
-
47
- **Note:For general embedding purposes, please use [allenai/specter2](https://huggingface.co/allenai/specter2).**
48
-
49
- **To get the best performance on a downstream task type please load the associated adapter with the base model as in the example below.**
50
-
51
  # Model Details
52
 
53
  ## Model Description
@@ -61,7 +65,8 @@ Task Formats trained on:
61
  - Proximity
62
  - Adhoc Search
63
 
64
-
 
65
  It builds on the work done in [SciRepEval: A Multi-Format Benchmark for Scientific Document Representations](https://api.semanticscholar.org/CorpusID:254018137) and we evaluate the trained model on this benchmark as well.
66
 
67
 
@@ -93,7 +98,7 @@ It builds on the work done in [SciRepEval: A Multi-Format Benchmark for Scientif
93
  |Classification|[allenai/specter2_aug2023refresh_classification](https://huggingface.co/allenai/specter2_aug2023refresh_classification)|Encode papers to feed into linear classifiers as features|
94
  |Regression|[allenai/specter2_aug2023refresh_regression](https://huggingface.co/allenai/specter2_aug2023refresh_regression)|Encode papers to feed into linear regressors as features|
95
 
96
- *Retrieval model should suffice for downstream task types not mentioned above
97
 
98
  ```python
99
  from transformers import AutoTokenizer
 
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
+ **\*\*\*\*\*\*Update\*\*\*\*\*\***
25
+
26
+ This update introduces a new set of SPECTER2 models with the base transformer encoder pre-trained on an extended citation dataset containing more recent papers.
27
+ For benchmarking purposes please use the existing SPECTER2 [models](https://huggingface.co/allenai/specter2) w/o the **aug2023refresh** suffix.
28
+
29
+
30
+ # Adapter `allenai/specter2_aug2023refresh` for `allenai/specter2_aug2023refresh_base`
31
+
32
+ An [adapter](https://adapterhub.ml) for the allenai/specter2_aug2023refresh_base model that was trained on the [allenai/scirepeval](https://huggingface.co/datasets/allenai/scirepeval/) dataset.
33
+
34
+ This adapter was created for usage with the **[adapters](https://github.com/adapter-hub/adapters)** library.
35
+
36
+
37
  ## Usage
38
 
39
  First, install `adapters`:
 
52
  adapter_name = model.load_adapter("allenai/specter2_aug2023refresh", source="hf", set_active=True)
53
  ```
54
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
55
  # Model Details
56
 
57
  ## Model Description
 
65
  - Proximity
66
  - Adhoc Search
67
 
68
+ **This is a retrieval specific adapter. For tasks where given a paper query, other relevant papers have to be retrieved from a corpus, use this adapter to generate the embeddings.**
69
+
70
  It builds on the work done in [SciRepEval: A Multi-Format Benchmark for Scientific Document Representations](https://api.semanticscholar.org/CorpusID:254018137) and we evaluate the trained model on this benchmark as well.
71
 
72
 
 
98
  |Classification|[allenai/specter2_aug2023refresh_classification](https://huggingface.co/allenai/specter2_aug2023refresh_classification)|Encode papers to feed into linear classifiers as features|
99
  |Regression|[allenai/specter2_aug2023refresh_regression](https://huggingface.co/allenai/specter2_aug2023refresh_regression)|Encode papers to feed into linear regressors as features|
100
 
101
+ *Proximity model should suffice for downstream task types not mentioned above
102
 
103
  ```python
104
  from transformers import AutoTokenizer