diff --git a/README.md b/README.md index acf0f7814..4cdf90f73 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,10 @@
+![Python](https://img.shields.io/badge/Python-3.10-3776AB) +![License](https://img.shields.io/badge/License-BSD3-orange) [![Test](https://github.com/automl/arlbench/actions/workflows/pytest.yaml/badge.svg)](https://github.com/automl/arlbench/actions/workflows/pytest.yaml) [![Doc Status](https://github.com/automl/arlbench/actions/workflows/docs.yaml/badge.svg)](https://github.com/automl/arlbench/actions/workflows/docs.yaml) -[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) -[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
@@ -54,6 +54,9 @@ conda create -n arlbench python=3.10 conda activate arlbench ``` +The instructions below will help you install the default version of ARLBench with the CPU version of JAX. +If you want to run the ARLBench on GPU, we recommend you check out the [JAX installation guide](https://jax.readthedocs.io/en/latest/installation.html) to see how you can install the correct version for your GPU setup before proceeding. +
PyPI You can install ARLBench using `pip`: @@ -92,8 +95,6 @@ make install-envpool > [!CAUTION] > Windows is currently not supported and also not tested. We recommend using the [Linux subsytem](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux) if you're on a Windows machine. -If you want to run the ARLBench on GPU, we recommend you check out the [JAX installation guide](https://jax.readthedocs.io/en/latest/installation.html) to see how you can install the correct version for your GPU setup. - ## Quickstart Here are the two ways you can use ARLBench: via the command line or as an environment. To see them in action, take a look at our [examples](https://github.com/automl/arlbench/tree/main/examples).