Metadata-Version: 2.4
Name: asreview
Version: 3.0rc0
Summary: ASReview LAB - A tool for AI-assisted systematic reviews
Author-email: ASReview LAB developers <asreview@uu.nl>
License-Expression: Apache-2.0
Project-URL: Bug Tracker, https://github.com/asreview/asreview/issues
Project-URL: Documentation, https://asreview.readthedocs.io/en/stable//
Project-URL: Downloads, https://github.com/asreview/asreview/releases
Project-URL: Homepage, https://asreview.ai/
Project-URL: Release Notes, https://github.com/asreview/asreview/releases
Project-URL: Slack Chat, https://asreviewcommunity.slack.com
Project-URL: Source Code, https://github.com/asreview/asreview
Project-URL: YouTube, https://www.youtube.com/@ASReview
Keywords: systematic review,machine-learning
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Text Processing :: General
Classifier: Framework :: Flask
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pandas<3,>=2.2
Requires-Dist: scikit-learn>=1.5
Requires-Dist: rispy~=0.9.0
Requires-Dist: flask>=2.3.0
Requires-Dist: flask_cors
Requires-Dist: flask-login>=0.6.3
Requires-Dist: flask-mail
Requires-Dist: Werkzeug>=2.3.2
Requires-Dist: openpyxl>=3.0.3
Requires-Dist: jsonschema
Requires-Dist: filelock
Requires-Dist: Flask-SQLAlchemy>=3.0.2
Requires-Dist: requests
Requires-Dist: tqdm
Requires-Dist: rich
Requires-Dist: waitress
Requires-Dist: gevent>=20
Requires-Dist: datahugger>=0.2
Requires-Dist: synergy_dataset
Requires-Dist: sqlalchemy-utils
Requires-Dist: tomli; python_version < "3.11"
Provides-Extra: lint
Requires-Dist: ruff; extra == "lint"
Requires-Dist: check-manifest; extra == "lint"
Provides-Extra: test
Requires-Dist: coverage; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-random-order; extra == "test"
Requires-Dist: pytest-selenium; extra == "test"
Provides-Extra: docs
Requires-Dist: ipython; extra == "docs"
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Requires-Dist: sphinx-reredirects; extra == "docs"
Requires-Dist: sphinxcontrib-youtube; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"
Provides-Extra: dev
Requires-Dist: setuptools; extra == "dev"
Requires-Dist: asreview[lint]; extra == "dev"
Requires-Dist: asreview[test]; extra == "dev"
Requires-Dist: asreview[docs]; extra == "dev"
Dynamic: license-file

<!-- ASReview LAB v2 Banner -->
<p align="center">
  <img width="60%" height="60%" src="https://raw.githubusercontent.com/asreview/asreview-artwork/refs/heads/master/LogoASReview/asreview_logo_light.svg">
</p>

<br/>

<p align="center">
  <b>🎉 ASReview LAB v2 is here! 🎉</b><br>
  <i>Faster, smarter, and more flexible than ever before.<br>
  Discover the new AI models, improved workflow, and enhanced user experience.<br>
  </i>
</p>

<br/>

<p align="center">
  <a href="https://asreview.nl/download"><img src="https://img.shields.io/badge/Installation-FFCD00?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iMjQiIHZpZXdCb3g9IjAgLTk2MCA5NjAgOTYwIiB3aWR0aD0iMjQiPjxwYXRoIGQ9Ik00ODAtMzIwIDI4MC01MjBsNTYtNTggMTA0IDEwNHYtMzI2aDgwdjMyNmwxMDQtMTA0IDU2IDU4LTIwMCAyMDBaTTI0MC0xNjBxLTMzIDAtNTYuNS0yMy41VDE2MC0yNDB2LTEyMGg4MHYxMjBoNDgwdi0xMjBoODB2MTIwcTAgMzMtMjMuNSA1Ni41VDcyMC0xNjBIMjQwWiIvPjwvc3ZnPg=="/></a>
  <a href="https://asreview.readthedocs.org"><img src="https://img.shields.io/badge/Documentation-FFCD00?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iMjQiIHZpZXdCb3g9IjAgLTk2MCA5NjAgOTYwIiB3aWR0aD0iMjQiPjxwYXRoIGQ9Ik0zMjAtMjQwaDMyMHYtODBIMzIwdjgwWm0wLTE2MGgzMjB2LTgwSDMyMHY4MFpNMjQwLTgwcS0zMyAwLTU2LjUtMjMuNVQxNjAtMTYwdi02NDBxMC0zMyAyMy41LTU2LjVUMjQwLTg4MGgzMjBsMjQwIDI0MHY0ODBxMCAzMy0yMy41IDU2LjVUNzIwLTgwSDI0MFptMjgwLTUyMHYtMjAwSDI0MHY2NDBoNDgwdi00NDBINTIwWk0yNDAtODAwdjIwMC0yMDAgNjQwLTY0MFoiLz48L3N2Zz4="/></a>
  <a href="https://asreview.app"><img src="https://img.shields.io/badge/Live_Demo-C00A35?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iMjQiIHZpZXdCb3g9IjAgLTk2MCA5NjAgOTYwIiB3aWR0aD0iMjQiPjxwYXRoIGQ9Ik0yMDAtMTIwcS0zMyAwLTU2LjUtMjMuNVQxMjAtMjAwdi01NjBxMC0zMyAyMy41LTU2LjVUMjAwLTg0MGg1NjBxMzMgMCA1Ni41IDIzLjVUODQwLTc2MHY1NjBxMCAzMy0yMy41IDU2LjVUNzYwLTEyMEg2MDB2LTgwaDE2MHYtNDgwSDIwMHY0ODBoMTYwdjgwSDIwMFptMjQwIDB2LTI0NmwtNjQgNjQtNTYtNTggMTYwLTE2MCAxNjAgMTYwLTU2IDU4LTY0LTY0djI0NmgtODBaIi8+PC9zdmc+&logoColor=white"/></a>
