Compare commits
2 Commits
a43c9550ac
...
fb71780563
Author | SHA1 | Date | |
---|---|---|---|
fb71780563 | |||
f9288bf611 |
10
README.md
10
README.md
@ -93,7 +93,7 @@ NuCon includes a preliminary Reinforcement Learning (RL) environment based on th
|
|||||||
To use you'll need to install the following packages:
|
To use you'll need to install the following packages:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install gymnasium numpy
|
pip install -e .[rl] # gymnasium numpy
|
||||||
```
|
```
|
||||||
|
|
||||||
### RL Environment
|
### RL Environment
|
||||||
@ -143,7 +143,7 @@ NuCon provides a built-in simulator to address the challenge of slow training ti
|
|||||||
To use you'll need to install the following packages:
|
To use you'll need to install the following packages:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install torch flask
|
pip install -e .[sim] # torch flask
|
||||||
```
|
```
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
@ -193,7 +193,7 @@ To address the challenge of unknown game dynamics, NuCon provides tools for coll
|
|||||||
To use you'll need to install the following packages:
|
To use you'll need to install the following packages:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install torch numpy
|
pip install -e .[model] # torch numpy
|
||||||
```
|
```
|
||||||
|
|
||||||
### Usage:
|
### Usage:
|
||||||
@ -229,7 +229,7 @@ NuCon includes a test suite to verify its functionality and compatibility with t
|
|||||||
To run the tests:
|
To run the tests:
|
||||||
|
|
||||||
1. Ensure the Nucleares game is running and accessible at http://localhost:8785/ (or update the URL in the test setup).
|
1. Ensure the Nucleares game is running and accessible at http://localhost:8785/ (or update the URL in the test setup).
|
||||||
2. Install pytest: `pip install pytest`
|
2. Install pytest: `pip install pytest` (or `pip install -e .[dev]`)
|
||||||
3. Run the tests:
|
3. Run the tests:
|
||||||
```bash
|
```bash
|
||||||
pytest test/test_core.py
|
pytest test/test_core.py
|
||||||
@ -268,7 +268,7 @@ What? Why would you wanna cite it? What are you even doing?
|
|||||||
To use you'll need to install the following packages:
|
To use you'll need to install the following packages:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install pillow
|
pip install -e .[drake] # pillow
|
||||||
```
|
```
|
||||||
|
|
||||||
### Usage:
|
### Usage:
|
||||||
|
@ -30,6 +30,7 @@ Homepage = "https://git.dominik-roth.eu/dodox/nucon"
|
|||||||
[project.optional-dependencies]
|
[project.optional-dependencies]
|
||||||
dev = ["pytest"]
|
dev = ["pytest"]
|
||||||
rl = ["gymnasium", "numpy"]
|
rl = ["gymnasium", "numpy"]
|
||||||
|
sim = ["torch", "flask"]
|
||||||
model = ["torch", "numpy"]
|
model = ["torch", "numpy"]
|
||||||
drake = ["Pillow"]
|
drake = ["Pillow"]
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user