[Project] Implementing Project CLI #5397

simon-mo · 2019-08-07T20:31:51Z

What do these changes do?

Related issue number

Linter

I've run scripts/format.sh to lint the changes in this PR.

richardliaw · 2019-08-07T22:45:26Z

python/ray/projects/scripts.py

+            print(proj)
+    except (jsonschema.exceptions.ValidationError, ValueError) as e:
+        print("💔 Validation failed for the following reason", file=sys.stderr)
+        raise e


try raising click exceptions; you won't see the stack trace

pcmoritz · 2019-08-07T23:30:54Z

python/ray/projects/scripts.py

+PROJECT_DIR = ".rayproject"
+PROJECT_YAML = os.path.join(PROJECT_DIR, "project.yaml")
+CLUSTER_YAML = os.path.join(PROJECT_DIR, "cluster.yaml")
+REQ_TXT = os.path.join(PROJECT_DIR, "requirements.txt")


Let's go with REQUIREMENTS_TXT here to not be too cryptic :)

pcmoritz · 2019-08-07T23:31:28Z

python/ray/projects/scripts.py

+import logging
+import os
+import sys
+from shutil import copyfile


Is this available by default? Are we using it anywhere else?

Yes. The following files use it:

python/setup.py rllib/tests/test_checkpoint_restore.py rllib/tests/test_io.py python/ray/projects/scripts.py python/ray/tests/test_basic.py python/ray/tests/test_autoscaler.py python/ray/tests/test_tempfile.py python/ray/tune/trainable.py python/ray/tune/tests/test_tune_restore.py python/ray/tune/tests/test_trial_scheduler.py python/ray/tune/tests/test_experiment_analysis.py python/ray/tune/tests/test_trial_runner.py python/ray/tune/tests/test_cluster.py python/ray/tune/schedulers/pbt.py

I think we can safely assume it exists

pcmoritz · 2019-08-07T23:32:02Z

python/ray/projects/schema.json

+    "name",
+    "cluster"
+  ]
+}


We should have trailing newlines (also in the other files, maybe you can configure your editor to add it)

pcmoritz · 2019-08-07T23:32:42Z

python/ray/projects/scripts.py

+#     requirements.txt
+_THIS_FILE_DIR = os.path.split(os.path.abspath(__file__))[0]
+_TEMPLATE_DIR = os.path.join(_THIS_FILE_DIR, "templates")
+PROJECT_TMPL = os.path.join(_TEMPLATE_DIR, "project_template.yaml")


I'd go with PROJECT_TEMPLATE here

pcmoritz · 2019-08-07T23:34:09Z

python/setup.py

@@ -43,6 +46,12 @@
    "ray/autoscaler/local/example-full.yaml",
 ]

+ray_project_files = [


pcmoritz · 2019-08-07T23:34:57Z

python/ray/projects/templates/project_template.yaml

+  # dockerimage: The docker image to be used to run the project in. Like ubuntu:18.04
+  requirements: {{requirements}}
+
+  shell: # shell commands to be ran for environment setup.


shell -> # Shell

pcmoritz · 2019-08-07T23:35:44Z

python/ray/projects/templates/project_template.yaml

+    - echo "Setting up the environment"
+
+commands:
+  - name: first command


command names shouldn't include spaces (replace with first-command?)

pcmoritz · 2019-08-07T23:38:34Z

python/ray/projects/scripts.py

+    "--verbose", help="If set, print the validated file", is_flag=True)
+def validate(verbose):
+    try:
+        proj = ray.projects.load_project(os.getcwd())


proj -> project

pcmoritz · 2019-08-07T23:39:54Z

python/ray/projects/scripts.py

+        requirements = REQ_TXT
+
+    with open(PROJECT_TMPL) as f:
+        proj_tmpl = f.read()


proj_tmpl -> project_template

agree here - in general, would be good to be more verbose

AmplabJenkins · 2019-08-07T23:42:33Z

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/16107/
Test PASSed.

AmplabJenkins · 2019-08-08T01:57:24Z

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/16114/
Test PASSed.

richardliaw · 2019-08-08T19:55:14Z

python/ray/projects/scripts.py

+        cluster_yaml = CLUSTER_YAML
+
+    if requirements is None:
+        logging.warn("Using default requirements.txt")


logger = logging.getLogger?

richardliaw · 2019-08-08T19:55:51Z

python/ray/projects/scripts.py

+REQ_TXT_TMPL = os.path.join(_TEMPLATE_DIR, "requirements.txt")
+
+
+@click.group("project", help="Commands working with ray project")


this needs a better help string. @pcmoritz?

Actually, can you mark this explicitly as experimental?

richardliaw · 2019-08-08T19:57:38Z

python/ray/projects/scripts.py

@@ -0,0 +1,101 @@
+import logging


python/ray/projects/scripts.py

richardliaw

Can you add a page to the docs for this marking it as experimental?

simon-mo · 2019-08-08T20:04:58Z

@richardliaw I believe @pcmoritz is adding docs in following up PR.

Experimental is marked here:

Usage: ray [OPTIONS] COMMAND [ARGS]...

