generated from asreview/template-extension-new-model
-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve README and add citation information (#2)
- Loading branch information
Showing
1 changed file
with
28 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,19 @@ | ||
# ASReview plugin implementing a multilingual feature extractor | ||
This repo contains a plugin implementing | ||
[`sentence-transformers/distiluse-base-multilingual-cased-v1`](https://huggingface.co/sentence-transformers/distiluse-base-multilingual-cased-v1). | ||
# ASReview multilingual feature extractor | ||
|
||
This special sentence tranformer allows for the usage of records in multiple languages. | ||
This extension to ASReview implements a multilingual feature extractor algorithm. | ||
This algorithm allows for the usage of records in multiple languages. | ||
|
||
## Getting started | ||
The extension implements [`sentence-transformers/distiluse-base-multilingual-cased-v1`](https://huggingface.co/sentence-transformers/distiluse-base-multilingual-cased-v1). | ||
This is a sentence-transformers model and maps sentences to a 512 dimensional dense | ||
vector space and is multilingual. For more information about the feature extraction | ||
method, see | ||
|
||
To install the new feature extractor use: | ||
> Reimers, N., & Gurevych, I. (2019). Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks. ArXiv, abs/1908.10084. https://arxiv.org/abs/1908.10084 | ||
|
||
## Installation | ||
|
||
Install the multilingual feature extractor with: | ||
|
||
```bash | ||
pip install . | ||
|
@@ -18,10 +25,18 @@ or | |
pip install git+https://github.com/asreview/asreview-multilingual-feature-extractor.git | ||
``` | ||
|
||
|
||
## Usage | ||
|
||
The new feature extractor `Multilingual Sentence transformer` is defined in | ||
### ASReview LAB | ||
|
||
ASReview LAB users can select the model in the | ||
[Model Selection](https://asreview.readthedocs.io/en/latest/features/pre_screening.html#select-model) | ||
step of the project setup. Select "Multilingual Sentence Transformer" under | ||
"Feature extraction". | ||
|
||
### Simulation | ||
|
||
The new feature extractor `Multilingual Sentence Transformer` is defined in | ||
[`asreviewcontrib/models/distiluse-base-multilingual.py`](asreviewcontrib/models/distiluse-base-multilingual.py) | ||
and can be used in a simulation. | ||
|
||
|
@@ -37,4 +52,8 @@ asreview simulate benchmark:van_de_Schoot_2017 -e multilingual -m svm | |
|
||
## License | ||
|
||
MIT license | ||
[MIT license](/LICENSE) | ||
|
||
## Contact | ||
|
||
For any questions or remarks, please send an email to [email protected] or open an issue. |