# gym-js

> A JavaScript Environment for Reinforcement Learning.

Latest version **0.2.0** (published 2019-07-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install gym-js
pnpm add gym-js
yarn add gym-js
bun add gym-js
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2019-07-24 |
| First published | 2019-06-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 86.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Thomas Tumiel |
| Maintainers | tom2718 |
| Keywords | reinforcement learning |

## Links

- npm: https://www.npmjs.com/package/gym-js
- Repository: https://github.com/Tom2718/gym.js
- Homepage: https://github.com/Tom2718/gym.js#readme
- Issues: https://github.com/Tom2718/gym.js/issues
- npm.io page: https://npm.io/package/gym-js

## Dependencies (2)

- [phaser](https://npm.io/package/phaser.md) ^3.18.1
- [@tensorflow/tfjs](https://npm.io/package/@tensorflow/tfjs.md) ^1.2.1

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.2.0 (latest) — 2019-07-24
- 0.1.6 — 2019-07-07
- 0.1.5 — 2019-06-30
- 0.1.4 — 2019-06-27
- 0.1.3 — 2019-06-22
- 0.1.2 — 2019-06-22

## README

# gym.js

__Warning__: Under active development. APIs may change.

A browser-based reinforcement learning environment. Based off of OpenAI's [Gym](https://github.com/openai/gym).

[See the docs](https://tom2718.github.io/gym.js/index.html)

## Installation

Install with `npm`:

```bash
npm install gym-js
```

And import environments from the module:

```javascript
import { FrozenLake } from "gym-js";
```

## Contributing

Please make a pull request for any contribution. In particular, you can reimplement `gym` environments, add test cases and patch any bugs you might find. Additionally, if you have any suggestions on the API, or the library in general, you can open an issue.

## Adding a New Environment

[See here.](https://github.com/Tom2718/gym.js/tree/master/src/envs#environments)

## Future Plans

The aim for this library is to match `gym` with both functionality and environments. A list of environments still to be added is in the [`env`](https://github.com/Tom2718/gym.js/tree/master/src/envs#environments) folder.

---
_Source: https://npm.io/package/gym-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
