Skip to content

Release 0.1.2: fix PyPI package name in README #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cool-RR merged 4 commits into from
Mar 25, 2026
Merged

Release 0.1.2: fix PyPI package name in README #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
85853d2
Fix README: use highjax-rl as PyPI package name
cool-RR Mar 25, 2026
13f9644
Bump version to 0.1.2
cool-RR Mar 25, 2026
d684727
Add trimmed demo gif for PyPI readme rendering
cool-RR Mar 25, 2026
17df700
Add gif demo for PyPI, readme-replacements config, bump to 0.1.3
cool-RR Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Binary file added misc/videos/demo.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 6 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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*"]
Expand Down
Loading