From 49f1f196a63cb6a477590af5ba52174bfefbff4f Mon Sep 17 00:00:00 2001 From: coolermzb3 Date: Sun, 12 May 2024 04:51:32 +0800 Subject: [PATCH 1/3] fix: missing [crucial] quotation mark in the code snippet, which fails the installling of poetry. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 025bcd3c4..3f37ef7f0 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,7 @@ poetry install ``` You can also install the dev requirements by adding `--with dev` or the extras for say mujoco and acceleration by [envpool](https://github.com/sail-sg/envpool) -by adding `--extras mujoco envpool` +by adding `--extras "mujoco envpool"` Available extras are: - `atari` (for Atari environments) From 91fa85affb8f8b735725f4dc9e8829ea6782388f Mon Sep 17 00:00:00 2001 From: coolermzb3 Date: Sun, 12 May 2024 04:52:35 +0800 Subject: [PATCH 2/3] enh: add more clear documentation for poetry install --extras --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 3f37ef7f0..41861bf9a 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,9 @@ You can also install the dev requirements by adding `--with dev` or the extras for say mujoco and acceleration by [envpool](https://github.com/sail-sg/envpool) by adding `--extras "mujoco envpool"` +If you wish to install multiple extras, ensure that you include them in a single command. Sequential calls to `poetry install --extras xxx` will overwrite prior installations, leaving only the last specified extras installed. +Or you may install all the following extras by adding `--all-extras`. + Available extras are: - `atari` (for Atari environments) - `box2d` (for Box2D environments) From 293d396ddacf2441454f172f39669031c611269f Mon Sep 17 00:00:00 2001 From: coolermzb3 Date: Sun, 12 May 2024 04:53:40 +0800 Subject: [PATCH 3/3] fmt: tiny formatting on markdown table dashes --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 41861bf9a..a5145da60 100644 --- a/README.md +++ b/README.md @@ -150,7 +150,7 @@ Find example scripts in the [test/](https://github.com/thu-ml/tianshou/blob/mast ### Comprehensive Functionality | RL Platform | GitHub Stars | # of Alg. (1) | Custom Env | Batch Training | RNN Support | Nested Observation | Backend | -| ------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |--------------------------------| --------------------------------- | ------------------ | ------------------ | ---------- | +| ------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | ------------------------------ | --------------------------------- | ------------------ | ------------------ | ---------- | | [Baselines](https://github.com/openai/baselines) | [![GitHub stars](https://img.shields.io/github/stars/openai/baselines)](https://github.com/openai/baselines/stargazers) | 9 | :heavy_check_mark: (gym) | :heavy_minus_sign: (2) | :heavy_check_mark: | :x: | TF1 | | [Stable-Baselines](https://github.com/hill-a/stable-baselines) | [![GitHub stars](https://img.shields.io/github/stars/hill-a/stable-baselines)](https://github.com/hill-a/stable-baselines/stargazers) | 11 | :heavy_check_mark: (gym) | :heavy_minus_sign: (2) | :heavy_check_mark: | :x: | TF1 | | [Stable-Baselines3](https://github.com/DLR-RM/stable-baselines3) | [![GitHub stars](https://img.shields.io/github/stars/DLR-RM/stable-baselines3)](https://github.com/DLR-RM/stable-baselines3/stargazers) | 7 (3) | :heavy_check_mark: (gym) | :heavy_minus_sign: (2) | :x: | :heavy_check_mark: | PyTorch |