Skip to content

feat: expose run_name via env in dist/spmd (#1035) #1036

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 28, 2025
Merged

feat: expose run_name via env in dist/spmd (#1035) #1036

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions torchx/components/dist.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,7 @@ def ddp(
)

env["TORCHX_TRACKING_EXPERIMENT_NAME"] = argname.experiment_name
env["TORCHX_TRACKING_RUN_NAME"] = argname.run_name

env.setdefault("LOGLEVEL", os.getenv("LOGLEVEL", "WARNING"))
if debug:
Expand Down
28 changes: 28 additions & 0 deletions torchx/components/test/dist_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,27 +56,31 @@ def test_validate_spmd(self) -> None:
def test_spmd_call_by_module_or_script_no_name(self) -> None:
appdef = spmd(script="foo/bar.py")
self.assertEqual("bar", appdef.name)
self.assertEqual("bar", appdef.roles[0].env["TORCHX_TRACKING_RUN_NAME"])
self.assertEqual(
"default-experiment",
appdef.roles[0].env["TORCHX_TRACKING_EXPERIMENT_NAME"],
)

appdef = spmd("-a", "b", script="foo/bar.py")
self.assertEqual("bar", appdef.name)
self.assertEqual("bar", appdef.roles[0].env["TORCHX_TRACKING_RUN_NAME"])
self.assertEqual(
"default-experiment",
appdef.roles[0].env["TORCHX_TRACKING_EXPERIMENT_NAME"],
)

appdef = spmd(m="foo.bar")
self.assertEqual("bar", appdef.name)
self.assertEqual("bar", appdef.roles[0].env["TORCHX_TRACKING_RUN_NAME"])
self.assertEqual(
"default-experiment",
appdef.roles[0].env["TORCHX_TRACKING_EXPERIMENT_NAME"],
)

appdef = spmd("-a", "b", m="foo.bar")
self.assertEqual("bar", appdef.name)
self.assertEqual("bar", appdef.roles[0].env["TORCHX_TRACKING_RUN_NAME"])
self.assertEqual(
"default-experiment",
appdef.roles[0].env["TORCHX_TRACKING_EXPERIMENT_NAME"],
Expand All @@ -91,35 +95,43 @@ def test_spmd_call_by_module_or_script_no_name(self) -> None:
def test_spmd_call_by_module_or_script_with_name(self) -> None:
appdef = spmd(script="foo/bar.py", name="baz/trial_1")
self.assertEqual("trial_1", appdef.name)
self.assertEqual("trial_1", appdef.roles[0].env["TORCHX_TRACKING_RUN_NAME"])
self.assertEqual("baz", appdef.roles[0].env["TORCHX_TRACKING_EXPERIMENT_NAME"])

appdef = spmd("-a", "b", script="foo/bar.py", name="baz/trial_1")
self.assertEqual("trial_1", appdef.name)
self.assertEqual("baz", appdef.roles[0].env["TORCHX_TRACKING_EXPERIMENT_NAME"])
self.assertEqual("trial_1", appdef.roles[0].env["TORCHX_TRACKING_RUN_NAME"])

appdef = spmd(m="foo.bar", name="baz/trial_1")
self.assertEqual("trial_1", appdef.name)
self.assertEqual("trial_1", appdef.roles[0].env["TORCHX_TRACKING_RUN_NAME"])
self.assertEqual("baz", appdef.roles[0].env["TORCHX_TRACKING_EXPERIMENT_NAME"])

appdef = spmd("-a", "b", m="foo.bar", name="baz/trial_1")
self.assertEqual("trial_1", appdef.name)
self.assertEqual("trial_1", appdef.roles[0].env["TORCHX_TRACKING_RUN_NAME"])
self.assertEqual("baz", appdef.roles[0].env["TORCHX_TRACKING_EXPERIMENT_NAME"])

def test_spmd_call_by_module_or_script_with_experiment_name(self) -> None:
appdef = spmd(script="foo/bar.py", name="baz/")
self.assertEqual("bar", appdef.name)
self.assertEqual("bar", appdef.roles[0].env["TORCHX_TRACKING_RUN_NAME"])
self.assertEqual("baz", appdef.roles[0].env["TORCHX_TRACKING_EXPERIMENT_NAME"])

appdef = spmd("-a", "b", script="foo/bar.py", name="baz/")
self.assertEqual("bar", appdef.name)
self.assertEqual("bar", appdef.roles[0].env["TORCHX_TRACKING_RUN_NAME"])
self.assertEqual("baz", appdef.roles[0].env["TORCHX_TRACKING_EXPERIMENT_NAME"])

appdef = spmd(m="foo.bar", name="baz/")
self.assertEqual("bar", appdef.name)
self.assertEqual("bar", appdef.roles[0].env["TORCHX_TRACKING_RUN_NAME"])
self.assertEqual("baz", appdef.roles[0].env["TORCHX_TRACKING_EXPERIMENT_NAME"])

appdef = spmd("-a", "b", m="foo.bar", name="baz/")
self.assertEqual("bar", appdef.name)
self.assertEqual("bar", appdef.roles[0].env["TORCHX_TRACKING_RUN_NAME"])
self.assertEqual("baz", appdef.roles[0].env["TORCHX_TRACKING_EXPERIMENT_NAME"])

def test_spmd_call_by_module_or_script_with_run_name(self) -> None:
Expand All @@ -129,24 +141,40 @@ def test_spmd_call_by_module_or_script_with_run_name(self) -> None:
"default-experiment",
appdef.roles[0].env["TORCHX_TRACKING_EXPERIMENT_NAME"],
)
self.assertEqual(
"trial_1",
appdef.roles[0].env["TORCHX_TRACKING_RUN_NAME"],
)

appdef = spmd("-a", "b", script="foo/bar.py", name="/trial_1")
self.assertEqual("trial_1", appdef.name)
self.assertEqual(
"default-experiment",
appdef.roles[0].env["TORCHX_TRACKING_EXPERIMENT_NAME"],
)
self.assertEqual(
"trial_1",
appdef.roles[0].env["TORCHX_TRACKING_RUN_NAME"],
)

appdef = spmd(m="foo.bar", name="/trial_1")
self.assertEqual("trial_1", appdef.name)
self.assertEqual(
"default-experiment",
appdef.roles[0].env["TORCHX_TRACKING_EXPERIMENT_NAME"],
)
self.assertEqual(
"trial_1",
appdef.roles[0].env["TORCHX_TRACKING_RUN_NAME"],
)

appdef = spmd("-a", "b", m="foo.bar", name="/trial_1")
self.assertEqual("trial_1", appdef.name)
self.assertEqual(
"default-experiment",
appdef.roles[0].env["TORCHX_TRACKING_EXPERIMENT_NAME"],
)
self.assertEqual(
"trial_1",
appdef.roles[0].env["TORCHX_TRACKING_RUN_NAME"],
)
Loading