Metadata-Version: 2.4
Name: eafig
Version: 1.0.0
Summary: Manage your hyperparameters more easily.
Project-URL: Homepage, https://github.com/MugeTong/eafig
Project-URL: Issues, https://github.com/MugeTong/eafig/issues
Author-email: MugeTong <here5320@gmail.com>
License: MIT License
        
        Copyright (c) 2026 MugeTong
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Requires-Python: >=3.12
Requires-Dist: omegaconf
Description-Content-Type: text/markdown

# Eafig

Manage your hyperparameters more easily.

## Installation

```bash
pip install eafig
```

## Quick Start

```python
from eafig import Eafig, register_root, register_config

@register_root
class MyConfig:
    a: int
    c: float = 1.0

@register_config(name="sub_config", frozen=True)
class MySubConfig:
    x: float = 1.0
    y: str = "sub_default"

# Load config from a file or command line arguments
# The function call order decides the parmeter loading priority,
# with later calls having higher priority.
Eafig.load("config/default.yaml")
Eafig.from_cli()

# Create a config instance using the loaded config
config_instance = MyConfig(a=5)
sub_config_instance = MySubConfig()
print("full config:", Eafig._get_full_config())

# Save the current config to a file
Eafig.save("config/saved_config.yaml")
```
