Metadata-Version: 2.1
Name: hopes
Version: 0.0.4
Summary: HVAC optimisation with Off-Policy Evaluation and Selection methods
License: MIT
Author: Antoine Galataud
Author-email: antoine@foobot.io
Requires-Python: >=3.10,<3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: PyYAML (>=6.0.1,<6.1.0)
Requires-Dist: boto3 (>=1.34.74,<2.0.0)
Requires-Dist: dataclasses-json (==0.6.7)
Requires-Dist: matplotlib (==3.9.1)
Requires-Dist: numpy (==1.26.4)
Requires-Dist: onnx (>=1.20.1,<2.0.0)
Requires-Dist: onnxruntime (==1.18.1)
Requires-Dist: pandas (==2.2.2)
Requires-Dist: pwlf (==2.2.1)
Requires-Dist: pytz (==2026.1)
Requires-Dist: requests (==2.32.5)
Requires-Dist: scikit-learn (==1.7.2)
Requires-Dist: tabulate (==0.9.0)
Requires-Dist: torch (==2.10.0)
Requires-Dist: urllib3 (==2.6.3)
Description-Content-Type: text/markdown

[![tests](https://github.com/airboxlab/hopes/actions/workflows/tests.yml/badge.svg)](https://github.com/airboxlab/hopes/actions/workflows/tests.yml)
[![coverage](https://github.com/airboxlab/hopes/blob/main/coverage.svg)](<>)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

# HOPES

**[Docs](https://hopes.foobot.io/)**

## What is HOPES?

**HOPES** - **H**VAC optimisation with **O**ff-**P**olicy **E**valuation and **S**election - is a Python package for
evaluating and selecting RL-based control policies. It offers a set of estimators and tools to evaluate the performance
of a target policy, compared to a set of baseline policies (characterized by an offline logged dataset), using
off-policy evaluation techniques. It's particularly suited for the context of HVAC control, where the target policy is a
n RL-based controller and the baseline policies are rule-based controllers.

## Installation

Supported Python versions: 3.10+

### From PyPI

```bash
pip install hopes
```

### From source (development version)

```bash
git clone https://github.com/airboxlab/hopes.git
cd hopes
# using poetry
poetry install
# using pip
pip install -r requirements.txt
```

