[tune] Contributor Guide and Design Page (#4716)

* Move setup script out * some changes * Finished Contributor guide * some comments to the design * move * Apply suggestions from code review Co-Authored-By: richardliaw <rliaw@berkeley.edu> * sourcecode * comments
2026-06-28 11:21:15 +08:00 · 2019-05-05 00:04:13 -07:00
parent d81e71e297
commit f2faf5ce75
7 changed files with 196 additions and 1 deletions
@@ -0,0 +1,59 @@
+#!/usr/bin/env python
+"""This script allows you to develop RLlib without needing to compile Ray."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+import argparse
+import click
+import os
+import subprocess
+
+import ray
+
+
+def do_link(package, force=False):
+    package_home = os.path.abspath(
+        os.path.join(ray.__file__, "../{}".format(package)))
+    local_home = os.path.abspath(
+        os.path.join(__file__, "../../{}".format(package)))
+    assert os.path.isdir(package_home), package_home
+    assert os.path.isdir(local_home), local_home
+    if not force and not click.confirm(
+            "This will replace:\n  {}\nwith a symlink to:\n  {}".format(
+                package_home, local_home),
+            default=True):
+        return
+    if os.access(os.path.dirname(package_home), os.W_OK):
+        subprocess.check_call(["rm", "-rf", package_home])
+        subprocess.check_call(["ln", "-s", local_home, package_home])
+    else:
+        print("You don't have write permission to {}, using sudo:".format(
+            package_home))
+        subprocess.check_call(["sudo", "rm", "-rf", package_home])
+        subprocess.check_call(["sudo", "ln", "-s", local_home, package_home])
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        description="Setup dev.")
+    parser.add_argument(
+        "--yes", action="store_true", help="Don't ask for confirmation.")
+    args = parser.parse_args()
+
+    do_link("rllib", force=args.yes)
+    do_link("tune", force=args.yes)
+    do_link("autoscaler", force=args.yes)
+    do_link("scripts", force=args.yes)
+    do_link("internal", force=args.yes)
+    do_link("experimental", force=args.yes)
+    print("Created links.\n\nIf you run into issues initializing Ray, please "
+          "ensure that your local repo and the installed Ray are in sync "
+          "(pip install -U the latest wheels at "
+          "https://ray.readthedocs.io/en/latest/installation.html, "
+          "and ensure you are up-to-date on the master branch on git).\n\n"
+          "Note that you may need to delete the package symlinks when pip "
+          "installing new Ray versions to prevent pip from overwriting files "
+          "in your git repo.")