Skip to content

Commit

Permalink
added arxiv number
Browse files Browse the repository at this point in the history
  • Loading branch information
fdreyer committed Mar 26, 2019
1 parent f5dd46a commit 21831a0
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 10 deletions.
26 changes: 17 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
[![DOI](https://zenodo.org/badge/159022917.svg)](https://zenodo.org/badge/latestdoi/159022917)

GroomRL: jet grooming through reinforcement learning
====================================================
GroomRL
=======

This repository contains the code and results presented in [arXiv:19xx.xxxxx](https://arxiv.org/abs/190x.xxxxx "GroomRL paper").
This repository contains the code and results presented in
[arXiv:1903.09644](https://arxiv.org/abs/1903.09644 "GroomRL paper").

## About

GroomRL is a reinforcement learning framework to train jet grooming strategies.

## Install GroomRL

Expand All @@ -20,12 +25,14 @@ the "--target=PREFIX_PATH" flag.

This process will copy the `groomrl` program to your environment python path.

We recommend the installation of the GroomRL package using a `miniconda3` environment with the [following packages](https://github.com/JetsGame/groomrl/blob/master/environment.yml).
We recommend the installation of the GroomRL package using a `miniconda3`
environment with the
[configuration specified here](https://github.com/JetsGame/groomrl/blob/master/environment.yml).

GroomRL requires the following packages:
- python3
- numpy
- [fastjet](http://fastjet.fr/) (compiled with --enable-pyext using g++ and make)
- [fastjet](http://fastjet.fr/) (compiled with --enable-pyext)
- gym
- matplotlib
- pandas
Expand All @@ -40,14 +47,15 @@ GroomRL requires the following packages:
## Pre-trained models

The final models presented in
[arXiv:19xx.xxxxx](https://arxiv.org/abs/190x.xxxxx "GroomRL paper")
[arXiv:1903.09644](https://arxiv.org/abs/1903.09644 "GroomRL paper")
are stored in:
- results/groomerW_final: GroomRL model trained on W jets.
- results/groomerTop_final: GroomRL model trained on top jets.

## Input data

All data used for the final models can be downloaded from the git-lfs repository at https://github.com/JetsGame/data.
All data used for the final models can be downloaded from the git-lfs repository
at https://github.com/JetsGame/data.

## Running the code

Expand Down Expand Up @@ -78,5 +86,5 @@ which will create a new directory in `<folder>` using the datafile name.

## References

* S. Carrazza and F.A. Dreyer, "Jet grooming through reinforcement learning,"
[arXiv:19xx.xxxxx](https://arxiv.org/abs/190x.xxxxx "GroomRL paper")
* S. Carrazza and F. A. Dreyer, "Jet grooming through reinforcement learning,"
[arXiv:1903.09644](https://arxiv.org/abs/1903.09644 "GroomRL paper")
2 changes: 1 addition & 1 deletion src/groomrl/scripts/groomer.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# This file is part of GroomRL by S. Carrazza and F. A. Dreyer

"""
groomer.py: the entry point for the groomrl.
groomer.py: the entry point for groomrl.
"""
from groomrl.read_data import Jets
from groomrl.models import build_and_train_model, load_runcard
Expand Down

0 comments on commit 21831a0

Please sign in to comment.