Merge pull request #36 from WallarooLabs/2023.2.1_release

2023.2.1_release

Author: johnhansarickWallaroo

development/mlops_api/Wallaroo-MLOps-Tutorial.ipynb

@@ -1115,14 +1115,30 @@
     "\n",
     "### Upload Model to Workspace\n",
     "\n",
-    "Uploads a ML Model to a Wallaroo workspace via POST with `Content-Type: multipart/form-data`.\n",
+    "ML Models are uploaded to Wallaroo through the following endpoint:\n",
     "\n",
-    "* **Parameters**\n",
-    "  * **name** - (*REQUIRED string*): Name of the model\n",
-    "  * **visibility** - (*OPTIONAL string*): The visibility of the model as either `public` or `private`.\n",
-    "  * **workspace_id** - (*REQUIRED int*): The numerical id of the workspace to upload the model to.\n",
-    "  \n",
-    "Example:  This example will upload the sample file `ccfraud.onnx` to the workspace created in the [Create Workspace](#create-workspace) step as `apitestmodel`.  The model name will be saved as `exampleModelName` for use in other examples.  The id of the uploaded model will be saved as `example_model_id` for use in later examples."
+    "Models uploaded through this method that are not native runtimes are containerized within the Wallaroo instance then run by the Wallaroo engine.  See [Wallaroo MLOps API Essentials Guide: Pipeline Management]({{<ref \"wallaroo-mlops-api-essential-guide-pipelines\">}}) for details on pipeline configurations and deployments.\n",
+    "\n",
+    "For these models, the following inputs are required.\n",
+    "\n",
+    "* Endpoint:\n",
+    "  * `/v1/api/models/upload_and_convert`\n",
+    "* Headers:\n",
+    "  * **Content-Type**: `multipart/form-data`\n",
+    "* Parameters\n",
+    "  * **name** (*String* *Required*): The model name.\n",
+    "  * **visibility** (*String* *Required*): Either `public` or `private`.\n",
+    "  * **workspace_id** (*String* *Required*): The numerical ID of the workspace to upload the model to.\n",
+    "  * **conversion** (*String* *Required*):  The conversion parameters that include the following:\n",
+    "    * **framework** (*String* *Required*): The framework of the model being uploaded.  See the list of supported models for more details.\n",
+    "    * **python_version** (*String* *Required*):  The version of Python required for model.\n",
+    "    * **requirements**  (*String* *Required*):  Required libraries.  Can be `[]` if the requirements are default Wallaroo JupyterHub libraries.\n",
+    "    * **input_schema**  (*String* *Optional*): The input schema from the Apache Arrow `pyarrow.lib.Schema` format, encoded with `base64.b64encode`.  Only required for non-native runtime models.\n",
+    "    * **output_schema** (*String* *Optional*): The output schema from the Apache Arrow `pyarrow.lib.Schema` format, encoded with `base64.b64encode`.  Only required for non-native runtime models.\n",
+    "\n",
+    "#### Upload Native Runtime Model Example\n",
+    "\n",
+    "ONNX are always native runtimes.  The following example shows uploading an ONNX model to a Wallaroo instance using the `requests` library.  Note that the `input_schema` and `output_schema` encoded details are not required."
    ]
   },
   {
@@ -1160,31 +1176,96 @@
     }
    ],
    "source": [
-    "## upload model\n",
-    "\n",
-    "# Retrieve the token\n",
-    "headers = wl.auth.auth_header()\n",
+    " authorization header\n",
+    "headers = {'Authorization': 'Bearer abcdefg'}\n",
     "\n",
-    "apiRequest = f\"{APIURL}/v1/api/models/upload\"\n",
+    "apiRequest = f\"{APIURL}/v1/api/models/upload_and_convert\"\n",
     "\n",
-    "# Model name and file to use\n",
-    "display(f\"Sample model name: {model_name}\")\n",
-    "display(f\"Sample model file: {model_file_name}\")\n",
+    "framework='onnx'\n",
     "\n",
+    "model_name = f\"{suffix}ccfraud\"\n",
     "\n",
     "data = {\n",
-    "    \"name\":model_name,\n",
+    "    \"name\": model_name,\n",
     "    \"visibility\": \"public\",\n",
-    "    \"workspace_id\": example_workspace_id\n",
+    "    \"workspace_id\": workspaceId,\n",
+    "    \"conversion\": {\n",
+    "        \"framework\": framework,\n",
+    "        \"python_version\": \"3.8\",\n",
+    "        \"requirements\": []\n",
+    "    }\n",
     "}\n",
     "\n",
     "files = {\n",
-    "    'file': (model_name, open(model_file_name, 'rb'))\n",
+    "    \"metadata\": (None, json.dumps(data), \"application/json\"),\n",
+    "    'file': (model_name, open('./ccfraud.onnx', 'rb'), \"application/octet-stream\")\n",
     "    }\n",
     "\n",
     "\n",
-    "response = requests.post(apiRequest, files=files, data=data, headers=headers).json()\n",
-    "display(response)"
+    "response = requests.post(apiRequest, files=files, headers=headers).json()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "861a91ae",
+   "metadata": {},
+   "source": [
+    "#### Upload Converted Model Examples\n",
+    "\n",
+    "The following example shows uploading a Hugging Face model to a Wallaroo instance using the `requests` library.  Note that the `input_schema` and `output_schema` encoded details are required."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "c20c5ba5",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "input_schema = pa.schema([\n",
+    "    pa.field('inputs', pa.string()), # required\n",
+    "    pa.field('candidate_labels', pa.list_(pa.string(), list_size=2)), # required\n",
+    "    pa.field('hypothesis_template', pa.string()), # optional\n",
+    "    pa.field('multi_label', pa.bool_()), # optional\n",
+    "])\n",
+    "\n",
+    "output_schema = pa.schema([\n",
+    "    pa.field('sequence', pa.string()),\n",
+    "    pa.field('scores', pa.list_(pa.float64(), list_size=2)), # same as number of candidate labels, list_size can be skipped by may result in slightly worse performance\n",
+    "    pa.field('labels', pa.list_(pa.string(), list_size=2)), # same as number of candidate labels, list_size can be skipped by may result in slightly worse performance\n",
+    "])\n",
+    "\n",
+    "encoded_input_schema = base64.b64encode(\n",
+    "                bytes(input_schema.serialize())\n",
+    "            ).decode(\"utf8\")\n",
+    "\n",
+    "encoded_output_schema = base64.b64encode(\n",
+    "                bytes(output_schema.serialize())\n",
+    "            ).decode(\"utf8\")\n",
+    "\n",
+    "metadata = {\n",
+    "    \"name\": model_name,\n",
+    "    \"visibility\": \"private\",\n",
+    "    \"workspace_id\": workspace_id,\n",
+    "    \"conversion\": {\n",
+    "        \"framework\": framework,\n",
+    "        \"python_version\": \"3.8\",\n",
+    "        \"requirements\": []\n",
+    "    },\n",
+    "    \"input_schema\": encoded_input_schema,\n",
+    "    \"output_schema\": encoded_output_schema,\n",
+    "}\n",
+    "\n",
+    "headers = wl.auth.auth_header()\n",
+    "\n",
+    "files = {\n",
+    "    'metadata': (None, json.dumps(metadata), \"application/json\"),\n",
+    "    'file': (model_name, open(model_path,'rb'),'application/octet-stream')\n",
+    "}\n",
+    "\n",
+    "response = requests.post('https://{APIURL}/v1/api/models/upload_and_convert', \n",
+    "                         headers=headers, \n",
+    "                         files=files).json()"
    ]
   },
   {

development/sdk-install-guides/azure-ml-sdk-install/install-wallaroo-sdk-azureml-guide.ipynb

@@ -100,7 +100,7 @@
     "    * **IMPORTANT NOTE**:  The version of the Wallaroo SDK should match the Wallaroo instance.  For example, this example connects to a Wallaroo Enterprise version `2023.1` instance, so the SDK version should be `wallaroo==2023.1.0`.\n",
     "\n",
     "    ```bash\n",
-    "    pip install wallaroo==2023.2.0\n",
+    "    pip install wallaroo==2023.2.1rc2\n",
     "    ```"
    ]
   },

development/sdk-install-guides/google-vertex-sdk-install/install-wallaroo-sdk-google-vertex-guide.ipynb

@@ -95,7 +95,7 @@
     "    * **IMPORTANT NOTE**:  The version of the Wallaroo SDK should match the Wallaroo instance.  For example, this example connects to a Wallaroo Enterprise version `2023.1` instance, so the SDK version should be `wallaroo==2023.1.0`.\n",
     "\n",
     "    ```bash\n",
-    "    pip install wallaroo==2023.2.0\n",
+    "    pip install wallaroo==2023.2.1rc2\n",
     "    ```"
    ]
   },

development/sdk-install-guides/standard-install/install-wallaroo-sdk-standard-guide.ipynb

@@ -95,7 +95,7 @@
     "    * **IMPORTANT NOTE**:  The version of the Wallaroo SDK should match the Wallaroo instance.  For example, this example connects to a Wallaroo Enterprise version `2023.1` instance, so the SDK version should be `wallaroo==2023.1.0`.\n",
     "\n",
     "    ```bash\n",
-    "    pip install wallaroo==2023.2.0\n",
+    "    pip install wallaroo==2023.2.1rc2\n",
     "    ```"
    ]
   },