Skip to content

brentyi/tyro

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


tyro logo

Documentation   •   pip install tyro

build mypy pyright ruff codecov codecov


tyro.cli() generates command-line interfaces via Python type introspection. We can define configurable scripts using functions:

"""A command-line interface defined using a function signature.

Usage: python script_name.py --foo INT [--bar STR]
"""

import tyro

def main(
    foo: int,
    bar: str = "default",
) -> None:
    ...  # Main body of a script.

if __name__ == "__main__":
    # Generate a CLI and call `main` with its two arguments: `foo` and `bar`.
    tyro.cli(main)

Or instantiate configuration objects defined using tools like dataclasses, pydantic, and attrs:

"""A command-line interface defined using a class signature.

Usage: python script_name.py --foo INT [--bar STR]
"""

from dataclasses import dataclass
import tyro

@dataclass
class Config:
    foo: int
    bar: str = "default"

if __name__ == "__main__":
    # Generate a CLI and instantiate `Config` with its two arguments: `foo` and `bar`.
    config = tyro.cli(Config)

    # Rest of script.
    assert isinstance(config, Config)  # Should pass.

Other features include helptext generation, nested structures, shell completion, and subcommands. 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
GitHub star count
Open-source tools for neural radiance fields.
Sea-Snell/JAXSeq
GitHub star count
Train very large language models in Jax.
kevinzakka/obj2mjcf
GitHub star count
Interface for processing OBJ files for Mujoco.
blurgyy/jaxngp
GitHub star count
CUDA-accelerated implementation of instant-ngp, in JAX.
NVIDIAGameWorks/kaolin-wisp
GitHub star count
PyTorch library for neural fields.
autonomousvision/sdfstudio
GitHub star count
Unified framework for surface reconstruction.
openrlbenchmark/openrlbenchmark
GitHub star count
Collection of tracked experiments for reinforcement learning.
vwxyzjn/cleanrl
GitHub star count
Single-file implementation of deep RL algorithms.

Alternatives

tyro is an opinionated library. If any design decisions 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.