README.md 1.54 KB
Newer Older
Sebastian Miller's avatar
Sebastian Miller committed
1
2
3
# NOTICE
This branch contains only the part of the project associated with the ensembling model development process.
If you are looking for the interactive ensembling component, which utilizes the said model, visit the [integration](https://gitlab.ow2.org/melodic/zpp-assembler/-/tree/integration) branch.
Marta Różańska's avatar
Marta Różańska committed
4

Sebastian Miller's avatar
Sebastian Miller committed
5
6
# Ensembling model research
This directory contains files associated with the ensembling model development process. The model is based on reinforcement learning.
Mikołaj  Drzewiecki's avatar
Mikołaj Drzewiecki committed
7

Sebastian Miller's avatar
Sebastian Miller committed
8
9
10
11
12
13
14
15
## Directory contents
- `src/env/`: implementation of the OpenAI Gym environment utilized by the model
- `src/experiments/`: code and configurations associated with model experiments
- `src/logging/`: code associated with logging experiment data to Neptune.ai
- `main.py`: program for running experiments from `src/experiments`
- `definitions.py`: utility constans, such as directory paths

## Installation
Mikołaj  Drzewiecki's avatar
Mikołaj Drzewiecki committed
16
17
18
19
20
21
22
In project root directory:
```
python3 -m venv venv
source ./venv/bin/activate
pip3 install -r ./requirements.txt --no-cache-dir
```

Sebastian Miller's avatar
Sebastian Miller committed
23
24
25
26
27
## Experiment setup
1. Create a `neptune_key.yaml` file with a single line: `API_KEY: <your_neptune_ai_api_token>`.
2. Insert a CSV file with training data, named `predictions.csv` in the `data/external/` directory.
3. Choose which experiments you wish to run by uncommenting appropriate lines in the `main.py` program.
4. Configure the experiments chosen above by modifying the `.yaml` files associated with the experiments, e.g. `src/experiments/ppo/configs/continuous_reward.yaml`. 
Mikołaj  Drzewiecki's avatar
Mikołaj Drzewiecki committed
28

Sebastian Miller's avatar
Sebastian Miller committed
29
30
## Experiment startup
Simply run the `main.py` program via:
Mikołaj  Drzewiecki's avatar
Mikołaj Drzewiecki committed
31
```
Sebastian Miller's avatar
Sebastian Miller committed
32
python3 main.py
Mikołaj  Drzewiecki's avatar
Mikołaj Drzewiecki committed
33
```