diff --git a/README.md b/README.md index 55a5ef6..eb5a7ab 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,10 @@ HighJax was produced as part of our research project about [BXRL:Behavior-Explai ## Installation ```bash -pip install highjax # Minimal installation -pip install "highjax[cuda12]" # Including GPU support -pip install "highjax[trainer]" # Including PPO implementation -pip install "highjax[cuda12,trainer]" # Including both +pip install highjax-rl # Minimal installation +pip install "highjax-rl[cuda12]" # Including GPU support +pip install "highjax-rl[trainer]" # Including PPO implementation +pip install "highjax-rl[cuda12,trainer]" # Including both ``` ## Quick Start diff --git a/misc/videos/demo.gif b/misc/videos/demo.gif new file mode 100644 index 0000000..0942c32 Binary files /dev/null and b/misc/videos/demo.gif differ diff --git a/pyproject.toml b/pyproject.toml index 447782e..c0f5a7e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "highjax-rl" -version = "0.1.1" +version = "0.1.3" description = "HighJax: A JAX implementation of the HighwayEnv driving environment" readme = "README.md" license = "MIT" @@ -66,6 +66,11 @@ highjax_trainer = "highjax_trainer:cli" [tool.setuptools.package-data] highjax = ["behaviors/*.json"] +[tool.release-pypi] +readme-replacements = [ + ["demo.webp", "demo.gif"], +] + [tool.setuptools.packages.find] where = ["."] include = ["highjax*"]