Skip to content

Commit

Permalink
installation in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TheEimer committed May 30, 2024
1 parent 4d4a074 commit db37924
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 8 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,13 @@ The ARLBench is a benchmark for HPO in RL - evaluate your HPO methods fast and o

## Installation

There are currently two different ways to install ARLBench:
There are currently two different ways to install ARLBench.
Whichever you choose, we recommend to create a virtual environment for the installation:

```bash
conda create -n arlbench python=3.10
conda activate arlbench
```

<details>
<summary>PyPI</summary>
Expand All @@ -66,11 +72,6 @@ git clone git@github.com:automl/arlbench.git
cd arlbench
```

We recommend to create a virtual environment for the installation:
```bash
conda create -n arlbench python=3.10
```

Then you can install the benchmark. For the base version, use:
```bash
make install
Expand Down
37 changes: 35 additions & 2 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,39 @@
Installation
============

.. warning::
There are two ways you can install ARLBench: PyPI and GitHub. The first one is the simplest way to install ARLBench, while the second one is the best way to install the latest version of ARLBench.
Either way, you will likely want to first create a virtual environment to install ARLBench into. This can be done by running the following command:

This page is under construction.
.. code-block:: bash
conda create -n arlbench python=3.10
conda activate arlbench
1. Using PyPI

This is the simplest way to install ARLBench. Just run the following command:

.. code-block:: bash
pip install arlbench
2. Downloading from GitHub

This is the best way to install the latest version of ARLBench. First, clone the repository:

.. code-block:: bash
git clone git@github.com:automl/arlbench.git
cd arlbench
Then, install the package:

.. code-block:: bash
make install
If you are on a Linux system and would like to use envpool environments, you can instead use:

.. code-block:: bash
make install-envpool

0 comments on commit db37924

Please sign in to comment.