Better optional dependency management

This commit is contained in:
Dominik Moritz Roth 2024-10-03 23:33:20 +02:00
parent f9288bf611
commit fb71780563

View File

@ -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:
```bash
pip install gymnasium numpy
pip install -e .[rl] # gymnasium numpy
```
### 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:
```bash
pip install torch flask
pip install -e .[sim] # torch flask
```
### 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:
```bash
pip install torch numpy
pip install -e .[model] # torch numpy
```
### Usage:
@ -229,7 +229,7 @@ NuCon includes a test suite to verify its functionality and compatibility with t
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).
2. Install pytest: `pip install pytest`
2. Install pytest: `pip install pytest` (or `pip install -e .[dev]`)
3. Run the tests:
```bash
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:
```bash
pip install pillow
pip install -e .[drake] # pillow
```
### Usage: