fbshipit-source-id: ef660a2b23984d28bd9bbc3e906e003a85e9df8b

Author: Kiuk Chung

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at <[email protected]>. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Contributing to TorchX
+We want to make contributing to this project as easy and transparent as
+possible.
+
+## Our Development Process
+... (in particular how this is synced with internal changes to the project)
+
+## Pull Requests
+We actively welcome your pull requests.
+
+1. Fork the repo and create your branch from `master`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Make sure your code lints (run `scripts/formatter_python.sh`).
+6. If you haven't already, complete the Contributor License Agreement ("CLA").
+
+## Contributor License Agreement ("CLA")
+In order to accept your pull request, we need you to submit a CLA. You only need
+to do this once to work on any of Facebook's open source projects.
+
+Complete your CLA here: <https://code.facebook.com/cla>
+
+## Issues
+We use GitHub issues to track public bugs. Please ensure your description is
+clear and has sufficient instructions to be able to reproduce the issue.
+
+Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
+disclosure of security bugs. In those cases, please go through the process
+outlined on that page and do not file a public issue.
+
+## License
+By contributing to TorchX, you agree that your contributions will be licensed
+under the LICENSE file in the root directory of this source tree.

LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2019-present, Facebook, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,35 @@
+[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](LICENSE)
+
+# TorchX
+
+
+For the latest documentation, please refer to our [website](https://pytorch.org/torchx).
+
+
+## Requirements
+TorchX SDK (torchx):
+* python3 (3.8+)
+* torch
+
+TorchX Kubeflow Pipelines Support (torchx-kfp):
+* torchx
+* kfp
+
+## Installation
+```bash
+# install torchx sdk
+pip install torchx
+
+# install torchx kubeflow pipelines (kfp) support
+pip intall torchx-kfp
+```
+
+## Quickstart
+<TODO PLACEHOLDER>
+
+## Contributing
+
+We welcome PRs! See the [CONTRIBUTING](CONTRIBUTING.md) file.
+
+## License
+TorchX is BSD licensed, as found in the [LICENSE](LICENSE) file.

docs/Makefile

@@ -0,0 +1,31 @@
+
+# Minimal makefile for Sphinx documentation
+# Usage:
+#    make html
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = torchx
+SOURCEDIR     = source
+BUILDDIR      = build
+VERSION       := $(shell python -c "import torchx; print(torchx.__version__)")
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+redirects:
+	python source/scripts/create_redirect_md.py --source_dir "$(SOURCEDIR)" --build_dir "$(BUILDDIR)/redirects"
+
+clean:
+	@echo "Deleting build directory"
+	rm -rf "$(BUILDDIR)"
+
+.PHONY: help Makefile redirects clean
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile redirects
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)/$(VERSION)" $(SPHINXOPTS) $(O)

docs/doc_push.sh

@@ -0,0 +1,99 @@
+#!/bin/bash
+
+# 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.
+
+#
+# Builds docs from the checkedout HEAD
+# and pushes the artifacts to gh-pages branch in github.com/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
+# 3. if no release tag is found on HEAD then redirects are copied to <repo-root>/master
+#
+# gh-pages branch should look as follows:
+# <repo-root>
+#           |- 0.1.0rc2
+#           |- 0.1.0rc3
+#           |- <versions...>
+#           |- master (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 master is at 0.1.1rc1 then,
+# https://pytorch.org/torchx/master -> https://pytorch.org/torchx/0.1.1rc1
+# https://pytorch.org/torchx/latest -> https://pytorch.org/torchx/0.1.0
+#
+# Redirects are done via Jekyll redirect-from  plugin. See:
+#   sources/scripts/create_redirect_md.py
+#   Makefile (redirect target)
+#  (on gh-pages branch) _layouts/docs_redirect.html
+
+dry_run=0
+for arg in "$@"; do
+    shift
+    case "$arg" in
+        "--dry-run") dry_run=1 ;;
+        "--help") echo "Usage $0 [--dry-run]"; exit 0 ;;
+    esac
+done
+
+repo_root=$(git rev-parse --show-toplevel)
+branch=$(git rev-parse --abbrev-ref HEAD)
+commit_id=$(git rev-parse --short HEAD)
+
+if ! release_tag=$(git describe --tags --exact-match HEAD 2>/dev/null); then
+    echo "No release tag found, building docs for master..."
+    redirects=(master)
+    release_tag="master"
+else
+    echo "Release tag $release_tag found, building docs for release..."
+    redirects=(latest master)
+fi
+
+echo "Installing torchx from $repo_root/torchx..."
+cd "$repo_root/torchx" || exit
+pip uninstall -y torchx
+python setup.py install
+
+torchx_ver=$(python -c "import torchx; print(torchx.__version__)")
+
+echo "Building torchx-$torchx_ver docs..."
+docs_dir=$repo_root/docs
+build_dir=$docs_dir/build
+cd "$docs_dir" || exit
+pip install -r requirements.txt
+make clean html
+echo "Doc build complete"
+
+if [ $dry_run -eq 1 ]; then
+    echo "*** dry-run mode, building only. See build artifacts in: $build_dir"
+    exit
+fi
+
+tmp_dir=/tmp/torchx_docs_tmp
+rm -rf "${tmp_dir:?}"
+
+echo "Checking out gh-pages branch..."
+gh_pages_dir="$tmp_dir/torchx_gh_pages"
+git clone -b gh-pages --single-branch [email protected]:pytorch/torchx.git  $gh_pages_dir
+
+echo "Copying doc pages for $torchx_ver into $gh_pages_dir..."
+rm -rf "${gh_pages_dir:?}/${torchx_ver:?}"
+cp -R "$build_dir/$torchx_ver/html" "$gh_pages_dir/$torchx_ver"
+
+for redirect in "${redirects[@]}"; do
+  echo "Copying redirects for $redirect -> $torchx_ver..."
+  rm -rf "${gh_pages_dir:?}/${redirect:?}"
+  cp -R "$build_dir/redirects" "$gh_pages_dir/$redirect"
+done
+
+if [ "$release_tag" != "master" ]; then
+    echo "Copying redirects for default(latest) -> $torchx_ver..."
+    cp -R "$build_dir/redirects/." "$gh_pages_dir"
+fi
+
+cd $gh_pages_dir || exit
+git add .
+git commit --quiet -m "[doc_push][$release_tag] built from $commit_id ($branch). Redirects: ${redirects[*]} -> $torchx_ver."

docs/requirements.txt

@@ -0,0 +1,4 @@
+sphinx
+-e git+http://github.com/pytorch/pytorch_sphinx_theme.git#egg=pytorch_sphinx_theme
+sphinxcontrib.katex
+matplotlib