Metadata-Version: 2.4
Name: SHARPIE
Version: 1.0.0rc1
Summary: A modular framework for Reinforcement Learning and Human-AI interaction experiments.
Author-email: Libio Gonçalves Braz <l.b.goncalvesbraz@uu.nl>, Floris den Hengst <f.den.hengst@vu.nl>, Kevin Godin-Dubois <k.j.m.godin-dubois@vu.nl>, Yeqian Li <y43.li@student.vu.nl>, Hüseyin Aydın <huseyin@ceng.metu.edu.tr>
Maintainer-email: Libio Gonçalves Braz <l.b.goncalvesbraz@uu.nl>, Floris den Hengst <f.den.hengst@vu.nl>, Kevin Godin-Dubois <k.j.m.godin-dubois@vu.nl>
License: Apache-2.0
Project-URL: Homepage, https://github.com/hybrid-intelligence/SHARPIE
Project-URL: Documentation, https://sharpie.readthedocs.io
Project-URL: Repository, https://github.com/hybrid-intelligence/SHARPIE
Project-URL: Issues, https://github.com/hybrid-intelligence/SHARPIE/issues
Keywords: reinforcement-learning,human-ai-interaction,hybrid-intelligence,experiment-platform,django
Classifier: Framework :: Django
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: websockets~=16.0
Requires-Dist: django~=5.2.0
Requires-Dist: channels[daphne]~=4.3.0
Requires-Dist: Twisted[http2,tls]~=26.4.0
Requires-Dist: channels_redis~=4.3.0
Requires-Dist: redis~=7.4.0
Requires-Dist: django-crispy-forms~=2.6
Requires-Dist: crispy-bootstrap4~=2026.2
Requires-Dist: opencv-python-headless~=4.13.0.0
Requires-Dist: django-extensions~=4.1.0
Requires-Dist: pydot~=4.0.0
Requires-Dist: aiohttp~=3.14.0
Requires-Dist: django-environ~=0.13.0
Requires-Dist: pyyaml~=6.0.0
Requires-Dist: markdown~=3.10.2
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: pytest-django>=4.5; extra == "dev"
Requires-Dist: black>=23.0; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Requires-Dist: mypy>=1.0; extra == "dev"
Requires-Dist: build==1.5.0; extra == "dev"
Requires-Dist: pygraphviz~=1.14.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=7.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=2.0; extra == "docs"
Requires-Dist: sphinx-copybutton>=0.5.2; extra == "docs"
Requires-Dist: sphinx-autobuild>=2025.8.25; extra == "docs"
Requires-Dist: sphinxcontrib-django>=2.5; extra == "docs"
Requires-Dist: myst-parser>=3.0; extra == "docs"
Dynamic: license-file

[![versions](https://img.shields.io/badge/python-3.10-blue)](#) [![motivating-paper](https://img.shields.io/badge/paper-motivation-blue)](https://doi.org/10.48550/arXiv.2501.19245) [![docs](https://app.readthedocs.org/projects/sharpie/badge/?version=latest)](https://sharpie.readthedocs.io/en/latest/index.html)

# SHARPIE - beta version
## Shared Human-AI Reinforcement Learning Platform for Interactive Experiments
[![Demo](https://github.com/hybrid-intelligence/SHARPIE/blob/main/webserver/home/static/home/preview_image_1.png)](https://archive.org/embed/hhai-demo-1)
SHARPIE is a Python-based modular framework for Reinforcement Learning and Human-AI interaction experiments.

Reinforcement learning offers a general approach for modeling and training AI agents, including human-AI interaction scenarios. SHARPIE addresses the need for a generic framework to support experiments with RL agents and humans. Its modular design consists of a versatile wrapper for RL environments and algorithm libraries, a participant-facing web interface, logging utilities, deployment on popular cloud and participant recruitment platforms. 

It empowers researchers to study a wide variety of research questions related to the interaction between humans and RL agents, including those related to interactive reward specification and learning, learning from human feedback, action delegation, preference elicitation, user-modeling, and human-AI teaming. The platform is based on a generic interface for human-RL interactions that aims to standardize the field of study on RL in human contexts.

## Documentation
You can find the documentation [here](https://sharpie.readthedocs.io/en/latest/).

## Acknowledgements
This research was funded by the [Hybrid Intelligence
Center](https://hybridintelligence-centre.nl), a 10-year programme funded by the Dutch Ministry of
Education, Culture and Science through the Netherlands Organisation for Scientific Research, Grant
No: 024.004.022.

## Citations
When using this project in a scientific publication please cite:
```bibtex
@inproceedings{sharpiecaihu25,
    booktitle = {AAAI Bridge Program Workshop on Collaborative AI and Modeling of Humans},
    title = {{SHARPIE}: A Modular Framework for Reinforcement Learning and Human-AI Interaction Experiments},
    author = {Ayd$\i$n, H{\"{u}}seyin and Godin-Dubois, Kevin and Goncalves Braz, Libio and den Hengst,
    Floris and Baraka, Kim and {\c{C}}elikok, Mustafa Mert and Sauter, Andreas and Wang, Shihan and
    Oliehoek, Frans A},
    month = {feb},
    address = {Philadelphia, Pennsylvania, USA},
    doi={10.48550/arXiv.2501.19245},
    year = {2025}
}
```
