Documentation
•
pip install tyro
tyro is a library for building CLI interfaces and
configuration objects with type-annotated Python.
Our core interface consists of one function, tyro.cli(), that generates
argument parsers from Python callables and types.
As a replacement for argparse:
| with argparse | with tyro |
"""Sum two numbers from argparse."""
import argparse
parser = argparse.ArgumentParser()
parser.add_argument(
"--a",
type=int,
required=True,
)
parser.add_argument(
"--b",
type=int,
default=3,
)
args = parser.parse_args()
print(args.a + args.b) |
"""Sum two numbers by calling a
function with tyro."""
import tyro
def main(a: int, b: int = 3) -> None:
print(a + b)
tyro.cli(main)"""Sum two numbers by instantiating
a dataclass with tyro."""
from dataclasses import dataclass
import tyro
@dataclass
class Args:
a: int
b: int = 3
args = tyro.cli(Args)
print(args.a + args.b) |
For more examples, see our documentation.
-
Strong typing.
Unlike tools dependent on dictionaries, YAML, or dynamic namespaces, arguments populated by
tyrobenefit from IDE and language server-supported operations — think tab completion, rename, jump-to-def, docstrings on hover — as well as static checking tools likepyrightandmypy. -
Minimal overhead.
Standard Python type annotations, docstrings, and default values are parsed to automatically generate command-line interfaces with informative helptext.
If you're familiar with type annotations and docstrings in Python, you already know how to use
tyro! If you're not, learning to usetyroreduces to learning to write modern Python.Hate
tyro? Just remove one line of code, and you're left with beautiful, type-annotated, and documented vanilla Python that can be used with a range of other configuration libraries. -
Modularity.
tyrosupports hierarchical configuration structures, which make it easy to distribute definitions, defaults, and documentation of configurable fields across modules or source files. -
Tab completion.
By extending shtab,
tyroautomatically generates tab completion scripts for bash, zsh, and tcsh.
tyro is still a new library, but being stress tested in several projects!
- nerfstudio-project/nerfstudio provides a set of tools for end-to-end training, testing, and rendering of neural radiance fields.
- Sea-Snell/JAXSeq is a library for distributed training of large language models in JAX.
- kevinzakka/obj2mjcf is an interface for processing composite Wavefront OBJ files for Mujoco.
- brentyi/tensorf-jax is an unofficial implementation of Tensorial Radiance Fields in JAX.