hya 0.4.0

A library of custom OmegaConf resolvers

hya

Overview

hya is a library of custom OmegaConf resolvers. hya is designed to be used with Hydra. The resolvers can be easily registered in your python project by adding the following lines:

>>> from hya import get_default_registry
>>> registry = get_default_registry()
>>> @registry.register("multiply")
... def multiply_resolver(x, y):
...     return x * y
...
>>> registry.register_resolvers()

• Documentation
• Installation
• Contributing
• API stability
• License

Installation

We highly recommend installing a virtual environment. hya can be installed from pip using the following command:

pip install hya

To make the package as slim as possible, only the minimal packages required to use hya are installed. To include all the packages, you can use the following command:

pip install hya[all]

Please check the get started page to see how to install only some specific packages or other alternatives to install the library. The following is the corresponding hya versions and tested dependencies.

hya	omegaconf	braceexpand*	numpy*	torch*	python
main	>=2.2,<3.0	>=0.1.7,<0.2.0	>=1.24,<3.0	>=2.0,<3.0	>=3.10
0.4.0	>=2.2,<3.0	>=0.1.7,<0.2.0	>=1.24,<3.0	>=2.0,<3.0	>=3.10
0.3.1	>=2.2,<3.0	>=0.1.7,<0.2.0	>=1.24,<3.0	>=2.0,<3.0	>=3.10,<3.15
0.3.0	>=2.2,<3.0	>=0.1.7,<0.2.0	>=1.24,<3.0	>=2.0,<3.0	>=3.9,<3.14
0.2.4	>=2.2,<3.0	>=0.1.7,<0.2.0	>=1.21,<3.0	>=1.11,<3.0	>=3.9,<3.14
0.2.3	>=2.1,<3.0	>=0.1.7,<0.2.0	>=1.21,<2.0	>=1.10,<3.0	>=3.9,<3.13
0.2.2	>=2.1,<3.0	>=0.1.7,<0.2.0	>=1.21,<2.0	>=1.10,<3.0	>=3.9,<3.13
0.2.1	>=2.1,<3.0	>=0.1.7,<0.2.0	>=1.21,<2.0	>=1.10,<3.0	>=3.9,<3.13
0.2.0	>=2.1,<3.0	>=0.1.7,<0.2.0	>=1.21,<2.0	>=1.10,<3.0	>=3.9,<3.13

^* indicates an optional dependency

older versions

hya	omegaconf	braceexpand*	torch*	python
0.1.3	>=2.1,<3.0	>=0.1.7,<0.2.0	>=1.10,<2.2	>=3.9,<3.13
0.1.2	>=2.1,<3.0	>=0.1.7,<0.2.0	>=1.10,<2.2	>=3.9,<3.13
0.1.1	>=2.1,<3.0	>=0.1.7,<0.2.0	>=1.10,<2.2	>=3.9,<3.12
0.1.0	>=2.1,<3.0	>=0.1.7,<0.2.0	>=1.10,<2.2	>=3.9,<3.12
0.0.14	>=2.1,<3.0	>=0.1.7,<0.2.0	>=1.10,<2.2	>=3.9,<3.12
0.0.13	>=2.1,<3.0		>=1.10,<2.1	>=3.9,<3.12
0.0.12	>=2.1,<3.0		>=1.10,<2.1	>=3.9,<3.12

Contributing

Please check the instructions in CONTRIBUTING.md.

API stability

:warning: While hya is in development stage, no API is guaranteed to be stable from one release to the next. In fact, it is very likely that the API will change multiple times before a stable 1.0.0 release. In practice, this means that upgrading hya to a new version will possibly break any code that was using the old version of hya.

License

hya is licensed under BSD 3-Clause "New" or "Revised" license available in LICENSE file.