From 8c0fb6295180cbfb94e9654aa2f993eabb53af6b Mon Sep 17 00:00:00 2001 From: Theresa Eimer Date: Tue, 4 Jun 2024 09:52:19 +0200 Subject: [PATCH 1/3] More prominent JAX GPU instructions --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index acf0f7814..610150029 100644 --- a/README.md +++ b/README.md @@ -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). From efeb600628c58927144171db5853642614b1d8e7 Mon Sep 17 00:00:00 2001 From: Theresa Eimer Date: Tue, 4 Jun 2024 10:00:40 +0200 Subject: [PATCH 2/3] Switch badges --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 610150029..f5100059e 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/)
From 604a2e932355119bb3094d5c4dcad3e7b44d3555 Mon Sep 17 00:00:00 2001 From: Theresa Eimer Date: Tue, 4 Jun 2024 10:01:06 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f5100059e..4cdf90f73 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@
-![Python](https://img.shields.io/badge/python-3.10-3776AB) +![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)