An HParams implementation with argparse.
Project description
Argparse HParams
A simple argument parser for hyper-parameters.
Installation
From PyPI:
pip install argparse-hparams
From Github:
pip install git+https://github.com/enhuiz/argparse-hparams.git
Example
from argparse_hparams import dataclass, HParams, Annotated, Flag
@dataclass
class HParamsTest(HParams):
# This will call: parser.add_argument(type=int, default=0)
x: int = 0
# You may annotate custom data for parser.add_argument(...).
# The annotated default will overwrite dataclass default
# This will call: parser.add_argument(type=str.upper, default='bad')
y: Annotated[str, dict(type=str.upper, default="bad")] = "good"
# This will call: parser.add_argument(type=int, nargs=2, default=(2, 3))
pair: Annotated[tuple[int, int], dict(type=int, nargs=2)] = (2, 3)
# This will call: parser.add_argument(action="store_true", default=False)
ok: Flag = False
# when positional is set, the argument is a positional argument
pos: Annotated[str, dict(positional=True)] = ""
if __name__ == "__main__":
test = HParamsTest()
test.show()
$ python example.py
usage: example.py [-h] [--x int] [--y upper] [--pair int int] [--ok] [--default Path] str
example.py: error: the following arguments are required: pos
$ python example.py 123
┌────────────┐
│ HParams │
├────────────┤
│x: 0 │
│y: BAD │
│pair: (2, 3)│
│ok: False │
│pos: 123 │
└────────────┘
$ python example.py --default default.yml 123
┌────────────┐
│ HParams │
├────────────┤
│x: 0 │
│y: 1 │
│pair: [4, 5]│
│ok: False │
│pos: 123 │
└────────────┘
$ python example.py --help
usage: example.py [-h] [--x int] [--y upper] [--pair int int] [--ok] [--default Path] str
positional arguments:
str pos
optional arguments:
-h, --help show this help message and exit
--x int x (default: 0)
--y upper y (default: bad)
--pair int int pair (default: (2, 3))
--ok ok (default: False)
--default Path A YAML configuration file that overrides the defaults (default: None)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for argparse-hparams-0.0.1.dev20211128172147.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad34ea72380eec5ac521c557f030a61468ee8fd5021cfdc0d6c85238b4baeddc |
|
MD5 | 2e598eee1d4f67c6c38db3e48df3a5ab |
|
BLAKE2b-256 | 5b1773224cf14281d1d9c332b6c85d732842b895f0c0d6c37cbb81f31f1fffa4 |
Close
Hashes for argparse_hparams-0.0.1.dev20211128172147-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f6a33de881b7dacce25bceb559aac7c4a4c51e9260654c7a3af21abb4252928 |
|
MD5 | 0ed44c016644094e6808e07d080d8b91 |
|
BLAKE2b-256 | 6904ca2966852537b662a8dcca07caabc38eca8a43da7988b5491a923263e72b |