mirror of
https://github.com/zebrajr/pytorch.git
synced 2025-12-07 00:21:07 +01:00
a229b4526f
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
88 lines
2.7 KiB
Python
88 lines
2.7 KiB
Python
#!/usr/bin/env python3
|
|
# Owner(s): ["oncall: r2p"]
|
|
|
|
# Copyright (c) Facebook, Inc. and its affiliates.
|
|
# All rights reserved.
|
|
#
|
|
# This source code is licensed under the BSD-style license found in the
|
|
# LICENSE file in the root directory of this source tree.
|
|
import os
|
|
import shutil
|
|
import tempfile
|
|
import unittest
|
|
from contextlib import closing
|
|
|
|
import torch.distributed.launch as launch
|
|
from torch.distributed.elastic.utils import get_socket_with_port
|
|
from torch.testing._internal.common_utils import (
|
|
TEST_WITH_DEV_DBG_ASAN,
|
|
sandcastle_skip_if,
|
|
)
|
|
|
|
|
|
def path(script):
|
|
return os.path.join(os.path.dirname(__file__), script)
|
|
|
|
|
|
class LaunchTest(unittest.TestCase):
|
|
def setUp(self):
|
|
self.test_dir = tempfile.mkdtemp()
|
|
# set a sentinel env var on the parent proc
|
|
# this should be present on the child and gets
|
|
# asserted in ``bin/test_script.py``
|
|
os.environ["TEST_SENTINEL_PARENT"] = "FOOBAR"
|
|
|
|
def tearDown(self):
|
|
shutil.rmtree(self.test_dir)
|
|
|
|
@sandcastle_skip_if(
|
|
TEST_WITH_DEV_DBG_ASAN, "test incompatible with dev/dbg asan"
|
|
)
|
|
def test_launch_without_env(self):
|
|
nnodes = 1
|
|
nproc_per_node = 4
|
|
world_size = nnodes * nproc_per_node
|
|
sock = get_socket_with_port()
|
|
with closing(sock):
|
|
master_port = sock.getsockname()[1]
|
|
args = [
|
|
f"--nnodes={nnodes}",
|
|
f"--nproc-per-node={nproc_per_node}",
|
|
"--monitor-interval=1",
|
|
"--start-method=spawn",
|
|
"--master-addr=localhost",
|
|
f"--master-port={master_port}",
|
|
"--node-rank=0",
|
|
path("bin/test_script_local_rank.py"),
|
|
]
|
|
launch.main(args)
|
|
|
|
@sandcastle_skip_if(
|
|
TEST_WITH_DEV_DBG_ASAN, "test incompatible with dev/dbg asan"
|
|
)
|
|
def test_launch_with_env(self):
|
|
nnodes = 1
|
|
nproc_per_node = 4
|
|
world_size = nnodes * nproc_per_node
|
|
sock = get_socket_with_port()
|
|
with closing(sock):
|
|
master_port = sock.getsockname()[1]
|
|
args = [
|
|
f"--nnodes={nnodes}",
|
|
f"--nproc-per-node={nproc_per_node}",
|
|
"--monitor-interval=1",
|
|
"--start-method=spawn",
|
|
"--master-addr=localhost",
|
|
f"--master-port={master_port}",
|
|
"--node-rank=0",
|
|
"--use-env",
|
|
path("bin/test_script.py"),
|
|
f"--touch-file-dir={self.test_dir}",
|
|
]
|
|
launch.main(args)
|
|
# make sure all the workers ran
|
|
# each worker touches a file with its global rank as the name
|
|
self.assertSetEqual(
|
|
{str(i) for i in range(world_size)}, set(os.listdir(self.test_dir))
|
|
)
|