Metadata-Version: 2.1
Name: corl
Version: 3.14.12a0
Summary: Core ACT3 Reinforcement Learning (RL) Library - Core framework and base implementations of common things such as controllers, glues, observes, sensors, evaluation, and etc
Home-page: https://github.com/act3-ace/CoRL
Keywords: Deep,Reinforcement,Learning,CoRL,act3,ACT3
Author: Benjamin K Heiner
Author-email: benjamin.heiner@us.af.mil
Maintainer: Benjamin K Heiner
Maintainer-email: benjamin.heiner@us.af.mil
Requires-Python: >=3.10,<3.12
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: GitPython (==3.1.41)
Requires-Dist: async_timeout (>=4.0.3,<5.0.0)
Requires-Dist: codetiming (>=1.4.0,<2.0.0)
Requires-Dist: deepmerge (==0.3.0)
Requires-Dist: fastapi (>=0.104.1,<0.105.0)
Requires-Dist: flatten-dict (==0.4.1)
Requires-Dist: gymnasium (==0.28.1)
Requires-Dist: h5py (>=3.7)
Requires-Dist: jsonargparse[argcomplete,signatures] (>=4,<5)
Requires-Dist: matplotlib (>=3.7.2,<4.0.0)
Requires-Dist: numpy (>=1.24.0,<2.0.0)
Requires-Dist: numpy-ringbuffer (>=0.2.2,<0.3.0)
Requires-Dist: plotly (>=5.14.1,<6.0.0)
Requires-Dist: pydantic (>=2.5.0,<3.0.0)
Requires-Dist: pygame (>=2.1.2,<3.0.0)
Requires-Dist: pygifsicle (>=1.0.7,<2.0.0)
Requires-Dist: ray[all] (>=2.9.0,<2.10.0)
Requires-Dist: scipy (>=1.10.1,<2.0.0)
Requires-Dist: stqdm (>=0.0.5,<0.0.6)
Requires-Dist: streamlit (>=1.30.0,<2.0.0)
Requires-Dist: tabulate (>=0.9.0,<0.10.0)
Requires-Dist: tensorboard (>=2.10,<3.0)
Requires-Dist: tensorflow (==2.15.0)
Requires-Dist: tensorflow-probability (>=0.23.0,<0.24.0)
Requires-Dist: types-tabulate (>=0.9.0.2,<0.10.0.0)
Requires-Dist: uvicorn (>=0.24.0.post1,<0.25.0)
Project-URL: Documentation, https://github.com/act3-ace/CoRL
Project-URL: Repository, https://github.com/act3-ace/CoRL
Description-Content-Type: text/markdown

---
title: CoRL
---

<!-- {{ include_top_banner() }} -->

<!-- {{ include_github_badges() }} -->

<!-- {{ include_repo_badges() }} -->

# 1. Core ACT3 Reinforcement Learning Library

> **This repository and corresponding documentation site are currently under construction. We are still porting items and updating instructions for GitHub.**

## 1.1. Summary

The Core ACT3 Reinforcement Learning library (CoRL) is created and maintained by the Air Force Research Laboratory’s (AFRL) [Autonomy Capability Team (ACT3)](https://www.afrl.af.mil/ACT3/). CoRL is intended to enable scalable deep reinforcement learning (RL) experimentation in a manner extensible to new simulations and new ways for the learning agents to interact with them. The objective is to make RL research easier by removing lock-in to particular simulations.

### 1.1.1. Benefits

- Makes RL environment development significantly easier
- Provides hyper configurable environments, agents and experiments
- Record observations by adding a few lines of config (instead of creating a new file for each observation)
- Reuse glues/dones/rewards between different tasks if they are general
- Uses an episode parameter provider (EPP) to randomize both domain and curriculum learning
- Has an integration first focus, which means that integrating agents to the real world or different simulators is significantly easier

### 1.1.2. Related Publications

- [CoRL: Environment Creation and Management Focused on System Integration](https://arxiv.org/abs/2303.02182)
- [Inside the special F-16 the Air Force is using to test out ML](https://breakingdefense.com/2023/01/inside-the-special-f-16-the-air-force-is-using-to-test-out-ML/)
- [AFRL, AFTC collaborate on future technology via weeklong autonomy summit](https://www.wpafb.af.mil/News/Article-Display/Article/3244878/afrl-aftc-collaborate-on-future-technology-via-weeklong-autonomy-summit/)
- [Demonstrating and testing machine learning applications in aerospace](https://aerospaceamerica.aiaa.org/year-in-review/demonstrating-and-testing-artificial-intelligence-applications-in-aerospace/)

## 1.2. Documentation

Documentation for the CoRL repository can be accessed directly as files in this repository, as a public documentation site, or can be built locally as an MkDocs site.

### 1.2.1. Guides

- [Quick Start Guide](guides/quick-start-guide.md)

### 1.2.2. Documentation Web Site

The [full public documentation site](https://act3-ace.github.io/CoRL/) is available on GitHub pages.

### 1.2.3. Local Documentation

A local version of the documentation site can be built using [MkDocs](https://www.mkdocs.org/).

Build the documentation:

```sh
mkdocs build
```

> Follow  CLI prompts, as needed, to install all required plugins.

Serve the documentation:

```sh
mkdocs serve
```

## 1.3. Notices and Warnings

### 1.3.1. Initial Contributors

Initial contributors include scientists and engineers associated with the [Air Force Research Laboratory (AFRL)](https://www.afrl.af.mil/), [Autonomy Capability Team 3 (ACT3)](https://www.afrl.af.mil/ACT3/), and the [Aerospace Systems Directorate (RQ)](https://www.afrl.af.mil/RQ/).

### 1.3.2. Citing CoRL

If you use CoRL in your work, please use the following BibTeX to cite the CoRL white paper:

```bibtex
@inproceedings{
  title={CoRL: Environment Creation and Management Focused on System Integration},
  author={Justin D. Merrick, Benjamin K. Heiner, Cameron Long, Brian Stieber, Steve Fierro, Vardaan Gangal, Madison Blake, Joshua Blackburn},
  year={2023},
  url={https://arxiv.org/abs/2303.02182}
}
```

To cite the source code, use the **Cite this repository** option on GitHub to access the reference.

### 1.3.3. Distribution Statement

Approved for public release: distribution unlimited.

#### 1.3.3.1. Case Number

|    Date    |     Release Number     | Description      |
| :--------: | :--------------------: | :--------------: |
| 2022-05-20 |     AFRL-2022-2455     | Initial release  |
| 2023-03-02 | APRS-RYZ-2023-01-00006 | Second release   |
| 2024-21-03 | AFRL-2024-1562         | Thirst release   |

#### 1.3.3.2. Designation Indicator

- Controlled by: Air Force Research Laboratory (AFRL)
- Controlled by: AFRL Autonomy Capability Team (ACT3)

#### 1.3.3.3. Points of Contact

- [Terry Wilson](mailto:terry.wilson.11@us.af.mil)
- [Benjamin Heiner](mailto:benjamin.heiner@us.af.mil)
- [Kerianne Hobbs](mailto:kerianne.hobbs@us.af.mil)

##### 1.3.3.3.1. Repository Contributors

{{ get_authors() }}

##### 1.3.3.3.2. Documentation Contributors

{{ git_site_authors }}

{{ include_glossary_abbreviations() }}

{{ include_bottom_banner() }}

