Update readme and experiments parameters; minor other changes.

Author: BartoszCki

Pipfile

@@ -16,3 +16,4 @@ click = "*"
 [dev-packages]
 twine = "*"
 pypandoc = "*"
+pytest = "*"

Pipfile.lock

@@ -237,6 +237,19 @@ It is based off the Google docker image `gcr.io/tensorflow/tensorflow:1.5.0-gpu`
 
 A Dockerfile for building this container image is [here](https://github.com/Paperspace/tensorflow-python/).
 
+
+Create experiment
+=================
+To create new experiment use 
+```.env
+paperspace-python experiments create [type] [--options]
+```
+The two available experiment types are `singlenode` and `multinode`.
+
+For a full list of available options run `paperspace experiments [type] --help`. 
+Note that some options are required to create new experiment.
+
+
 Other examples
 ==============
 See the scripts in the `tests` folder for other examples.

README.md

@@ -18,7 +18,7 @@ def convert(self, value, param, ctx):
         return self.type_map[value]
 
 
-EXPERIMENT_TYPES_MAP = {
+MULTI_NODE_EXPERIMENT_TYPES_MAP = {
     "GRPC": constants.EXPERIMENT_TYPE_GRPC_MULTI_NODE_ID,
     "MPI": constants.EXPERIMENT_TYPE_MPI_MULTI_NODE_ID,
 }
@@ -29,11 +29,11 @@ def json_string(val):
     return json.loads(val)
 
 
-def del_if_value_is_none(d):
+def del_if_value_is_none(dict_):
     """Remove all elements with value == None"""
-    for key, val in list(d.items()):
+    for key, val in list(dict_.items()):
         if val is None:
-            del d[key]
+            del dict_[key]
 
 
 @click.group()
@@ -51,8 +51,22 @@ def create():
     pass
 
 
-def common_expepriments_create_options(f):
+def common_experiments_create_options(f):
     options = [
+        click.option(
+            "--projectHandle",
+            "projectHandle",
+        ),
+        click.option(
+            "--projectId",
+            "projectId",
+            type=int,
+        ),
+        click.option(
+            "--triggerEventId",
+            "triggerEventId",
+            type=int,
+        ),
         click.option(
             "--experimentEnv",
             "experimentEnv",
@@ -89,11 +103,11 @@ def common_expepriments_create_options(f):
 
 
 @create.command(name="multinode")
-@common_expepriments_create_options
+@common_experiments_create_options
 @click.option(
     "--experimentTypeId",
     "experimentTypeId",
-    type=ChoiceType(EXPERIMENT_TYPES_MAP, case_sensitive=False),
+    type=ChoiceType(MULTI_NODE_EXPERIMENT_TYPES_MAP, case_sensitive=False),
     required=True,
 )
 @click.option(
@@ -172,7 +186,7 @@ def multi_node(**kwargs):
 
 
 @create.command(name="singlenode")
-@common_expepriments_create_options
+@common_experiments_create_options
 @click.option(
     "--container",
     required=True,

paperspace/cli.py

@@ -1,6 +1,6 @@
-from paperspace import config, version, logger
-
+from paperspace import version, logger
 from paperspace.client import API
+from paperspace.config import config
 
 default_headers = {"x-api-key": config.PAPERSPACE_API_KEY,
                    "ps_client_name": "paperspace-python",
@@ -22,5 +22,6 @@ def _log_response(response, success_msg, error_msg):
 
 
 def create_experiments(json, api=experiments_api):
-    response = api.post("/experiments/", json=json, params={"accessToken": config.PAPERSPACE_API_KEY})
+    response = api.post("/experiments/", json=json)
+    logger.debug(response.content)
     _log_response(response, "Experiment created", "Unknown error while creating experiment")

paperspace/commands.py

@@ -1,12 +1,27 @@
+import json
 import os
 
-_DEFAULT_PAPERSPACE_API_KEY = ""
+
+# TODO: this function is copy-pasted from login.py;
+#  there is something weird going one with imports in __init__.py and I'm unable to import apikey now
+def apikey():
+    paperspace_dir = os.path.expanduser('~/.paperspace')
+    config_path = os.path.join(paperspace_dir, 'config.json')
+    if os.path.exists(config_path):
+        config_data = json.load(open(config_path))
+        if config_data and 'apiKey' in config_data:
+            return config_data['apiKey']
+    return ''
+
+
+_DEFAULT_PAPERSPACE_API_KEY = apikey()
 _DEFAULT_CONFIG_HOST = "https://api.paperspace.io"
 _DEFAULT_CONFIG_LOG_HOST = "https://logs.paperspace.io"
-_DEFAULT_CONFIG_EXPERIMENTS_HOST = "https://"  # TODO: fill this
+_DEFAULT_CONFIG_EXPERIMENTS_HOST = "https://services.paperspace.io/experiments/v1/"  # TODO: validate this
 
 
 class config(object):
+    DEBUG = os.environ.get("PAPERSPACE_CLI_DEBUG") in ("true", "1")
     PAPERSPACE_API_KEY = os.environ.get("PAPERSPACE_API_KEY", _DEFAULT_PAPERSPACE_API_KEY)
     CONFIG_HOST = os.environ.get("PAPERSPACE_CONFIG_HOST", _DEFAULT_CONFIG_HOST)
     CONFIG_LOG_HOST = os.environ.get("PAPERSPACE_CONFIG_LOG_HOST", _DEFAULT_CONFIG_LOG_HOST)

paperspace/config.py

@@ -1,6 +1,8 @@
 import click
 from six import string_types
 
+from .config import config
+
 
 def log(*messages, **kwargs):
     error = kwargs.get("error", False)
@@ -26,3 +28,8 @@ def log_error_response(data):
             for v in val:
                 msg = "{}: {}".format(key, str(v))
                 log(msg, error=True)
+
+
+def debug(*messages):
+    if config.DEBUG:
+        log(*messages)

paperspace/logger.py

@@ -4,6 +4,7 @@
 import requests
 from six.moves import input
 
+from paperspace import logger
 from .config import *
 from .method import requests_exception_to_error_obj, response_error_check, status_code_to_error_obj
 
@@ -52,6 +53,7 @@ def login(email=None, password=None, apiToken=None):
     try:
         r = requests.request('post', config.CONFIG_HOST + '/users/login',
                              json=params)
+        logger.debug(r.content)
     except requests.exceptions.RequestException as e:
         res = requests_exception_to_error_obj(e)
     else: