Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Steps to reproduce the behavior:

## Environment

<!-- Please run and include the output from https://github.com/pytorch/torchx/blob/main/scripts/collect_env.py. -->
<!-- Please run and include the output from https://github.com/meta-pytorch/torchx/blob/main/scripts/collect_env.py. -->

- torchx version (e.g. 0.1.0rc1):
- Python version:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/questions-help-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ about: Do you need support? We have resources.
### Please note that this issue tracker is not a help form and this issue will be closed.

Before submitting, please ensure you have gone through our
[documentation](https://pytorch.org/torchx).
[documentation](https://meta-pytorch.org/torchx).


### Question
Expand Down
14 changes: 7 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@

## torchx-0.5.0

* Milestone: https://github.com/pytorch/torchx/milestone/7
* Milestone: https://github.com/meta-pytorch/torchx/milestone/7

* `torchx.schedulers`
* Kubernetes MCAD Scheduler (Prototype)
Expand Down Expand Up @@ -116,7 +116,7 @@

## torchx-0.4.0

* Milestone: https://github.com/pytorch/torchx/milestone/6
* Milestone: https://github.com/meta-pytorch/torchx/milestone/6

* `torchx.schedulers`
* GCP Batch (Prototype)
Expand All @@ -142,7 +142,7 @@

## torchx-0.3.0

* Milestone: https://github.com/pytorch/torchx/milestone/5
* Milestone: https://github.com/meta-pytorch/torchx/milestone/5

* `torchx.schedulers`
* List API (Prototype)
Expand Down Expand Up @@ -189,7 +189,7 @@

## torchx-0.2.0

* Milestone: https://github.com/pytorch/torchx/milestone/4
* Milestone: https://github.com/meta-pytorch/torchx/milestone/4

* `torchx.schedulers`
* DeviceMounts
Expand Down Expand Up @@ -245,7 +245,7 @@

## torchx-0.1.2

Milestone: https://github.com/pytorch/torchx/milestones/3
Milestone: https://github.com/meta-pytorch/torchx/milestones/3

* PyTorch 1.11 Support
* Python 3.10 Support
Expand Down Expand Up @@ -285,7 +285,7 @@ Milestone: https://github.com/pytorch/torchx/milestones/3
* Ax runner now lives in the Ax repo https://github.com/facebook/Ax/commit/8e2e68f21155e918996bda0b7d97b5b9ef4e0cba
* `torchx.cli`
* `.torchxconfig`
* You can now specify component argument defaults `.torchxconfig` https://github.com/pytorch/torchx/commit/c37cfd7846d5a0cb527dd19c8c95e881858f8f0a
* You can now specify component argument defaults `.torchxconfig` https://github.com/meta-pytorch/torchx/commit/c37cfd7846d5a0cb527dd19c8c95e881858f8f0a
* `~/.torchxconfig` can now be used to set user level defaults. #378
* `--workspace` can be configured #397
* Color change and bug fixes #419
Expand All @@ -301,7 +301,7 @@ Milestone: https://github.com/pytorch/torchx/milestones/3

## torchx-0.1.1

* Milestone: https://github.com/pytorch/torchx/milestone/2
* Milestone: https://github.com/meta-pytorch/torchx/milestone/2

* `torchx.schedulers`
* #287, #286 - Implement `local_docker` scheduler using docker client lib
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[![PyPI](https://img.shields.io/pypi/v/torchx)](https://pypi.org/project/torchx/)
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://github.com/pytorch/torchx/blob/main/LICENSE)
![Tests](https://github.com/pytorch/torchx/actions/workflows/python-unittests.yaml/badge.svg)
![Lint](https://github.com/pytorch/torchx/actions/workflows/lint.yaml/badge.svg)
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://github.com/meta-pytorch/torchx/blob/main/LICENSE)
![Tests](https://github.com/meta-pytorch/torchx/actions/workflows/python-unittests.yaml/badge.svg)
![Lint](https://github.com/meta-pytorch/torchx/actions/workflows/lint.yaml/badge.svg)
[![codecov](https://codecov.io/gh/pytorch/torchx/branch/main/graph/badge.svg?token=ceHHIm0hXy)](https://codecov.io/gh/pytorch/torchx)


Expand All @@ -20,16 +20,16 @@ TorchX currently supports:
* Docker
* Local

Need a scheduler not listed? [Let us know!](https://github.com/pytorch/torchx/issues?q=is%3Aopen+is%3Aissue+label%3Ascheduler-request)
Need a scheduler not listed? [Let us know!](https://github.com/meta-pytorch/torchx/issues?q=is%3Aopen+is%3Aissue+label%3Ascheduler-request)

## Quickstart

See the [quickstart guide](https://pytorch.org/torchx/latest/quickstart.html).
See the [quickstart guide](https://meta-pytorch.org/torchx/latest/quickstart.html).

## Documentation

* [Stable Documentation](https://pytorch.org/torchx/latest/)
* [Nightly Documentation](https://pytorch.org/torchx/main/)
* [Stable Documentation](https://meta-pytorch.org/torchx/latest/)
* [Nightly Documentation](https://meta-pytorch.org/torchx/main/)

## Requirements

Expand Down Expand Up @@ -71,22 +71,22 @@ pip install torchx-nightly[dev]

```bash
# install torchx sdk and CLI from source
$ pip install -e git+https://github.com/pytorch/torchx.git#egg=torchx
$ pip install -e git+https://github.com/meta-pytorch/torchx.git#egg=torchx

# install extra dependencies
$ pip install -e git+https://github.com/pytorch/torchx.git#egg=torchx[dev]
$ pip install -e git+https://github.com/meta-pytorch/torchx.git#egg=torchx[dev]
```

### Docker

TorchX provides a docker container for using as as part of a TorchX role.

See: https://github.com/pytorch/torchx/pkgs/container/torchx
See: https://github.com/meta-pytorch/torchx/pkgs/container/torchx

## Contributing

We welcome PRs! See the [CONTRIBUTING](https://github.com/pytorch/torchx/blob/main/CONTRIBUTING.md) file.
We welcome PRs! See the [CONTRIBUTING](https://github.com/meta-pytorch/torchx/blob/main/CONTRIBUTING.md) file.

## License

TorchX is BSD licensed, as found in the [LICENSE](https://github.com/pytorch/torchx/blob/main/LICENSE) file.
TorchX is BSD licensed, as found in the [LICENSE](https://github.com/meta-pytorch/torchx/blob/main/LICENSE) file.
6 changes: 3 additions & 3 deletions docs/doc_push.sh
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

#
# Builds docs from the checkedout HEAD
# and pushes the artifacts to gh-pages branch in github.com/pytorch/torchx
# and pushes the artifacts to gh-pages branch in github.com/meta-pytorch/torchx
#
# 1. sphinx generated docs are copied to <repo-root>/<version>
# 2. if a release tag is found on HEAD then redirects are copied to <repo-root>/latest
Expand All @@ -21,8 +21,8 @@
# |- main (redirects to the most recent ver in trunk, including release)
# |- latest (redirects to the most recent release)
# If the most recent release is 0.1.0 and main is at 0.1.1rc1 then,
# https://pytorch.org/torchx/main -> https://pytorch.org/torchx/0.1.1rc1
# https://pytorch.org/torchx/latest -> https://pytorch.org/torchx/0.1.0
# https://meta-pytorch.org/torchx/main -> https://meta-pytorch.org/torchx/0.1.1rc1
# https://meta-pytorch.org/torchx/latest -> https://meta-pytorch.org/torchx/0.1.0
#
# Redirects are done via Jekyll redirect-from plugin. See:
# sources/scripts/create_redirect_md.py
Expand Down
2 changes: 1 addition & 1 deletion docs/source/_static/js/torchx.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ function setLinks(colabLink, notebookLink, githubLink) {

const version = $(".version").text().trim().split(" ")[0].substr(1);
const colabBase = "https://colab.research.google.com/github/pytorch/torchx/blob/gh-pages/" + version
const githubBase = "https://github.com/pytorch/torchx/blob/main/"
const githubBase = "https://github.com/meta-pytorch/torchx/blob/main/"

var downloadNote = $(".sphx-glr-download-link-note.admonition.note");
var isNBSphinx = $(".nbinput");
Expand Down
2 changes: 1 addition & 1 deletion docs/source/component_best_practices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,4 +144,4 @@ You can setup integration tests with your components by either using the
programmatic runner API or write a bash script to call the CLI.

You can see both styles in use in the core
`TorchX scheduler integration tests <https://github.com/pytorch/torchx/tree/main/.github/workflows>`__.
`TorchX scheduler integration tests <https://github.com/meta-pytorch/torchx/tree/main/.github/workflows>`__.
8 changes: 3 additions & 5 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
#
needs_sphinx = "1.6"

user_agent = "Mozilla/5.0 (X11; Linux x86_64; rv:25.0) Gecko/20100101 Firefox/25.0 github.com/pytorch/torchx"
user_agent = "Mozilla/5.0 (X11; Linux x86_64; rv:25.0) Gecko/20100101 Firefox/25.0 github.com/meta-pytorch/torchx"

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
Expand Down Expand Up @@ -333,12 +333,10 @@ def handle_item(fieldarg, content):

if version in tags:
notebook_version = version
code_url = (
f"https://github.com/pytorch/torchx/archive/refs/tags/{notebook_version}.tar.gz"
)
code_url = f"https://github.com/meta-pytorch/torchx/archive/refs/tags/{notebook_version}.tar.gz"
else:
notebook_version = "main"
code_url = f"https://github.com/pytorch/torchx/archive/refs/heads/{notebook_version}.tar.gz"
code_url = f"https://github.com/meta-pytorch/torchx/archive/refs/heads/{notebook_version}.tar.gz"

first_notebook_cell = f"""
!pip install torchx
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:github_url: https://github.com/pytorch/torchx
:github_url: https://github.com/meta-pytorch/torchx

TorchX
==================
Expand Down
4 changes: 2 additions & 2 deletions docs/source/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ $ pip install "torchx[dev]"
```
<!-- #endmd -->

See the [README](https://github.com/pytorch/torchx) for more
See the [README](https://github.com/meta-pytorch/torchx) for more
information on installation.

```sh
Expand Down Expand Up @@ -164,7 +164,7 @@ partition=torchx

TorchX supports a large number of schedulers.
Don't see yours?
[Request it!](https://github.com/pytorch/torchx/issues/new?assignees=&labels=&template=feature-request.md)
[Request it!](https://github.com/meta-pytorch/torchx/issues/new?assignees=&labels=&template=feature-request.md)

Remote schedulers operate the exact same way the local schedulers do. The same
run command for local works out of the box on remote.
Expand Down
6 changes: 3 additions & 3 deletions docs/versions_html.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@
similar to: https://raw.githubusercontent.com/pytorch/pytorch.github.io/site/docs/versions.html

This list of versions is displayed on the top LHS dropdown of
https://pytorch.org/torchx.
https://meta-pytorch.org/torchx.

Usage (also see ``doc_push.sh``):

::
# NOTE: YOU HAVE TO RUN THE SCRIPT FROM THE ROOT of gh-pages branch checkout
git clone -b gh-pages --single-branch https://github.com/pytorch/torchx.git /tmp/torchx-gh-pages
git clone -b gh-pages --single-branch https://github.com/meta-pytorch/torchx.git /tmp/torchx-gh-pages
cd /tmp/torchx-gh-pages
$torchx_repo_root/docs/versions_html.py`
"""
Expand Down Expand Up @@ -114,7 +114,7 @@ def versions_list(versions: List[str]) -> List[str]:


def gen_versions_html() -> None:
# cwd is expected to be https://github.com/pytorch/torchx/tree/gh-pages
# cwd is expected to be https://github.com/meta-pytorch/torchx/tree/gh-pages
# most top level subdirs are versioned docs
print(f"Generating {VERSIONS_HTML}")

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ def get_nightly_version():
description="TorchX SDK and Components",
long_description=readme,
long_description_content_type="text/markdown",
url="https://github.com/pytorch/torchx",
url="https://github.com/meta-pytorch/torchx",
license="BSD-3",
keywords=["pytorch", "machine learning"],
python_requires=">=3.7",
Expand Down
2 changes: 1 addition & 1 deletion torchx/cli/cmd_run.py
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ def _run_inner(self, runner: Runner, args: TorchXRunArgs) -> None:
"Invalid scheduler configuration: %s\n"
"To configure scheduler options, either:\n"
" 1. Use the `-cfg` command-line argument, e.g., `-cfg key1=value1,key2=value2`\n"
" 2. Set up a `.torchxconfig` file. For more details, visit: https://pytorch.org/torchx/main/runner.config.html\n"
" 2. Set up a `.torchxconfig` file. For more details, visit: https://meta-pytorch.org/torchx/main/runner.config.html\n"
"Run `torchx runopts %s` to check all available configuration options for the "
"`%s` scheduler."
)
Expand Down
2 changes: 1 addition & 1 deletion torchx/cli/cmd_tracker.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ def tracker(self) -> TrackerBase:
else:
raise RuntimeError(
"No trackers configured."
" See: https://pytorch.org/torchx/latest/runtime/tracking.html"
" See: https://meta-pytorch.org/torchx/latest/runtime/tracking.html"
)

def add_list_job_arguments(self, subparser: argparse.ArgumentParser) -> None:
Expand Down
2 changes: 1 addition & 1 deletion torchx/components/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ def ddp(...) -> specs.AppDef:

1. (easiest) Dryrun your component's ``--help`` with the cli: ``torchx run --dryrun ~/component.py:train --help``
2. Use the component :ref:`linter<specs:Component Linter>`
(see `dist_test.py <https://github.com/pytorch/torchx/blob/main/torchx/components/test/dist_test.py>`_ as an example)
(see `dist_test.py <https://github.com/meta-pytorch/torchx/blob/main/torchx/components/test/dist_test.py>`_ as an example)


Running as a Job
Expand Down
2 changes: 1 addition & 1 deletion torchx/components/dist.py
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ def ddp(

Note: (cpu, gpu, memMB) parameters are mutually exclusive with ``h`` (named resource) where
``h`` takes precedence if specified for setting resource requirements.
See `registering named resources <https://pytorch.org/torchx/latest/advanced.html#registering-named-resources>`_.
See `registering named resources <https://meta-pytorch.org/torchx/latest/advanced.html#registering-named-resources>`_.

Args:
script_args: arguments to the main module
Expand Down
2 changes: 1 addition & 1 deletion torchx/components/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ def python(

Note: (cpu, gpu, memMB) parameters are mutually exclusive with ``h`` (named resource) where
``h`` takes precedence if specified for setting resource requirements.
See `registering named resources <https://pytorch.org/torchx/latest/advanced.html#registering-named-resources>`_.
See `registering named resources <https://meta-pytorch.org/torchx/latest/advanced.html#registering-named-resources>`_.

Args:
args: arguments passed to the program in sys.argv[1:] (ignored with `--c`)
Expand Down
2 changes: 1 addition & 1 deletion torchx/distributed/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ def local_rank() -> int:
" but the `LOCAL_RANK` environment variable is not set. Will trivially return 0 for local_rank.\n"
" It is recommended to use torchrun/torchx to run your script or set the `LOCAL_RANK` manually.\n"
" For additional details see:\n"
" 1) https://pytorch.org/torchx/latest/components/distributed.html\n"
" 1) https://meta-pytorch.org/torchx/latest/components/distributed.html\n"
" 2) https://pytorch.org/docs/stable/elastic/run.html\n"
"=============================================================================================="
)
Expand Down
2 changes: 1 addition & 1 deletion torchx/examples/apps/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Before executing examples, install TorchX and dependencies necessary to run exam

```
$ pip install torchx
$ git clone https://github.com/pytorch/torchx.git
$ git clone https://github.com/meta-pytorch/torchx.git
$ cd torchx/examples/apps
$ TORCHX_VERSION=$(torchx --version | sed 's/torchx-//')
$ git checkout v$TORCHX_VERSION
Expand Down
2 changes: 1 addition & 1 deletion torchx/schedulers/kubernetes_scheduler.py
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,7 @@ class KubernetesScheduler(
For installation instructions see: https://github.com/volcano-sh/volcano

This has been confirmed to work with Volcano v1.3.0 and Kubernetes versions
v1.18-1.21. See https://github.com/pytorch/torchx/issues/120 which is
v1.18-1.21. See https://github.com/meta-pytorch/torchx/issues/120 which is
tracking Volcano support for Kubernetes v1.22.

.. note::
Expand Down
2 changes: 1 addition & 1 deletion torchx/specs/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ def resource(

If ``h`` is specified then it is used to look up the
resource specs from the list of registered named resources.
See `registering named resource <https://pytorch.org/torchx/latest/advanced.html#registering-named-resources>`_.
See `registering named resource <https://meta-pytorch.org/torchx/latest/advanced.html#registering-named-resources>`_.

Otherwise a ``Resource`` object is created from the raw resource specs.

Expand Down
2 changes: 1 addition & 1 deletion torchx/specs/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -854,7 +854,7 @@ def cast_to_type(self, value: str) -> CfgVal:

NOTE: dict parsing uses ":" as the kv separator (rather than the standard "=") because "=" is used
at the top-level cfg to parse runopts (notice the plural) from the CLI. Originally torchx only supported
primitives and list[str] as CfgVal but dict[str,str] was added in https://github.com/pytorch/torchx/pull/855
primitives and list[str] as CfgVal but dict[str,str] was added in https://github.com/meta-pytorch/torchx/pull/855
"""

if self.opt_type is None:
Expand Down
2 changes: 1 addition & 1 deletion torchx/specs/file_linter.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ def get_fn_docstring(fn: Callable[..., object]) -> Tuple[str, Dict[str, str]]:
if the description
"""
default_fn_desc = f"""{fn.__name__} TIP: improve this help string by adding a docstring
to your component (see: https://pytorch.org/torchx/latest/component_best_practices.html)"""
to your component (see: https://meta-pytorch.org/torchx/latest/component_best_practices.html)"""
args_description = _get_default_arguments_descriptions(fn)
func_description = inspect.getdoc(fn)
if not func_description:
Expand Down
2 changes: 1 addition & 1 deletion torchx/specs/finder.py
Original file line number Diff line number Diff line change
Expand Up @@ -452,7 +452,7 @@ def get_component(
raise ComponentNotFoundException(
f"Component `{name}` not found. Please make sure it is one of the "
"builtins: `torchx builtins`. Or registered via `[torchx.components]` "
"entry point (see: https://pytorch.org/torchx/latest/configure.html)"
"entry point (see: https://meta-pytorch.org/torchx/latest/configure.html)"
)

component = components[name]
Expand Down
4 changes: 2 additions & 2 deletions torchx/specs/named_resources_aws.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

.. note::
These resource definitions may change in future. It is expected for each user to
manage their own resources. Follow https://pytorch.org/torchx/latest/specs.html#torchx.specs.get_named_resources
manage their own resources. Follow https://meta-pytorch.org/torchx/latest/specs.html#torchx.specs.get_named_resources
to set up named resources.

Usage:
Expand Down Expand Up @@ -47,7 +47,7 @@
MEM_TAX = 0.96

# determines instance type for non-honogeneous CEs
# see https://github.com/pytorch/torchx/issues/780
# see https://github.com/meta-pytorch/torchx/issues/780
K8S_ITYPE = "node.kubernetes.io/instance-type"
GiB: int = int(1024 * MEM_TAX)

Expand Down
2 changes: 1 addition & 1 deletion torchx/specs/test/file_linter_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ def test_validate_docstring_short(self) -> None:
def test_validate_docstring_no_docs(self) -> None:
func_desc, param_desc = get_fn_docstring(_test_without_docstring)
expected_fn_desc = """_test_without_docstring TIP: improve this help string by adding a docstring
to your component (see: https://pytorch.org/torchx/latest/component_best_practices.html)"""
to your component (see: https://meta-pytorch.org/torchx/latest/component_best_practices.html)"""
self.assertEqual(expected_fn_desc, func_desc)
self.assertEqual(" ", param_desc["arg0"])

Expand Down
Loading
Loading