Skip to content

vtnsiSDD/rfrl-gym

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welcome to the RFRL GYM Python Package!

The RFRL Gym is intended as a training and research environment for wireless communications applications designed to provide comprehensive functionality, such as custom scenario generation, multiple learning settings, and compatibility with third-party RL packages. Additionally, through a gamified mode of the RF spectrum, this tool can be used to teach novices about the fields of AI/ML and RF.

Jamming Agent before Learning Jamming Agent after Learning
initial learned

Note: Pardon our mess as this project is under active development. Please let us know of any feature requests or bugs to be squashed!

To install the codebase:

Linux (verified in Ubuntu)

  1. Install necessary prerequist software using the terminal:

sudo apt install python3 python3-pip python3-venv python3-wheel

  1. Set up a Python virtual environment in the root directory of the repository:

python3 -m venv rfrl-gym-venv

  1. Ensure that venv is fully updated:

python3 -m venv --upgrade rfrl-gym-venv

  1. Activate the virtual environment (you will need to do this everytime you being working with the repository in a new terminal):

source rfrl-gym-venv/bin/activate

  1. Install setuptools:

pip3 install pip wheel setuptools --upgrade

  1. Install the repository:

pip3 install --editable .

To test installation of the codebase and the renderer:

python3 scripts/preview_scenario.py -m abstract

python3 scripts/preview_scenario.py -m iq

A terminal output should print out showing the observation space upon successful execution.

To install with the stable_baselines3 package:

pip3 install -e ".[rl_packages]"

To test installation of the stable_baselines3 package:

python3 scripts/sb3_example.py -m abstract

python3 scripts/sb3_preview_scenario.py -m abstract

How to reference:

@inproceedings{rfrlgym,
  Title = {{RFRL Gym: A Reinforcement Learning Testbed for Cognitive Radio Applications}},
  Author = {D. Rosen, I. Rochez, C. McIrvin, J. Lee, K. D’Alessandro, M. Wiecek, N. Hoang, R. Saffarini, S. Philips, V. Jones, W. Ivey, Z. Harris-Smart, Z. Harris-Smart, Z. Chin, A. Johnson, A. Jones, W. C. Headley},
  Booktitle = {{IEEE International Conference on Machine Learning and Applications (ICMLA)}},
  Year = {2023},
  Location = {Jacksonville, USA},
  Month = {December},
  Url = {}

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages