Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 2.81 KB

README.md

File metadata and controls

60 lines (41 loc) · 2.81 KB

mathy_envs: Learning environments for solving math problems

Build Types codecov Pypi version Code style: black

Mathy environments present users/agents with a prompt problem, and are asked to simplify it according to some problem-specific criteria using combinations of simple actions based on the Properties of Numbers.

🚀 Quickstart

You can install mathy_envs from pip:

pip install mathy_envs

Semantic Versioning

Mathy Envs tries to be predictable when it comes to breaking changes, so the project uses semantic versioning to help users avoid breakage.

Specifically, new releases increase the patch semver component for new features and fixes, and the minor component when there are breaking changes. If you don't know much about semver strings, they're usually formatted {major}.{minor}.{patch} so increasing the patch component means incrementing the last number.

Consider a few examples:

From Version To Version Changes are Breaking
0.2.0 0.2.1 No
0.3.2 0.3.6 No
0.3.1 0.3.17 No
0.2.2 0.3.0 Yes

If you are concerned about breaking changes, you can pin the version in your requirements so that it does not go beyond the current semver minor component, for example if the current version was 0.1.37:

mathy_envs>=0.1.37,<0.2.0

Contributors

Mathy Envs wouldn't be possible without the wonderful contributions of the following people:


Justin DuJardin

Guillem Duran Ballester

This project follows the all-contributors specification. Contributions of any kind welcome!