experimental/cpu/: tyro-0.8.4 metadata and description
Strongly typed, zero-effort CLI interfaces
author_email | brentyi <brentyi@berkeley.edu> |
classifiers |
|
description_content_type | text/markdown |
license | MIT |
project_urls |
|
provides_extras | dev |
requires_dist |
|
requires_python | >=3.7 |
File | Tox results | History |
---|---|---|
tyro-0.8.4-py3-none-any.whl
|
|
Documentation
•
pip install tyro
tyro
is a tool for generating command-line
interfaces and configuration objects in Python.
Our core API, tyro.cli()
,
- Generates CLI interfaces from Python type signatures.
- Populates helptext automatically from defaults, annotations, and docstrings.
- Understands nesting of
dataclasses
,pydantic
, andattrs
structures. - Prioritizes static analysis for type checking and autocompletion with tools like Pylance, Pyright, and mypy.
For advanced users, it also supports:
- Subcommands, as well as choosing between and overriding values in configuration objects.
- Completion script generation for
bash
,zsh
, andtcsh
. - Fine-grained configuration via PEP 529 runtime annotations
(
tyro.conf.*
).
For examples and the API reference, see our documentation.
In the wild
tyro
is designed to be lightweight enough for throwaway scripts, while
facilitating type safety and modularity for larger projects. Examples:
nerfstudio-project/nerfstudio
|
Open-source tools for neural radiance fields. |
Sea-Snell/JAXSeq
|
Library for distributed training of large language models in JAX. |
kevinzakka/obj2mjcf
|
Interface for processing composite Wavefront OBJ files for Mujoco. |
blurgyy/jaxngp
|
CUDA-accelerated implementation of instant-ngp, in JAX. |
NVIDIAGameWorks/kaolin-wisp
|
PyTorch library for neural fields. |
autonomousvision/sdfstudio
|
Unified framework for surface reconstruction. |
openrlbenchmark/openrlbenchmark
|
Collection of tracked experiments for reinforcement learning. |
Alternatives
tyro
bakes many opinions into its design decisions. If any of them don't make
sense, feel free to file an issue!
You might also consider one of many alternative libraries. Some that we particularly like:
- simple-parsing and jsonargparse, which provide deeper integration with configuration file formats like YAML and JSON.
- clipstick, which focuses on generating CLIs from Pydantic models.
- datargs, which provides a minimal API for dataclasses.
- fire and clize, which support arguments without type annotations.
We also have some notes on tyro
's design goals and other alternatives in the
docs here.