Metadata-Version: 2.4
Name: sparkwheel
Version: 0.0.3
Summary: A powerful YAML-based configuration system with references, expressions, and dynamic instantiation
Keywords: configuration,yaml,config,deep-learning,machine-learning
Author: Project Lighter
Author-email: Project Lighter <noreply@lighter.com>
License-Expression: Apache-2.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Dist: pyyaml>=6.0
Requires-Python: >=3.10
Project-URL: Documentation, https://project-lighter.github.io/sparkwheel
Project-URL: Homepage, https://github.com/project-lighter/sparkwheel
Project-URL: Issues, https://github.com/project-lighter/sparkwheel/issues
Project-URL: Repository, https://github.com/project-lighter/sparkwheel
Description-Content-Type: text/markdown

<br/>
<div align="center">
  <img src="assets/images/sparkwheel_banner.png" width="65%"/>
</div>
<br/><br/>
<p align="center">
  <a href="https://github.com/project-lighter/sparkwheel/actions"><img alt="Tests" src="https://github.com/project-lighter/sparkwheel/workflows/Tests/badge.svg"></a>
  <a href="https://github.com/project-lighter/sparkwheel/actions"><img alt="Code quality" src="https://github.com/project-lighter/sparkwheel/workflows/Code%20quality/badge.svg"></a>
  <a href="https://pypi.org/project/sparkwheel/"><img alt="PyPI" src="https://img.shields.io/pypi/v/sparkwheel"></a>
  <a href="https://project-lighter.github.io/sparkwheel"><img alt="Documentation" src="https://img.shields.io/badge/docs-latest-blue"></a>
  <a href="https://github.com/project-lighter/sparkwheel/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
</p>
<br/>

<p align="center">⚙️ YAML configuration meets Python 🐍</p>
<br/>


## 📖 Getting Started
<div align="center">
<p style="text-align: center;">
  📚 <a href="https://project-lighter.github.io/sparkwheel/"> Documentation</a>&nbsp;&nbsp;&nbsp;
  🎥 <a href="https://www.youtube.com/channel/UCef1oTpv2QEBrD2pZtrdk1Q">YouTube Channel</a>&nbsp;&nbsp;&nbsp;
  👾 <a href="https://discord.gg/zJcnp6KrUp">Discord Server</a>
</p>
</div>

### Installation
<pre><code>pip install sparkwheel</code></pre>


### Development
To contribute, clone the repository and follow the steps in [CONTRIBUTING.md](CONTRIBUTING.md) to set up your environment and run quality checks.


## About

Sparkwheel is a hard fork of [MONAI](https://github.com/Project-MONAI/MONAI)'s configuration system, stripped down to focus and improve its usability for general purposes. We're deeply grateful to the MONAI team for their excellent foundation.

Sparkwheel powers [Lighter](https://project-lighter.github.io/lighter/), our config-based deep learning framework built on PyTorch Lightning. 

