Skip to main content

ASReview New Exciting Models

Project description

ASReview Dory 🐟

PyPI version Python Versions Downloads License DOI

ASReview Dory is an extension to the ASReview software, providing new models for classification and feature extraction. The extension is maintained by the ASReview LAB team.

How to cite
Please cite our Software Impacts paper (preferred) or the Zenodo software archive. See Citing this repository.

Installation

You can install ASReview Dory via PyPI using the following command:

pip install asreview-dory

⚠️ XGBoost on MacOS If you are using macOS and plan to use XGBoost, you should first install OpenMP (brew install libomp)

Model components

Feature Extractors:

Doc2Vec
GTR T5
LaBSE
MPNet
Multilingual E5
MXBAI
XLM RoBERTa

Classifiers:

AdaBoost
Neural Network - 2-Layer
Neural Network - Dynamic
Neural Network - Warm Start
XGBoost

Explore the performance of these models in our Simulation Gallery! Look for the 🐟 icon to spot the Dory models.

Usage

Once installed, the plugins will be available in the front-end of ASReview, as well as being accessible via the command-line interface.

You can check all available models using:

asreview algorithms

Caching Models

You can pre-load models to avoid downloading them during runtime by using the cache command. To cache specific models, such as xgboost and sbert, run:

asreview dory cache nb xgboost sbert

To cache all available models at once, use:

asreview dory cache-all

Exapmles

Documentation for adding your own custom models can be found in the docs folder here.

Examples of custom model integrations can be found in the examples folder here.

Compatibility

This plugin is compatible with ASReview version 2 or later. Ensure that your ASReview installation is up-to-date to avoid compatibility issues.

The development of this plugin is done in parallel with the development of the ASReview software. We aim to maintain compatibility with the latest version of ASReview, but please report any issues you encounter.

Citing this repository

If you use ASReview Dory in academic work, please cite our Software Impacts publication:

van der Kuil, T., Teijema, J. J., de Bruin, J., & van de Schoot, R. ASReview Dory: Bringing new and exciting models to ASReview LAB. Software Impacts, 27, 100809 (2026). https://doi.org/10.1016/j.simpa.2025.100809

If you are specifically citing the software itself (for example, to reference a particular version for reproducibility), please cite the Zenodo archived release: https://doi.org/10.5281/zenodo.15649247. The menu on the right can be used to find the citation format you need.

Contributing

We welcome contributions from the community. To contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Implement your changes.
  4. Commit your changes with a clear message.
  5. Push your changes to your fork.
  6. Open a pull request to the main repository.

Please ensure your code adheres to the existing style and includes relevant tests.

For any questions or further assistance, feel free to contact the ASReview Lab Developers.


Enjoy using ASReview Dory! We hope these new models enhance your systematic review processes.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

asreview_dory-1.2.3.tar.gz (25.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

asreview_dory-1.2.3-py3-none-any.whl (18.1 kB view details)

Uploaded Python 3

File details

Details for the file asreview_dory-1.2.3.tar.gz.

File metadata

  • Download URL: asreview_dory-1.2.3.tar.gz
  • Upload date:
  • Size: 25.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for asreview_dory-1.2.3.tar.gz
Algorithm Hash digest
SHA256 9994a8700427edeb30ce34707fc7e3411bf5d763a3d53ccb82805fe1c6df7970
MD5 3f194568a6fd7882eda05dca86f0b78c
BLAKE2b-256 f8562155f5f94005bdbfa951304a52ce7e18922c621b1ed9db4099d10f8fc805

See more details on using hashes here.

Provenance

The following attestation bundles were made for asreview_dory-1.2.3.tar.gz:

Publisher: pythonpublish.yml on asreview/asreview-dory

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file asreview_dory-1.2.3-py3-none-any.whl.

File metadata

  • Download URL: asreview_dory-1.2.3-py3-none-any.whl
  • Upload date:
  • Size: 18.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for asreview_dory-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fad4d5828f19d067aa658e85dfe5f34289905c5b580d6a1fff3b801a5747fc1a
MD5 941c4440b8b4dd077081da8170295b08
BLAKE2b-256 02375bcfc0186713f9fac40bc01a7be586560da4574f46bcd9ffa41b8faccc27

See more details on using hashes here.

Provenance

The following attestation bundles were made for asreview_dory-1.2.3-py3-none-any.whl:

Publisher: pythonpublish.yml on asreview/asreview-dory

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page