Polish changes (#1656)

vishalbollu · web-flow · commit bdc2693d4a68 · 2020-12-08T15:38:49.000-05:00
diff --git a/cli/cmd/delete.go b/cli/cmd/delete.go
@@ -95,7 +95,7 @@ var _deleteCmd = &cobra.Command{
 			if err != nil {
 				exit.Error(err)
 			}
-			fmt.Println(string(bytes))
+			fmt.Print(string(bytes))
 			return
 		}
 
diff --git a/cli/cmd/deploy.go b/cli/cmd/deploy.go
@@ -119,7 +119,7 @@ var _deployCmd = &cobra.Command{
 			if err != nil {
 				exit.Error(err)
 			}
-			fmt.Println(string(bytes))
+			fmt.Print(string(bytes))
 		case flags.MixedOutputType:
 			err := mixedPrint(deployResults)
 			if err != nil {
diff --git a/cli/cmd/env.go b/cli/cmd/env.go
@@ -134,7 +134,7 @@ var _envListCmd = &cobra.Command{
 			if err != nil {
 				exit.Error(err)
 			}
-			fmt.Println(string(bytes))
+			fmt.Print(string(bytes))
 			return
 		}
 
diff --git a/cli/cmd/lib_realtime_apis.go b/cli/cmd/lib_realtime_apis.go
@@ -68,8 +68,6 @@ func realtimeAPITable(realtimeAPI schema.APIResponse, env cliconfig.Environment)
 
 	out += "\n" + console.Bold("endpoint: ") + realtimeAPI.Endpoint
 
-	out += fmt.Sprintf("\n%s curl %s -X POST -H \"Content-Type: application/json\" -d @sample.json\n", console.Bold("example curl:"), realtimeAPI.Endpoint)
-
 	if !(realtimeAPI.Spec.Predictor.Type == userconfig.PythonPredictorType && realtimeAPI.Spec.Predictor.ModelPath == nil && realtimeAPI.Spec.Predictor.Models == nil) {
 		out += "\n" + describeModelInput(realtimeAPI.Status, realtimeAPI.Spec.Predictor, realtimeAPI.Endpoint)
 	}
diff --git a/cli/cmd/lib_traffic_splitters.go b/cli/cmd/lib_traffic_splitters.go
@@ -17,7 +17,6 @@ limitations under the License.
 package cmd
 
 import (
-	"fmt"
 	"strings"
 	"time"
 
@@ -51,7 +50,6 @@ func trafficSplitterTable(trafficSplitter schema.APIResponse, env cliconfig.Envi
 
 	out += "\n" + console.Bold("last updated: ") + libtime.SinceStr(&lastUpdated)
 	out += "\n" + console.Bold("endpoint: ") + trafficSplitter.Endpoint
-	out += fmt.Sprintf("\n%s curl %s -X POST -H \"Content-Type: application/json\" -d @sample.json\n", console.Bold("example curl:"), trafficSplitter.Endpoint)
 
 	out += "\n" + apiHistoryTable(trafficSplitter.APIVersions)
 
diff --git a/cli/cmd/patch.go b/cli/cmd/patch.go
@@ -82,7 +82,7 @@ var _patchCmd = &cobra.Command{
 			if err != nil {
 				exit.Error(err)
 			}
-			fmt.Println(string(bytes))
+			fmt.Print(string(bytes))
 		case flags.PrettyOutputType:
 			message := deployMessage(deployResults, env.Name)
 			if didAnyResultsError(deployResults) {
diff --git a/cli/cmd/refresh.go b/cli/cmd/refresh.go
@@ -73,7 +73,7 @@ var _refreshCmd = &cobra.Command{
 			if err != nil {
 				exit.Error(err)
 			}
-			fmt.Println(string(bytes))
+			fmt.Print(string(bytes))
 			return
 		}
 
diff --git a/cli/cmd/root.go b/cli/cmd/root.go
@@ -182,7 +182,6 @@ func Execute() {
 
 	updateRootUsage()
 
-	printLeadingNewLine()
 	_rootCmd.Execute()
 
 	exit.Ok()
@@ -250,18 +249,11 @@ func envStringIfNotSpecified(envName string, cmd *cobra.Command) (string, error)
 	return "", nil
 }
 
-func printLeadingNewLine() {
-	if len(os.Args) == 3 && os.Args[1] == "completion" {
-		return
-	}
-	fmt.Println("")
-}
-
 func mixedPrint(a interface{}) error {
 	jsonBytes, err := libjson.Marshal(a)
 	if err != nil {
 		return err
 	}
-	fmt.Println(fmt.Sprintf("~~cortex~~%s~~cortex~~", base64.StdEncoding.EncodeToString(jsonBytes)))
+	fmt.Print(fmt.Sprintf("~~cortex~~%s~~cortex~~", base64.StdEncoding.EncodeToString(jsonBytes)))
 	return nil
 }
diff --git a/dev/deploy_test.py b/dev/deploy_test.py
@@ -37,7 +37,7 @@ def predict(self, payload):
         return self.model(payload["text"])[0]
 
 
-api = cx.deploy(
+api = cx.create_api(
     api_config,
     predictor=PythonPredictor,
     requirements=["torch", "transformers"],
diff --git a/dev/generate_cli_md.sh b/dev/generate_cli_md.sh
@@ -57,7 +57,7 @@ for cmd in "${commands[@]}"; do
   echo '' >> $out_file
   echo "### ${cmd}" >> $out_file
   echo '' >> $out_file
-  echo -n '```text' >> $out_file
+  echo '```text' >> $out_file
   $ROOT/bin/cortex help ${cmd} >> $out_file
   echo '```' >> $out_file
 done
diff --git a/dev/generate_python_client_md.sh b/dev/generate_python_client_md.sh
@@ -45,7 +45,7 @@ sed -i "/\* \[Client](#cortex\.client\.Client)/d" $ROOT/docs/miscellaneous/pytho
 sed -i "s/\* \[cortex\.client](#cortex\.client)/\* [cortex\.client\.Client](#cortex-client-client)/g" $ROOT/docs/miscellaneous/python-client.md
 sed -i "s/# cortex\.client/# cortex\.client\.Client/g" $ROOT/docs/miscellaneous/python-client.md
 # delete unnecessary section body
-sed -i "/# cortex.client.Client/,/## deploy/{//!d}" $ROOT/docs/miscellaneous/python-client.md
+sed -i "/# cortex.client.Client/,/## create\\\_api/{//!d}" $ROOT/docs/miscellaneous/python-client.md
 sed -i "s/# cortex.client.Client/# cortex.client.Client\n/g" $ROOT/docs/miscellaneous/python-client.md
 
 # fix table of contents links
@@ -61,7 +61,7 @@ sed -i 's/[[:space:]]*$//' $ROOT/docs/miscellaneous/python-client.md
 truncate -s -1 $ROOT/docs/miscellaneous/python-client.md
 
 # Cortex version comment
-sed -i "s/^## deploy/## deploy\n\n<!-- CORTEX_VERSION_MINOR x5 -->/g" $ROOT/docs/miscellaneous/python-client.md
+sed -i "s/^## create\\\_api/## create\\\_api\n\n<!-- CORTEX_VERSION_MINOR x5 -->/g" $ROOT/docs/miscellaneous/python-client.md
 
 pip3 uninstall -y cortex
 rm -rf $ROOT/pkg/workloads/cortex/client/cortex.egg-info
diff --git a/docs/miscellaneous/python-client.md b/docs/miscellaneous/python-client.md
@@ -9,7 +9,7 @@ _WARNING: you are on the master branch, please refer to the docs on the branch t
   * [env\_list](#env_list)
   * [env\_delete](#env_delete)
 * [cortex.client.Client](#cortex-client-client)
-  * [deploy](#deploy)
+  * [create\_api](#create_api)
   * [get\_api](#get_api)
   * [list\_apis](#list_apis)
   * [get\_job](#get_job)
@@ -104,12 +104,12 @@ Delete an environment configured on this machine.
 
 # cortex.client.Client
 
-## deploy
+## create\_api
 
 <!-- CORTEX_VERSION_MINOR x5 -->
 
 ```python
- | deploy(api_spec: dict, predictor=None, requirements=[], conda_packages=[], project_dir: Optional[str] = None, force: bool = True, wait: bool = False) -> list
+ | create_api(api_spec: dict, predictor=None, requirements=[], conda_packages=[], project_dir: Optional[str] = None, force: bool = True, wait: bool = False) -> list
 ```
 
 Deploy an API.
diff --git a/examples/pytorch/text-generator/README.md b/examples/pytorch/text-generator/README.md
@@ -59,7 +59,7 @@ api_spec = {
   }
 }
 
-cx_local.deploy(api_spec, project_dir=".", wait=True)
+cx_local.create_api(api_spec, project_dir=".", wait=True)
 ```
 
 ## Consume your API
@@ -126,7 +126,7 @@ api_spec = {
   }
 }
 
-cx_aws.deploy(api_spec, project_dir=".")
+cx_aws.create_api(api_spec, project_dir=".")
 ```
 
 Monitor the status of your APIs using `cortex get` using your CLI:
@@ -169,7 +169,7 @@ api_spec = {
   }
 }
 
-cx_aws.deploy(api_spec, project_dir=".")
+cx_aws.create_api(api_spec, project_dir=".")
 ```
 
 As your new API is initializing, the old API will continue to respond to prediction requests. Once the API's status becomes "live" (with one up-to-date replica), traffic will be routed to the updated version. You can track the status of your API using `cortex get`:
diff --git a/examples/pytorch/text-generator/deploy.ipynb b/examples/pytorch/text-generator/deploy.ipynb
@@ -39,7 +39,7 @@
     "  }\n",
     "}\n",
     "\n",
-    "cx.deploy(api_spec, project_dir=\".\", wait=True)"
+    "cx.create_api(api_spec, project_dir=\".\", wait=True)"
    ]
   },
   {
diff --git a/pkg/workloads/cortex/client/cortex/binary/__init__.py b/pkg/workloads/cortex/client/cortex/binary/__init__.py
@@ -67,29 +67,36 @@ def run_cli(
 
     output = ""
     result = ""
-    result_found = False
+    processing_result = False
+    processed_result = False
 
     for c in iter(lambda: process.stdout.read(1), ""):
         output += c
+
         if mixed_output:
-            if output[-2:] == "\n~":
-                result_found = True
-                result = "~"
-                output = output[:-1]
-            if result_found:
+            if output[-2:] == "\n~" or output == "~":
+                processing_result = True
                 output = output[:-1]
-                if c == "\n":
-                    result_found = False
+            if processing_result:
+                result += c
+                if (
+                    result[: len(MIXED_CORTEX_MARKER)] == MIXED_CORTEX_MARKER
+                    and result[-len(MIXED_CORTEX_MARKER) :] == MIXED_CORTEX_MARKER
+                    and len(result) > len(MIXED_CORTEX_MARKER)
+                ):
                     result = result[len(MIXED_CORTEX_MARKER) : -len(MIXED_CORTEX_MARKER)]
                     result = base64.b64decode(result).decode("utf8")
-                else:
-                    result += c
+                    processed_result = True
 
+                output = output[:-1]
         if not hide_output:
-            if (not mixed_output) or (mixed_output and not result_found):
+            if (not mixed_output) or (mixed_output and not processing_result):
                 sys.stdout.write(c)
                 sys.stdout.flush()
 
+        if processed_result == True:
+            processing_result = False
+
     process.wait()
 
     if process.returncode == 0:
diff --git a/pkg/workloads/cortex/client/cortex/client.py b/pkg/workloads/cortex/client/cortex/client.py
@@ -45,7 +45,7 @@ def __init__(self, env: dict):
         self.env_name = env["name"]
 
     # CORTEX_VERSION_MINOR x5
-    def deploy(
+    def create_api(
         self,
         api_spec: dict,
         predictor=None,

Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ var _deleteCmd = &cobra.Command{`
`95`	`95`	`if err != nil {`
`96`	`96`	`exit.Error(err)`
`97`	`97`	`}`
`98`		`- fmt.Println(string(bytes))`
	`98`	`+ fmt.Print(string(bytes))`
`99`	`99`	`return`
`100`	`100`	`}`
`101`	`101`
Original file line number	Diff line number	Diff line change
`@@ -119,7 +119,7 @@ var _deployCmd = &cobra.Command{`
`119`	`119`	`if err != nil {`
`120`	`120`	`exit.Error(err)`
`121`	`121`	`}`
`122`		`- fmt.Println(string(bytes))`
	`122`	`+ fmt.Print(string(bytes))`
`123`	`123`	`case flags.MixedOutputType:`
`124`	`124`	`err := mixedPrint(deployResults)`
`125`	`125`	`if err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -134,7 +134,7 @@ var _envListCmd = &cobra.Command{`
`134`	`134`	`if err != nil {`
`135`	`135`	`exit.Error(err)`
`136`	`136`	`}`
`137`		`- fmt.Println(string(bytes))`
	`137`	`+ fmt.Print(string(bytes))`
`138`	`138`	`return`
`139`	`139`	`}`
`140`	`140`
Original file line number	Diff line number	Diff line change
`@@ -68,8 +68,6 @@ func realtimeAPITable(realtimeAPI schema.APIResponse, env cliconfig.Environment)`
`68`	`68`
`69`	`69`	`out += "\n" + console.Bold("endpoint: ") + realtimeAPI.Endpoint`
`70`	`70`
`71`		`- out += fmt.Sprintf("\n%s curl %s -X POST -H \"Content-Type: application/json\" -d @sample.json\n", console.Bold("example curl:"), realtimeAPI.Endpoint)`
`72`		`-`
`73`	`71`	`if !(realtimeAPI.Spec.Predictor.Type == userconfig.PythonPredictorType && realtimeAPI.Spec.Predictor.ModelPath == nil && realtimeAPI.Spec.Predictor.Models == nil) {`
`74`	`72`	`out += "\n" + describeModelInput(realtimeAPI.Status, realtimeAPI.Spec.Predictor, realtimeAPI.Endpoint)`
`75`	`73`	`}`
Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ var _patchCmd = &cobra.Command{`
`82`	`82`	`if err != nil {`
`83`	`83`	`exit.Error(err)`
`84`	`84`	`}`
`85`		`- fmt.Println(string(bytes))`
	`85`	`+ fmt.Print(string(bytes))`
`86`	`86`	`case flags.PrettyOutputType:`
`87`	`87`	`message := deployMessage(deployResults, env.Name)`
`88`	`88`	`if didAnyResultsError(deployResults) {`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ var _refreshCmd = &cobra.Command{`
`73`	`73`	`if err != nil {`
`74`	`74`	`exit.Error(err)`
`75`	`75`	`}`
`76`		`- fmt.Println(string(bytes))`
	`76`	`+ fmt.Print(string(bytes))`
`77`	`77`	`return`
`78`	`78`	`}`
`79`	`79`