Options:
  --logging-level TEXT   The logging level threshold, choices=['debug',
                         'info', 'warning', 'error', 'critical'],
                         default='info'
  --logging-format TEXT  The logging format. default='%(asctime)s
                         %(levelname)s %(filename)s:%(lineno)s -- %(message)s'
  --help                 Show this message and exit.

Commands:
...
  project           [Experimental] Commands working with ray project
  rsync-down
  rsync-up
  rsync_down
  rsync_up
  session           [Experimental] Commands working with ray session
...

AmplabJenkins · 2019-08-08T23:39:11Z

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/16147/
Test FAILed.

AmplabJenkins · 2019-08-09T00:18:46Z

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/16151/
Test FAILed.

AmplabJenkins · 2019-08-09T00:54:54Z

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/16152/
Test PASSed.

AmplabJenkins · 2019-08-09T01:08:06Z

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/16154/
Test PASSed.

AmplabJenkins · 2019-08-09T03:21:41Z

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/16155/
Test PASSed.

AmplabJenkins · 2019-08-09T06:35:22Z

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/16165/
Test PASSed.

AmplabJenkins · 2019-08-09T07:28:28Z

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/16167/
Test PASSed.

simon-mo added 2 commits August 7, 2019 13:31

Fix yaml loader warning; format json

85a7f6f

Add project validate, create

56c06c3

richardliaw reviewed Aug 7, 2019

View reviewed changes

Use click exception

3e227e9

simon-mo requested a review from pcmoritz August 7, 2019 22:59

pcmoritz reviewed Aug 7, 2019

View reviewed changes

python/setup.py

@@ -43,6 +46,12 @@

"ray/autoscaler/local/example-full.yaml",

]

ray_project_files = [

Copy link

Contributor

pcmoritz Aug 7, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!

pcmoritz reviewed Aug 7, 2019

View reviewed changes

simon-mo marked this pull request as ready for review August 8, 2019 19:16

richardliaw reviewed Aug 8, 2019

View reviewed changes

python/ray/projects/scripts.py

@@ -0,0 +1,101 @@

import logging

Copy link

Contributor

richardliaw Aug 8, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

py2to3

richardliaw reviewed Aug 8, 2019

View reviewed changes

python/ray/projects/scripts.py Show resolved Hide resolved

Address Comments

df17da8

richardliaw reviewed Aug 8, 2019

View reviewed changes

Mark project and session commands as experimental

d993a3b

simon-mo requested a review from pcmoritz August 8, 2019 20:05

simon-mo changed the title ~~[WIP] Implementing Project CLI~~ [Project] Implementing Project CLI Aug 8, 2019

simon-mo and others added 3 commits August 8, 2019 13:19

Py2to3

ebd0b7a

Verbose variable naming

61b00ec

add newlines

c556c5c

fix tests

5b6213a

pcmoritz approved these changes Aug 8, 2019

View reviewed changes

some small style fixes

bd584fd

Update project_template.yaml

2eb6d7f

pcmoritz merged commit d9b45cc into ray-project:master Aug 9, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Project] Implementing Project CLI #5397

[Project] Implementing Project CLI #5397

simon-mo commented Aug 7, 2019

richardliaw Aug 7, 2019

pcmoritz Aug 7, 2019

pcmoritz Aug 7, 2019

simon-mo Aug 8, 2019

pcmoritz Aug 7, 2019

pcmoritz Aug 7, 2019

pcmoritz Aug 7, 2019

pcmoritz Aug 7, 2019

pcmoritz Aug 7, 2019

pcmoritz Aug 7, 2019

pcmoritz Aug 7, 2019

richardliaw Aug 8, 2019

AmplabJenkins commented Aug 7, 2019

AmplabJenkins commented Aug 8, 2019

richardliaw Aug 8, 2019

richardliaw Aug 8, 2019

richardliaw Aug 8, 2019

richardliaw Aug 8, 2019

richardliaw left a comment

simon-mo commented Aug 8, 2019

AmplabJenkins commented Aug 8, 2019

AmplabJenkins commented Aug 9, 2019

AmplabJenkins commented Aug 9, 2019

AmplabJenkins commented Aug 9, 2019

AmplabJenkins commented Aug 9, 2019

AmplabJenkins commented Aug 9, 2019

AmplabJenkins commented Aug 9, 2019

		REQ_TXT_TMPL = os.path.join(_TEMPLATE_DIR, "requirements.txt")


		@click.group("project", help="Commands working with ray project")

[Project] Implementing Project CLI #5397

[Project] Implementing Project CLI #5397

Conversation

simon-mo commented Aug 7, 2019

What do these changes do?

Related issue number

Linter

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shell -> # Shell

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AmplabJenkins commented Aug 7, 2019

AmplabJenkins commented Aug 8, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

richardliaw left a comment

Choose a reason for hiding this comment

simon-mo commented Aug 8, 2019

AmplabJenkins commented Aug 8, 2019

AmplabJenkins commented Aug 9, 2019

AmplabJenkins commented Aug 9, 2019

AmplabJenkins commented Aug 9, 2019

AmplabJenkins commented Aug 9, 2019

AmplabJenkins commented Aug 9, 2019

AmplabJenkins commented Aug 9, 2019