https://github.com/durandtibo/hya
A library of custom OmegaConf resolvers
https://github.com/durandtibo/hya
hydra omegaconf python resolver
Last synced: about 2 months ago
JSON representation
A library of custom OmegaConf resolvers
- Host: GitHub
- URL: https://github.com/durandtibo/hya
- Owner: durandtibo
- License: bsd-3-clause
- Created: 2023-01-07T01:06:03.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T08:05:09.000Z (7 months ago)
- Last Synced: 2024-10-29T21:31:05.372Z (7 months ago)
- Topics: hydra, omegaconf, python, resolver
- Language: Python
- Homepage: https://durandtibo.github.io/hya/
- Size: 2.12 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# hya
/badge.svg)
/badge.svg)
## Overview
`hya` is a library of custom [OmegaConf](https://github.com/omry/omegaconf) resolvers.
`hya` is designed to be used with [Hydra](https://github.com/facebookresearch/hydra).
The resolvers can be easily registered in your python project by adding the following lines:
```python
from hya import register_resolvers
register_resolvers()
```
- [Documentation](https://durandtibo.github.io/hya/)
- [Installation](#installation)
- [Contributing](#contributing)
- [API stability](#api-stability)
- [License](#license)
## Installation
We highly recommend installing
a [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).
`hya` can be installed from pip using the following command:
```shell
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:
```shell
pip install hya[all]
```
Please check the [get started page](https://durandtibo.github.io/hya/get_started) 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.21,<3.0` | `>=1.11,<3.0` | `>=3.9,<3.13` |
| `0.2.4` | `>=2.2,<3.0` | `>=0.1.7,<0.2.0` | `>=1.21,<3.0` | `>=1.11,<3.0` | `>=3.9,<3.13` |
| `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](.github/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](LICENSE)
file.