参数类<=>人性化cli
smart-arg的Python项目详细描述
智能参数套件简介(smart-arg
)
Smart Argument Suite(smart-arg
)是一个轻巧方便的Python库,可以帮助用户安全、方便地工作
使用由不可变参数类表示的参数
(^{
smart-arg
促进参数类型安全,启用ide的代码自动完成和类型提示
功能,并帮助生成正确的代码。
快速入门
^{pip
获得。
pip3 install smart-arg
用户可以在Python脚本中使用smart-arg
修饰符@arg_suite
来定义他们的参数NamedTuple
或{
> python my_job.py -h usage: my_job.py [-h] --nn [int [int ...]] --a_tuple str int --encoder str --h_param [str:int [str:int ...]] [--batch_size int] [--adp {True,False}] [--embedding_dim int] [--lr float]MyArg is smart! (docstring goes to description)optional arguments: -h, --help show this help message and exit --nn [int [int ...]] (List[int], required) Comments go to argparse help --a_tuple str int (Tuple[str, int], required) a random tuple argument --encoder str (str, required) Text encoder type --h_param [str:int [str:int ...]] (Dict[str, int], required) Hyperparameters --batch_size int (Optional[int], default: None) --adp {True,False} (bool, default: True) bool is a bit tricky --embedding_dim int (int, default: 100) Size of embedding vector --lr float (float, default: 0.001) Learning rate
推广实践
- 集中精力定义参数,并让
smart-arg
(由argparse.ArgumentParser支持) 在命令行界面上发挥它的魔力。在 - 如果可能,请始终直接处理参数类实例,即使只需要生成命令行表示形式也是如此。在
- 坚持默认行为和基本特性,在使用advanced features之前要三思而后行。在
更多细节
有关更多特性和实现细节,请参阅documentation。
贡献
请阅读CONTRIBUTING.md了解我们的行为准则以及向我们提交拉取请求的过程。
许可证
此项目是在BSD2子句许可下授权的-有关详细信息,请参阅LICENSE.md文件
- 项目
标签: