Yet Another HyperParameter framework
Project description
YAHP: Yet Another HyperParameter
YAHP introduces yet another hyperparameter management tool.
Features
- Utilizes dataclasses to describe the data model.
- Supports
int
,float
,bool
,str
, andEnum
s; along with lists and nullable fields - Fields can be optional (with a default) or required
- Auto-generates YAML templates, serializes the data model to YAML, and loads YAML into the data model.
- Allows for nested dataclasses -- even with abstract classes
- Adds an argparse CLI
Getting Started
- See the simple example for a simple data model and yaml file.
- See the cli example for an example of the CLI.
- See the registry example for how to use nested dataclasses with inheritance.
YAHP Command Line
Whenever Hparams.create()
is invoked, YAHP adds the following command line options:
-h
,--help
: Print help and exit.-f
,--file
": Load data from this YAML file into the Hparams.-s
,--save_template
: Generate and dump a YAML template to the specified file (defaults tostdout
) and exit.-i
,--interactive
: Whether to generate the template interactively. Only applicable if--save_template
is present.-c
,--concise
: Skip adding documentation to the generated YAML. Only applicable if--save_template
is present.-d
,--dump
: Dump the resulting Hparams to the specified YAML file (defaults tostdout
) and exit.
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
yahp-0.0.11.tar.gz
(31.4 kB
view hashes)
Built Distribution
yahp-0.0.11-py3-none-any.whl
(31.9 kB
view hashes)