</p>
</br>

## ASReview LAB: Active Learning for Systematic Reviews

**ASReview LAB** is an open-source machine learning tool for efficient,
transparent, and interactive screening of large textual datasets. It is widely
used for systematic reviews, meta-analyses, and any scenario requiring
systematic text screening.

The key features of **ASReview LAB** are:

- **Active Learning**: Interactively prioritize records using AI models that
  learn from your labeling decisions.
- **Scientifically validated**: ASReview LAB has been scientifically validated
  and published in [Nature Machine
  Intelligence](https://doi.org/10.1038/s42256-020-00287-7).
- **Flexible AI Models**: Choose from pre-configured ELAS models or build your
  own with custom components.
- **Simulation toolkit**: Assess model performance on fully labeled datasets.
- **Label Management**: All decisions are saved automatically; easily change
  labels at any time.
- **User-Centric Design**: Humans are the oracle; the interface is transparent
  and customizable.
- **Privacy First**: Everything is open source and no usage or user data is
  collected.

---

### What's New in Version 2?

On May 14th, ASReview LAB version 2 was released with a large set of new
features. The most notable new features are:

- **New ELAS AI Models**: Pre-configured, high-performance (+24%) models for
  different use cases (Ultra, Multilingual, Heavy). More new and exciting models
  can now be found in our new [ASReview
  Dory](https://github.com/asreview/asreview-dory) extension.
- **Improved User Experience**: The interface is faster, progress monitoring is
  better, and there are more customization options (such as dark mode, font
  size, and keyboard shortcuts).
- **ASReview LAB Server with crowd screening**: Screen a single project with
  multiple experts. All users interact with the same AI model.
- **Quick project setup**: Start screening new datasets in seconds using the
  quick setup for projects.
- **Add customizable tags**: Add tags and groups of tags to your records and
  label decisions. This makes data extraction much easier!
- **Improved simulation API**: The new and flexible simulation API opens up a
  whole new simulation potential. It is a perfect tool for hunting for even
  better-performing models.

---

## Installation

Requires Python 3.10 or later.

```bash
pip install asreview
```

Upgrade:

```bash
pip install --upgrade asreview
```

For Docker and advanced installation, see the [installation
guide](https://asreview.readthedocs.io/en/stable/lab/installation.html).

Latest version of ASReview LAB: [![PyPI
version](https://badge.fury.io/py/asreview.svg)](https://badge.fury.io/py/asreview)



## The ASReview LAB Workflow

1. **Import Data**: Load your dataset (CSV, RIS, XLSX, etc.).
2. **Create Project**: Set up a new review or simulation project.
3. **Select Prior Knowledge**: Optionally provide records you already know are
   relevant or not relevant.
4. **Start Screening**: Label records as Relevant or Not Relevant; the AI model
   continuously improves.
5. **Monitor Progress**: Use the dashboard to track your progress and decide
   when to stop.
6. **Export Results**: Download your labeled dataset or project file.

[![ASReview
LAB](https://github.com/asreview/asreview/blob/main/images/ASReviewWebApp.png?raw=true)](https://asreview.readthedocs.io/en/stable/lab/about.html
"ASReview LAB")

---

## Documentation & Resources

- [Documentation](https://asreview.readthedocs.io/)
- [Video tutorials](https://www.youtube.com/@ASReview)
- [AI models of ASReview
  LAB](https://asreview.readthedocs.io/en/latest/lab/models.html)
- [FAQ](https://github.com/asreview/asreview/discussions?discussions_q=sort%3Atop)
- [Live Demo](https://asreview.app)


## Citation

If you wish to cite the underlying methodology of the ASReview software, please
use the following publication in Nature Machine Intelligence:

> van de Schoot, R., de Bruin, J., Schram, R. et al. An open source machine
> learning framework for efficient and transparent systematic reviews. Nat Mach
> Intell 3, 125–133 (2021). https://doi.org/10.1038/s42256-020-00287-7

For citing the software, please refer to the specific release of the ASReview
software on Zenodo: https://doi.org/10.5281/zenodo.3345592. The menu on the
right can be used to find the citation format you need.

For more scientific publications on the ASReview software, go to
[asreview.ai/papers](https://asreview.ai/papers/).

## Community & Contact

The best resources to find an answer to your question or ways to get in contact
with the team are:

- [Newsletter](https://asreview.ai/newsletter/subscribe)
- [FAQ](https://github.com/asreview/asreview/discussions?discussions_q=sort%3Atop)
- [Community events](https://asreview.ai/events)
- [Issues or feature requests](https://github.com/asreview/asreview/issues)
- [Donate to ASReview](https://asreview.ai/donate)
- [Contact](mailto:asreview@uu.nl) (asreview@uu.nl)

## License

The ASReview software has an Apache 2.0 [LICENSE](LICENSE). The ASReview team
accepts no responsibility or liability for the use of the ASReview tool or any
direct or indirect damages arising out of the application of the tool.
