From e57514d828e5cb9cc9ee6eb7a1daa21f9a005222 Mon Sep 17 00:00:00 2001 From: Eduardo Pignatelli Date: Tue, 19 Dec 2023 13:02:29 +0000 Subject: [PATCH] Align to rename helx to helx-base --- .github/workflows/CD.yml | 4 ++-- .github/workflows/CI.yml | 2 +- README.md | 8 ++++---- {helx => helx_base}/__init__.py | 0 {helx => helx_base}/_version.py | 0 {helx => helx_base}/config.py | 0 {helx => helx_base}/image.py | 0 {helx => helx_base}/mdp.py | 0 {helx => helx_base}/modules.py | 0 {helx => helx_base}/spaces.py | 0 pyproject.toml | 12 ++++++------ 11 files changed, 13 insertions(+), 13 deletions(-) rename {helx => helx_base}/__init__.py (100%) rename {helx => helx_base}/_version.py (100%) rename {helx => helx_base}/config.py (100%) rename {helx => helx_base}/image.py (100%) rename {helx => helx_base}/mdp.py (100%) rename {helx => helx_base}/modules.py (100%) rename {helx => helx_base}/spaces.py (100%) diff --git a/.github/workflows/CD.yml b/.github/workflows/CD.yml index 2182a04..626db57 100644 --- a/.github/workflows/CD.yml +++ b/.github/workflows/CD.yml @@ -16,8 +16,8 @@ jobs: - name: Get version from file run: | - VERSION_FILE="$/helx/_version.py" - HELX_VERSION="$(cat helx/_version.py | grep '__version__ = ' | cut -d'=' -f2 | sed 's,\",,g' | sed "s,\',,g" | sed 's, ,,g')" + VERSION_FILE="$/helx_base/_version.py" + HELX_VERSION="$(cat helx_base/_version.py | grep '__version__ = ' | cut -d'=' -f2 | sed 's,\",,g' | sed "s,\',,g" | sed 's, ,,g')" echo "Current version is:" echo "$HELX_VERSION" diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index c919d62..ceffe62 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -34,7 +34,7 @@ jobs: echo "$MESSAGE" - name: Run unit tests with pytest run: | - python -c 'import helx' + python -c 'import helx_base' Compliance: runs-on: ubuntu-latest diff --git a/README.md b/README.md index 1be1b09..2feadaa 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,10 @@ HELX is a JAX-based ecosystem that provides a standardised and ready to use framework to run Reinforcement Learning experiments. The ecosystem is made of three main nodes: -- [Helx](https://github.com/epignatelli/helx), containing the base objects of the framework -- [Agentx](https://github.com/epignatelli/agentx), containing the most common RL baselines -- [Envx](https://github.com/epignatelli/envx), which provides a single API to the most common RL environments (gym, gymnax, dm_env, atari, ...) -- [Expx](https://github.com/epignatelli/expx), which packs the other three nodes into a framework to run and manage experiments +- [HELX-base](https://github.com/epignatelli/helx), containing the base objects of the framework +- [HELX-agents](https://github.com/epignatelli/agentx), containing the most common RL baselines +- [HELX-envs](https://github.com/epignatelli/envx), which provides a single API to the most common RL environments (gym, gymnax, dm_env, atari, ...) +- Finally, [HELX](https://github.com/epignatelli/expx), which packs the other three nodes into a framework to run and manage experiments ## Installation diff --git a/helx/__init__.py b/helx_base/__init__.py similarity index 100% rename from helx/__init__.py rename to helx_base/__init__.py diff --git a/helx/_version.py b/helx_base/_version.py similarity index 100% rename from helx/_version.py rename to helx_base/_version.py diff --git a/helx/config.py b/helx_base/config.py similarity index 100% rename from helx/config.py rename to helx_base/config.py diff --git a/helx/image.py b/helx_base/image.py similarity index 100% rename from helx/image.py rename to helx_base/image.py diff --git a/helx/mdp.py b/helx_base/mdp.py similarity index 100% rename from helx/mdp.py rename to helx_base/mdp.py diff --git a/helx/modules.py b/helx_base/modules.py similarity index 100% rename from helx/modules.py rename to helx_base/modules.py diff --git a/helx/spaces.py b/helx_base/spaces.py similarity index 100% rename from helx/spaces.py rename to helx_base/spaces.py diff --git a/pyproject.toml b/pyproject.toml index 19a7e8c..19d58d1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta" requires = ["setuptools >= 50", "setuptools-scm[toml]>=6.2", "wheel"] [project] -name = "Helx" +name = "HELX-base" dynamic = ["version", "dependencies"] description = "Interoperate among reinforcement learning libraries with jax, pytorch, gym and dm_env" requires-python = ">=3.8" @@ -52,18 +52,18 @@ classifiers = [ [project.urls] -homepage = "https://github.com/epignatelli/helx" -repository = "https://github.com/epignatelli/helx" -bug_tracker = "https://github.com/epignatelli/helx/issues" +homepage = "https://github.com/epignatelli/helx-base" +repository = "https://github.com/epignatelli/helx-base" +bug_tracker = "https://github.com/epignatelli/helx-base/issues" [tool.setuptools.dynamic] -version = {attr = "helx._version.__version__"} +version = {attr = "helx_base._version.__version__"} dependencies = {file = "./requirements.txt"} [tool.setuptools.packages.find] -include = ["helx*"] +include = ["helx_base*"] exclude = ["test", "examples"]