<img src="https://raw.githubusercontent.com/catalyst-team/hydra-slayer/master/docs/_static/slayer.png" width="198" align="right">
# Hydra Slayer
[](https://github.com/catalyst-team/hydra-slayer/actions/workflows/build.yml)
[](https://pypi.org/project/hydra-slayer/)
[](https://pypi.org/project/hydra-slayer/)
[](LICENSE)
[](https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw)
**Hydra Slayer** is a 4th level spell in the School of Fire Magic.
Depending of the level of expertise in fire magic,
slayer spell increases attack of target troop by 8 against
behemoths, dragons, hydras, and other creatures.
What is more, it also allows configuring of complex applications just by config and few lines of code.
---
## Installation
Using pip you can easily install the latest release version [PyPI](https://pypi.org/):
```sh
pip install hydra-slayer
```
## Example
```yaml title="dataset.yaml"
dataset:
_target_: torchvision.datasets.CIFAR100
root: ./data
train: false
download: true
```
```python title="run.py"
import hydra_slayer
import yaml
with open("dataset.yaml") as stream:
raw_config = yaml.safe_load(stream)
config = hydra_slayer.get_from_params(**raw_config)
config["dataset"]
# Dataset CIFAR100
# Number of datapoints: 10000
# Root location: ./data
# Split: Test
```
Please check [documentation](https://catalyst-team.github.io/hydra-slayer/master/pages/examples) for more examples.
## Documentation
Full documentation for the project is available at https://catalyst-team.github.io/hydra-slayer
## Communication
- GitHub Issues: Bug reports, feature requests, install issues, RFCs, thoughts, etc.
- Slack: The [Catalyst Slack](https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw) hosts a primary audience of moderate to experienced Hydra-Slayer (and Catalyst) users and developers for general chat, online discussions, collaboration, etc.
- Email: Feel free to use [feedback@catalyst-team.com](mailto:feedback@catalyst-team.com) as an additional channel for feedback.
## Citation
Please use this bibtex if you want to cite this repository in your publications:
@misc{catalyst,
author = {Sergey Kolesnikov and Yauheni Kachan},
title = {Hydra-Slayer},
year = {2021},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/catalyst-team/hydra-slayer}},
}
Raw data
{
"_id": null,
"home_page": "https://catalyst-team.github.io/hydra-slayer/",
"name": "hydra-slayer",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "distributed computing",
"author": "Sergey Kolesnikov",
"author_email": "scitator@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/eb/f3/1cc8c6243c054a6c99d6bbd351e04b63229f8ccb624329e9c959991b8ef3/hydra_slayer-0.5.0.tar.gz",
"platform": null,
"description": "<img src=\"https://raw.githubusercontent.com/catalyst-team/hydra-slayer/master/docs/_static/slayer.png\" width=\"198\" align=\"right\">\n\n# Hydra Slayer\n\n[](https://github.com/catalyst-team/hydra-slayer/actions/workflows/build.yml)\n[](https://pypi.org/project/hydra-slayer/)\n[](https://pypi.org/project/hydra-slayer/)\n[](LICENSE)\n[](https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw)\n\n**Hydra Slayer** is a 4th level spell in the School of Fire Magic.\nDepending of the level of expertise in fire magic,\nslayer spell increases attack of target troop by 8 against\nbehemoths, dragons, hydras, and other creatures.\n\nWhat is more, it also allows configuring of complex applications just by config and few lines of code.\n\n---\n\n## Installation\nUsing pip you can easily install the latest release version [PyPI](https://pypi.org/):\n\n```sh\npip install hydra-slayer\n```\n\n## Example\n```yaml title=\"dataset.yaml\"\ndataset:\n _target_: torchvision.datasets.CIFAR100\n root: ./data\n train: false\n download: true\n```\n\n```python title=\"run.py\"\nimport hydra_slayer\nimport yaml\n\nwith open(\"dataset.yaml\") as stream:\n raw_config = yaml.safe_load(stream)\n\nconfig = hydra_slayer.get_from_params(**raw_config)\nconfig[\"dataset\"]\n# Dataset CIFAR100\n# Number of datapoints: 10000\n# Root location: ./data\n# Split: Test\n```\n\nPlease check [documentation](https://catalyst-team.github.io/hydra-slayer/master/pages/examples) for more examples.\n\n## Documentation\nFull documentation for the project is available at https://catalyst-team.github.io/hydra-slayer\n\n## Communication\n- GitHub Issues: Bug reports, feature requests, install issues, RFCs, thoughts, etc.\n- Slack: The [Catalyst Slack](https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw) hosts a primary audience of moderate to experienced Hydra-Slayer (and Catalyst) users and developers for general chat, online discussions, collaboration, etc.\n- Email: Feel free to use [feedback@catalyst-team.com](mailto:feedback@catalyst-team.com) as an additional channel for feedback.\n\n## Citation\nPlease use this bibtex if you want to cite this repository in your publications:\n\n @misc{catalyst,\n author = {Sergey Kolesnikov and Yauheni Kachan},\n title = {Hydra-Slayer},\n year = {2021},\n publisher = {GitHub},\n journal = {GitHub repository},\n howpublished = {\\url{https://github.com/catalyst-team/hydra-slayer}},\n }\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A framework for elegantly configuring complex applications",
"version": "0.5.0",
"project_urls": {
"Documentation": "https://catalyst-team.github.io/hydra-slayer/",
"Homepage": "https://catalyst-team.github.io/hydra-slayer/",
"Repository": "https://github.com/catalyst-team/hydra-slayer"
},
"split_keywords": [
"distributed",
"computing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "85dd9cab28f4b5e715b3235fc16fdba686ebeca91280fd69a0ebdde5ba992106",
"md5": "cb7a6a12f42688d1f345a2b35633d44a",
"sha256": "cd4837a66c791c186a0ffb037a48589af7fc6b8c7a4248f16b5ace4a2907bd0d"
},
"downloads": -1,
"filename": "hydra_slayer-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cb7a6a12f42688d1f345a2b35633d44a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 13662,
"upload_time": "2024-01-04T21:13:49",
"upload_time_iso_8601": "2024-01-04T21:13:49.445981Z",
"url": "https://files.pythonhosted.org/packages/85/dd/9cab28f4b5e715b3235fc16fdba686ebeca91280fd69a0ebdde5ba992106/hydra_slayer-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ebf31cc8c6243c054a6c99d6bbd351e04b63229f8ccb624329e9c959991b8ef3",
"md5": "973dd2c518740352ea0d88ef17e0bcff",
"sha256": "d7b4b9acbf1df3f387bb9692b7cf233b0eb5a3e430dddfa754af2c841bda2a01"
},
"downloads": -1,
"filename": "hydra_slayer-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "973dd2c518740352ea0d88ef17e0bcff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 13144,
"upload_time": "2024-01-04T21:13:50",
"upload_time_iso_8601": "2024-01-04T21:13:50.947808Z",
"url": "https://files.pythonhosted.org/packages/eb/f3/1cc8c6243c054a6c99d6bbd351e04b63229f8ccb624329e9c959991b8ef3/hydra_slayer-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-04 21:13:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "catalyst-team",
"github_project": "hydra-slayer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hydra-slayer"
}
JSON
