hyfi
HyFI: Hydra Fast Interface (Hydra and Pydantic based interface framework)
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 6 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.7%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
HyFI: Hydra Fast Interface (Hydra and Pydantic based interface framework)
Basic Info
- Host: GitHub
- Owner: entelecheia
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://hyfi.entelecheia.ai/
- Size: 16.4 MB
Statistics
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 9
- Releases: 0
Topics
Metadata Files
README.md
HyFI: Hydra Fast Interface
HyFI, short for Hydra Fast Interface, is a powerful Python framework built atop the foundations of Hydra and Pydantic. Its main objective is to provide a streamlined interface for configuring, structuring, executing, and scaling Python applications and workflows.
Overview
In the modern world of software and data science, creating scalable, reproducible, and modular Python workflows is vital. HyFI is here to make that process not just feasible but also efficient and straightforward. It has been meticulously crafted to help developers and researchers build pipeline-oriented projects and promote shareable and reproducible workflows.
Core Features
1. Dynamic Configuration Management
- Modular Configuration: Harness the power of Hydra and Pydantic to manage your application configurations dynamically and modularity.
- Seamless Command Line Overrides: Experiment swiftly without the clutter of multiple similar configuration files.
- Jupyter Notebook Integration: The HyFI class allows for easy composition of configurations even in a jupyter notebook setting.
2. Zero Boilerplate
Stay focused on your core problems. HyFI takes care of the usual overheads such as command line flags, loading configuration files, and logging.
3. Structured Workflows
Configurable Automated Processes: Divide your research into unit jobs or tasks, and then bundle them into workflows.
Versatility: Have the liberty to create multiple workflows, with each performing varied sets of tasks.
4. Reproducibility and Sharing
Sharing Capability: Share your datasets, models, and configurations effortlessly.
Reproducibility: Sharing configurations alongside datasets and models ensures that every piece of research can be replicated.
Granular or Holistic: Choose to share individual unit jobs or an entire workflow, as per your need.
5. Support for Plugins
- Integration of HyFI-based Applications: Enhance your project by plugging in several HyFI-based applications. This allows you to leverage the functionalities of plugins along with their specific configuration files.
- Modular Design Enablement: The plugin support fosters a truly modular design approach, enabling seamless integration of various components and features, thereby promoting greater flexibility and extensibility in your projects.
Other Noteworthy Features:
- Workspace Management: Automatic workspace creation and environment variable management.
- Task Pipelining: Chain and parallelize jobs and steps seamlessly.
- Optimized Parallelism: Efficient job batching with the help of Joblib.
- Dotenv Integration: Manage configurations via .env files with ease.
- Built-in Commands: Simplify processes like initializing projects, running pipelines, and copying files.
- Extensibility: Easily extend HyFI's capabilities by crafting new Config classes and utilizing the building blocks it offers.
- Command Line Interface (CLI): Access a suite of commands and workflows directly from the command line.
- Advanced Logging: Make use of the integrated logging configurations, complemented by Hydra logging.
- Robust Caching: Cache both files and data efficiently.
Citation
tex
@software{lee_2023_8247719,
author = {Young Joon Lee},
title = {HyFI: Hydra Fast Interface},
month = aug,
year = 2023,
publisher = {Zenodo},
doi = {10.5281/zenodo.8247719},
url = {https://doi.org/10.5281/zenodo.8247719}
}
tex
@software{lee_2023_hyfi,
author = {Young Joon Lee},
title = {HyFI: Hydra Fast Interface},
year = 2023,
publisher = {GitHub},
url = {https://github.com/entelecheia/hyfi}
}
Changelog
See the CHANGELOG for more information.
Contributing
Contributions are welcome! Please see the contributing guidelines for more information.
License
This project is released under the MIT License.
Owner
- Name: Young Joon Lee
- Login: entelecheia
- Kind: user
- Location: Jeju, South Korea
- Company: Cheju Halla University
- Website: https://entelecheia.me
- Repositories: 12
- Profile: https://github.com/entelecheia
Professor at Cheju Halla University
Citation (CITATION.cff)
cff-version: 1.1.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Lee
given-names: Young Joon
orcid: https://orcid.org/0000-0002-4349-5926
title: "HyFI: Hydra Fast Interface"
version: v1.29.6
date-released: 2023-08-14
GitHub Events
Total
- Release event: 1
- Watch event: 1
- Delete event: 43
- Issue comment event: 87
- Push event: 57
- Pull request event: 82
- Pull request review event: 24
- Create event: 41
Last Year
- Release event: 1
- Watch event: 1
- Delete event: 43
- Issue comment event: 87
- Push event: 57
- Pull request event: 82
- Pull request review event: 24
- Create event: 41
Committers
Last synced: over 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| Young Joon Lee | e****a@h****m | 1,953 |
| semantic-release | s****e | 173 |
| dependabot[bot] | 4****] | 119 |
| github-actions | g****s@g****m | 10 |
| Sourcery AI | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 18
- Total pull requests: 421
- Average time to close issues: 5 days
- Average time to close pull requests: 3 days
- Total issue authors: 1
- Total pull request authors: 3
- Average comments per issue: 0.06
- Average comments per pull request: 1.49
- Merged pull requests: 350
- Bot issues: 0
- Bot pull requests: 311
Past Year
- Issues: 0
- Pull requests: 88
- Average time to close issues: N/A
- Average time to close pull requests: 3 days
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 1.83
- Merged pull requests: 71
- Bot issues: 0
- Bot pull requests: 84
Top Authors
Issue Authors
- entelecheia (18)
Pull Request Authors
- dependabot[bot] (303)
- entelecheia (110)
- sourcery-ai[bot] (8)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 400 last-month
- Total dependent packages: 27
- Total dependent repositories: 3
- Total versions: 177
- Total maintainers: 1
pypi.org: hyfi
Hydra Fast Interface (Hydra and Pydantic based interface framework)
- Homepage: https://hyfi.entelecheia.ai
- Documentation: https://hyfi.readthedocs.io/
- License: MIT
-
Latest release: 1.37.0
published over 1 year ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v3 composite
- actions/setup-python v4 composite
- peaceiris/actions-gh-pages v3 composite
- MishaKav/pytest-coverage-comment main composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/checkout v3 composite
- relekang/python-semantic-release master composite
- actions/checkout v3 composite
- relekang/python-semantic-release master composite
- actions/checkout v3 composite
- relekang/python-semantic-release master composite
- actions/checkout v3 composite
- relekang/python-semantic-release master composite
- actions/checkout v3 composite
- relekang/python-semantic-release master composite
- 122 dependencies
- cached-path ^1.3.3
- chardet <=4.0.0
- gdown <=4.4.0
- hydra-colorlog ^1.2.0
- hydra-core ^1.3.2
- ipython <=7.9.0
- ipython-autotime ^0.3.1
- matplotlib <=3.5.3
- numpy <1.24
- pandas <1.4.0
- pydantic <=1.10.5
- pygments <=2.6.1
- python ^3.8.1, <3.12
- python-dotenv ^1.0.0
- requests <=2.25.1
- scipy <=1.8
- tqdm ^4.64.1
- github/issue-metrics v2 composite
- peter-evans/create-issue-from-file v4 composite
- markdown-include *
- mkdocs *
- mkdocs-click *
- mkdocs-include-dir-to-nav *
- mkdocs-include-markdown-plugin *
- mkdocs-material *
- mkdocs-material-extensions >=1.1
- mkdocstrings *
- pymdown-extensions >=9.9.1