Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
epignatelli committed Dec 20, 2023
1 parent f96d18a commit 75a110c
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![CD](https://github.com/epignatelli/helx/actions/workflows/CD.yml/badge.svg)](https://github.com/epignatelli/helx/actions/workflows/CD.yml)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/epignatelli/helx?color=%23216477&label=Release)

**[Quickstart](#what-is-helx)** | **[Installation](#installation)** | **[Examples](#examples)** | **[Cite](#cite)**
**[Quickstart](#what-is-helx)** | **[Why helx?](#why-helx)**[Installation](#installation)** | **[Examples](#examples)** | **[Cite](#cite)**

## What is HELX?

Expand All @@ -16,8 +16,15 @@ With HELX you easily can:
- Use the `helx.experiment` namespace to run experiments on your local machine, on a cluster, or on the cloud
- Use the `helx.base` namespace to access the most common RL data structures and functions (e.g., a Ring buffer)

## Why HELX?
HELX is designed to be easy to use, easy to extend, and easy to read.
- No 2000 lines of code files
- No multiple inheritance hierarchies where behaviours get lost in the middle
- No complex abstractions that hide the underlying code

Each namespace provides a single, standardised interface to all agents, environments and experiment runners.


## Installation

- ### Stable
Expand Down

0 comments on commit 75a110c

Please sign in to comment.