You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<ahref="https://colab.research.google.com/github/ai4co/rl4co/blob/main/examples/1-quickstart.ipynb"><imgsrc="https://colab.research.google.com/assets/colab-badge.svg"alt="Open In Colab"></a>
@@ -89,7 +89,7 @@ git clone https://github.com/ai4co/rl4co && cd rl4co
89
89
pip install -e .
90
90
```
91
91
92
-
We recommend using a virtual environment such as `conda` to install `rl4co` locally.
92
+
We recommend installing in virtual environments with a package manager such as the blazing-fast [`uv`](https://docs.astral.sh/uv/), [`poetry`](https://python-poetry.org/), or [`conda`](https://docs.conda.io/en/latest/); instruction are available in the [documentation](https://rl4.co/docs/content/start/installation/).
93
93
94
94
95
95
@@ -174,14 +174,7 @@ pytest tests
174
174
175
175
### Known Bugs
176
176
177
-
178
-
#### Bugs installing PyTorch Geometric (PyG)
179
-
180
-
Installing `PyG` via `Conda` seems to update Torch itself. We have found that this update introduces some bugs with `torchrl`. At this moment, we recommend installing `PyG` with `Pip`:
181
-
```bash
182
-
pip install torch_geometric
183
-
```
184
-
177
+
You may check out the [issues](https://github.com/ai4co/rl4co/issues) and [discussions](https://github.com/ai4co/rl4co/discussions). We will also periodically post updates on the [FAQ section](https://rl4.co/docs/content/general/faq/).
The simplest way is via `pip` in editable mode with
18
+
```bash
15
19
pip install -e .
16
20
```
17
21
18
-
> Note: `conda` is also a good candidate for hassle-free installation of PyTorch: check out the [PyTorch website](https://pytorch.org/get-started/locally/) for more details.
22
+
To install optional dependencies, you may specify them as follows `pip install -e ".[dev,graph,routing,docs]"`.
23
+
24
+
We recommend installing in virtual environments with a package manager such as the blazing-fast [`uv`](https://docs.astral.sh/uv/), [`poetry`](https://python-poetry.org/), or [`conda`](https://docs.conda.io/en/latest/), with quickstart commands below:
25
+
26
+
<details>
27
+
<summary>Install with `uv`</summary>
28
+
29
+
You first need to install `uv`, i.e., with `pip`:
30
+
```bash
31
+
pip install uv
32
+
```
33
+
34
+
Then, you can create a virtual environment locally and activate it:
35
+
```bash
36
+
uv sync --frozen
37
+
source .venv/bin/activate
38
+
```
39
+
40
+
Note that `uv` directly generates the `.venv` folder in the current directory.
41
+
42
+
43
+
</details>
44
+
45
+
46
+
<details>
47
+
<summary>Install with `poetry`</summary>
48
+
49
+
Make sure that you have `poetry` installed from the [official website](https://python-poetry.org/docs/).
50
+
51
+
Then, you can create a virtual environment locally:
52
+
```bash
53
+
poetry install
54
+
poetry env activate # poetry shell removed in poetry 2.0.0
55
+
```
56
+
57
+
Note: you need to upgrade `poetry` to the latest version with `poetry self update` to versions >=2.0.0 (see [blog post](https://python-poetry.org/blog/announcing-poetry-2.0.0/)). This is also the reason why we don't need a special `pyproject.toml` anymore.
58
+
59
+
</details>
60
+
61
+
62
+
<details>
63
+
<summary>Install with `conda`</summary>
64
+
65
+
After [installing `conda`](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html), you can create a virtual environment locally with:
0 commit comments