diff --git a/README.md b/README.md index 4330b52..3b421ae 100644 --- a/README.md +++ b/README.md @@ -8,17 +8,21 @@ This repository manages the Python interface for the Animal-AI environment. The main project repository is located [here](https://github.com/Kinds-of-Intelligence-CFI/animal-ai). -* **Website:** [https://www.animalai.org](https://animalai.org/) -* **Documentation:** [https://animalai.org/doc](https://github.com/Kinds-of-Intelligence-CFI/animal-ai/tree/main/docs) -* **Unity Source code:** [https://github.com/Kinds-of-Intelligence-CFI/animal-ai-unity-project](https://github.com/Kinds-of-Intelligence-CFI/animal-ai-unity-project) -* **Python Source code:** [https://github.com/Kinds-of-Intelligence-CFI/animal-ai-python](https://github.com/Kinds-of-Intelligence-CFI/animal-ai-python) -* **Bug reports:** [https://github.com/Kinds-of-Intelligence-CFI/animal-ai/issues](https://github.com/Kinds-of-Intelligence-CFI/animal-ai/issues) +* **Website:** [here](https://sites.google.com/csah.cam.ac.uk/animalai/) +* **Unity Source code:** [here](https://github.com/Kinds-of-Intelligence-CFI/animal-ai-unity-project) +* **Python Source code:** [here](https://github.com/Kinds-of-Intelligence-CFI/animal-ai-python) +* **Bug reports:** [here](https://github.com/Kinds-of-Intelligence-CFI/animal-ai/issues) For more information about the ways you can contribute to Animal-AI, visit our website. If you’re unsure where to start or how your skills fit in, reach out! You can ask on GitHub, by opening a new issue or leaving a comment on a relevant issue that is already open. If you are new to contributing to open source, [this](https://github.com/Kinds-of-Intelligence-CFI/animal-ai/blob/main/CONTRIBUTING.md) guide helps explain why, what, and how to successfully get involved. ## Version History +* v5.0.0 +**Note: Version 5.0.0 is not backward compatible with previous versions of Animal-AI due to breaking changes.** + + Minimum Python version is now `3.10.0 (<3.10.13)` (breaking change). + + Upgraded to ml-agents-ml-env `1.0.0`. + + Adds no graphics monitor support. * v4.1.0 + Updated `RaycastParser` to accept new object: - `HollowBox`. @@ -29,11 +33,11 @@ If you are new to contributing to open source, [this](https://github.com/Kinds-o + Updated RaycastParser to accept two new objects: - `DecoyGoal` and `DecoyGoalBounce`. * v4.0.0 +**Note: Version 4.0.0 is not backward compatible with previous versions of Animal-AI due to breaking changes.** + Only implements _`mlagents 0.30.0`_ package to avoid dependency issues; also reduces package size considerably. + Cleaned up package and removed redundant files. + Implemented tests for the package. + Added documentation for the package. -**Note: Version 4.0.0 is not backward compatible with previous versions of Animal-AI due to the significance of the changes made.** * v3.0.5 + Removed redundant packages in `setup.py`. + Added download stats. diff --git a/animalai/raycastparser.py b/animalai/raycastparser.py index 020d02b..49a3e6b 100644 --- a/animalai/raycastparser.py +++ b/animalai/raycastparser.py @@ -24,11 +24,13 @@ class RayCastObjects(enum.Enum): DEATHZONE = 7 HOTZONE = 8 RAMP = 9 - PILLARBUTTON = 10 - SIGNPOSTER = 11 + SPAWNERBUTTON = 10 + SIGNBOARD = 11 DECOYGOAL = 12 DECOYGOALBOUNCE = 13 HOLLOWBOX = 14 + BADGOALMULTI = 15 + DATAZONE = 16 class RayCastParser: diff --git a/pyproject.toml b/pyproject.toml index ca8a27d..d46e88f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,7 @@ [project] name = "animalai" -version = "4.1.0" -description = "Animal AI Python API" +version = "5.0.0" +description = "Animal-AI Python API" license = "MIT" readme = "README.md" authors = [ @@ -18,18 +18,15 @@ classifiers = [ "Intended Audience :: Science/Research", "Topic :: Scientific/Engineering :: Artificial Intelligence", "License :: OSI Approved :: Apache Software License", - "Programming Language :: Python :: 3.6", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", "Operating System :: Microsoft :: Windows :: Windows 10", "Operating System :: Microsoft :: Windows :: Windows 11", "Operating System :: MacOS :: MacOS X", "Operating System :: POSIX :: Linux", ] -requires-python = ">=3.8, <3.10" +requires-python = ">=3.10.12, <3.10.13" dependencies = [ - "mlagents_envs==0.30.0", + "mlagents_envs>=1.0.0", "numpy", "protobuf==3.20.3", ] diff --git a/test/README.md b/tests/README.md similarity index 100% rename from test/README.md rename to tests/README.md diff --git a/test/__init__.py b/tests/__init__.py similarity index 100% rename from test/__init__.py rename to tests/__init__.py diff --git a/test/braitenberg.py b/tests/braitenberg.py similarity index 100% rename from test/braitenberg.py rename to tests/braitenberg.py diff --git a/test/play.py b/tests/play.py similarity index 100% rename from test/play.py rename to tests/play.py diff --git a/test/randomActionAgent.py b/tests/randomActionAgent.py similarity index 100% rename from test/randomActionAgent.py rename to tests/randomActionAgent.py diff --git a/test/test-Configs/exampleArena.yml b/tests/test-Configs/exampleArena.yml similarity index 100% rename from test/test-Configs/exampleArena.yml rename to tests/test-Configs/exampleArena.yml diff --git a/test/test-actions.py b/tests/test-actions.py similarity index 100% rename from test/test-actions.py rename to tests/test-actions.py diff --git a/test/test-environment.py b/tests/test-environment.py similarity index 100% rename from test/test-environment.py rename to tests/test-environment.py diff --git a/test/test-manual-play.py b/tests/test-manual-play.py similarity index 100% rename from test/test-manual-play.py rename to tests/test-manual-play.py diff --git a/test/test-raycastparser.py b/tests/test-raycastparser.py similarity index 100% rename from test/test-raycastparser.py rename to tests/test-raycastparser.py