Documentation
•
pip install tyro
tyro is a tool for building command-line
interfaces and configuration objects in Python.
Our core interface, tyro.cli(), generates command-line interfaces from
type-annotated callables.
Brief walkthrough
To summarize how tyro.cli() can be used, let's consider a script based on
argparse. We define two inputs and print the sum:
"""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()
total = args.a + args.b
print(total)
This pattern is dramatically cleaner than manually parsing sys.argv, but has
several issues: it lacks type checking and IDE support (consider: jumping to
definitions, finding references, docstrings, refactoring and renaming tools),
requires a significant amount of parsing-specific boilerplate, and becomes
difficult to manage for larger projects.
The basic goal of tyro.cli() is to provide a wrapper for argparse that
solves these issues.
(1) Command-line interfaces from functions.
We can write the same script as above using tyro.cli():
"""Sum two numbers by calling a function with tyro."""
import tyro
def add(a: int, b: int = 3) -> int:
return a + b
# Populate the inputs of add(), call it, then return the output.
total = tyro.cli(add)
print(total)
Or, more succinctly:
"""Sum two numbers by calling a function with tyro."""
import tyro
def add(a: int, b: int = 3) -> None:
print(a + b)
tyro.cli(add) # Returns `None`.
(2) Command-line interfaces from config objects.
A class in Python can be treated as a function that returns an instance. This makes it easy to populate explicit configuration structures:
"""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)
Unlike directly using argparse, both the function-based and dataclass-based
approaches are compatible with static analysis; tab completion and type checking
will work out-of-the-box.
(3) Additional features.
These examples only scratch the surface of what's possible. tyro aims to
support all reasonable type annotations, which can help us define things like
hierachical structures, enums, unions, variable-length inputs, and subcommands.
See documentation for examples.
In the wild
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.
1 maintainer
Release files for tyro 0.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| tyro-0.4.1.tar.gz | 52.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| tyro-0.4.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 113.2 kB
Release files / tyro-0.4.1.tar.gz
| Download URL | tyro-0.4.1.tar.gz |
|---|---|
| Size | 52.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
46ec5c77dc9d3506c1a2fdc06300ff4233dbdceeb72f601a507ed15763187cf9
|
|
BLAKE2b-256 checksum How to use checksums |
5a26bee543ff6e4382a9e216993874a9825e97e016f5d6fcd53cde267d3ce428
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.4.0 CPython/3.8.16 Linux/5.15.0-1034-azure
|
Release files / tyro-0.4.1-py3-none-any.whl
| Download URL | tyro-0.4.1-py3-none-any.whl |
|---|---|
| Size | 61.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7ea520af3e6130c7e516efc683afdd000047895f6b77d7e71fa58b5932427d26
|
|
BLAKE2b-256 checksum How to use checksums |
c22419287a5fced48c55ce5a9b6b1153955061283a894d3eb1c154ab2e7a9f61
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.4.0 CPython/3.8.16 Linux/5.15.0-1034-azure
|
