Xuehai Pan a229b4526f [BE] Prefer dash over underscore in command-line options (#94505) ... Preferring dash over underscore in command-line options. Add `--command-arg-name` to the argument parser. The old arguments with underscores `--command_arg_name` are kept for backward compatibility. Both dashes and underscores are used in the PyTorch codebase. Some argument parsers only have dashes or only have underscores in arguments. For example, the `torchrun` utility for distributed training only accepts underscore arguments (e.g., `--master_port`). The dashes are more common in other command-line tools. And it looks to be the default choice in the Python standard library: `argparse.BooleanOptionalAction`: 4a9dff0e5a/Lib/argparse.py (L893-L895) ```python class BooleanOptionalAction(Action): def __init__(...): if option_string.startswith('--'): option_string = '--no-' + option_string[2:] _option_strings.append(option_string) ``` It adds `--no-argname`, not `--no_argname`. Also typing `_` need to press the shift or the caps-lock key than `-`. Pull Request resolved: https://github.com/pytorch/pytorch/pull/94505 Approved by: https://github.com/ezyang, https://github.com/seemethere		2023-02-09 20:16:49 +00:00
..
agent_diagram.jpg
agent.rst	Add watchdog to TorchElastic agent and trainers (#84081)	2022-09-07 00:17:20 +00:00
customization.rst
errors.rst	[torch] Various improvements to torch.distributed.launch and torch.distributed.run (#61294)	2021-07-08 16:28:06 -07:00
etcd_rdzv_diagram.png
events.rst
examples.rst
kubernetes.rst	Fix typo under docs directory (#92762)	2023-01-23 18:07:22 +00:00
metrics.rst
multiprocessing.rst
quickstart.rst	[BE] Prefer dash over underscore in command-line options (#94505)	2023-02-09 20:16:49 +00:00
rendezvous.rst	[torch/elastic] Update the rendezvous docs (#58160)	2021-05-12 16:54:28 -07:00
run.rst	Introduce the torchrun entrypoint (#64049)	2021-08-26 20:17:48 -07:00
timer.rst	Named pipe based watchdog timer (#83695)	2022-08-24 22:16:12 +00:00
train_script.rst	[BE] Prefer dash over underscore in command-line options (#94505)	2023-02-09 20:16:49 +00:00