<a name="readme-top"></a>


<!-- PROJECT LOGO -->
<br />

<h3 align="center">Conciliator steering</h3>

  <p align="center">
    A visualisation demo for the NeurIPS 2023 paper "Conciliator steering: Imposing user preference with in multi-objective reinforcement learning problems' trade-offs with expected scalarised returns"
  </p>
</div>


<!-- TABLE OF CONTENTS -->
<details>
  <summary>Table of Contents</summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#prerequisites">Prerequisites</a></li>
        <li><a href="#installation">Installation</a></li>
      </ul>
    </li>
    <li><a href="#usage">Usage</a></li>
    <li><a href="#structure">Structure</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#contact">Contact</a></li>
  </ol>
</details>


<!-- ABOUT THE PROJECT -->
## About The Project

* Title: `Conciliator steering`, 
* Description: `A visualisation demo for the NeurIPS 2023 paper "Conciliator steering: Imposing user preference with in multi-objective reinforcement learning problems' trade-offs with expected scalarised returns"`

<p align="right">(<a href="#readme-top">back to top</a>)</p>


<!-- GETTING STARTED -->
## Installation

1. Check the prerequisites 
2. Clone the repo
3. Run `sh commands.sh` in the command line
4. Success!


### Prerequisites

* Python
  Follow the insctructions from [Python's official website.](https://www.python.org/downloads/)

* While not strictly a prerequisite, the code is highly recommended to be run in a Windows environment due to the Tkinter and the pip install commands included in the command line script.


<p align="right">(<a href="#readme-top">back to top</a>)</p>


## Structure
The repository is partiotioned into the following files:
* The `requirements.txt` contains the library requirements to run the demo.
* The `conciliator.py` contains the optimization script.
* The `commands.sh` contains the command line script used to run the algorithm as a whole.
* The `LICENSE.txt` contains the info about the license this project is distributed under.
* The `conciliator_demo.mp4` contains a video about the demo in action.

<p align="right">(<a href="#readme-top">back to top</a>)</p>


<!-- USAGE EXAMPLES -->
## Usage

The code is an interactive tool made for the Conciliator steering algorithm. 

In the repository, there is a video `conciliator_demo.mp4` showing the tool in action.

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- LICENSE -->
## License

Distributed under the MIT License. See `LICENSE.txt` for more information.

<p align="right">(<a href="#readme-top">back to top</a>)</p>