qwak-sdk 0.5.61__tar.gz → 0.5.63__tar.gz

{qwak_sdk-0.5.61 → qwak_sdk-0.5.63}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qwak-sdk
-Version: 0.5.61
+Version: 0.5.63
 Summary: Qwak SDK and CLI for qwak models
 License: Apache-2.0
 Keywords: mlops,ml,deployment,serving,model
@@ -19,7 +19,8 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Provides-Extra: batch
 Provides-Extra: feedback
-Requires-Dist: boto3 (>=1.24.116,<2.0.0) ; extra == "batch" or extra == "feedback"
+Provides-Extra: local-deployment
+Requires-Dist: boto3 (>=1.24.116,<2.0.0) ; extra == "batch" or extra == "feedback" or extra == "local-deployment"
 Requires-Dist: cookiecutter
 Requires-Dist: croniter (==1.4.1)
 Requires-Dist: gitpython (>=2.1.0)
@@ -28,8 +29,9 @@ Requires-Dist: pandas (<1.4) ; (python_full_version >= "3.7.1" and python_versio
 Requires-Dist: pandas (>=1.4.3,<2.0.0) ; (python_version >= "3.8" and python_version < "3.10") and (extra == "batch" or extra == "feedback")
 Requires-Dist: pyarrow (>=6.0.0,<11.0.0) ; extra == "batch"
 Requires-Dist: python-json-logger (>=2.0.2)
-Requires-Dist: qwak-core (==0.3.85)
+Requires-Dist: qwak-core (==0.3.143)
 Requires-Dist: qwak-inference (>=0.1,<0.2)
+Requires-Dist: rich (>=13.0.0)
 Requires-Dist: tabulate (>=0.8.0)
 Requires-Dist: yaspin (>=2.0.0)
 Project-URL: Home page, https://www.qwak.com/

{qwak_sdk-0.5.61 → qwak_sdk-0.5.63}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "qwak-sdk"
-version = "0.5.61"
+version = "0.5.63"
 description = "Qwak SDK and CLI for qwak models"
 authors = ["Qwak <info@qwak.com>"]
 readme = "README.md"
@@ -27,12 +27,13 @@ qwak = "qwak_sdk.main:qwak_cli"
 
 [tool.poetry.dependencies]
 python = ">=3.7.1,<3.10"
-qwak-core = "==0.3.85"
+qwak-core = "==0.3.143"
 qwak-inference = "~0.1"
 croniter = "==1.4.1"
 tabulate = ">=0.8.0"
 python-json-logger = ">=2.0.2"
 yaspin = ">=2.0.0"
+rich = ">=13.0.0"
 cookiecutter = "*"
 gitpython = ">=2.1.0"
 boto3 = { version = "^1.24.116", optional = true } # Inference dependencies
@@ -62,6 +63,7 @@ mypy-protobuf = "^3.0.0"
 [tool.poetry.extras]
 batch = ["boto3", "pandas", "pyarrow", "joblib"]
 feedback = ["boto3", "pandas", "joblib"]
+local-deployment = ["boto3"]
 
 [tool.black]
 extend-exclude = '''

{qwak_sdk-0.5.61 → qwak_sdk-0.5.63}/qwak_sdk/__init__.py

@@ -1,6 +1,6 @@
 # fmt: off
 __author__ = '''Qwak.ai'''
-__version__ = '0.5.61'
+__version__ = '0.5.63'
 
 from qwak.inner import wire_dependencies
 

{qwak_sdk-0.5.61 → qwak_sdk-0.5.63}/qwak_sdk/commands/models/build/ui.py

@@ -110,6 +110,11 @@ from qwak_sdk.inner.tools.config_handler import config_handler
     type=str,
     help="[REMOTE BUILD] Custom IAM Role ARN.",
 )
+@click.option(
+    "--service-account-key-secret-name",
+    type=str,
+    help="Custom service account for Gcp.",
+)
 @click.option(
     "--cache/--no-cache",
     default=None,

{qwak_sdk-0.5.61 → qwak_sdk-0.5.63}/qwak_sdk/commands/models/deployments/deploy/_logic/deploy_config.py

@@ -140,6 +140,12 @@ DEPLOYMENT_CLI_CONFIG_MAPPING: List[ConfigCliMap] = [
     ConfigCliMap(
         "iam_role_arn", "advanced_options.iam_role_arn", validate_string, False
     ),
+    ConfigCliMap(
+        "service_account_key_secret_name",
+        "advanced_options.service_account_key_secret_name",
+        validate_string,
+        False,
+    ),
     ConfigCliMap(
         "purchase_option",
         "advanced_options.purchase_option",
@@ -241,6 +247,7 @@ class DeployConfig(YamlConfigMixin, QwakConfigBase):
     class AdvancedOptions:
         iam_role_arn: str = field(default=None)
         purchase_option: str = field(default=PurchaseOption.SPOT.value)
+        service_account_key_secret_name: str = field(default=None)
 
     model_id: str = field(default="")
     build_id: str = field(default="")

{qwak_sdk-0.5.61 → qwak_sdk-0.5.63}/qwak_sdk/commands/models/deployments/deploy/_logic/deployment_message_helpers.py

@@ -45,7 +45,7 @@ def get_env_to_deployment_message(
     instance_template_client: InstanceTemplateManagementClient,
 ) -> Dict[str, EnvironmentDeploymentMessage]:
     deployment_size = deployment_size_from_deploy_config(
-        deploy_config, instance_template_client
+        deploy_config, instance_template_client, ecosystem_client
     )
     advanced_deployment_options = get_advanced_deployment_options_from_deploy_config(
         deploy_config, kube_deployment_type

{qwak_sdk-0.5.61 → qwak_sdk-0.5.63}/qwak_sdk/commands/models/deployments/deploy/_logic/deployment_size_mapper.py

@@ -7,8 +7,11 @@ from _qwak_proto.qwak.user_application.common.v0.resources_pb2 import (
     GpuResources,
     PodComputeResourceTemplateSpec,
 )
+from qwak.clients.administration.eco_system.client import EcosystemClient
 from qwak.clients.instance_template.client import InstanceTemplateManagementClient
+from qwak.exceptions import QwakException
 from qwak.inner.instance_template.verify_template_id import verify_template_id
+from qwak.inner.provider import Provider
 
 from qwak_sdk.commands.models.deployments.deploy._logic.deploy_config import (
     DeployConfig,
@@ -18,14 +21,37 @@ from qwak_sdk.commands.models.deployments.deploy._logic.deploy_config import (
 def deployment_size_from_deploy_config(
     deploy_config: DeployConfig,
     instance_template_client: InstanceTemplateManagementClient,
+    ecosystem_client: EcosystemClient,
 ) -> DeploymentSize:
     if deploy_config.resources.instance_size:
         deploy_config.resources.instance_size = (
             deploy_config.resources.instance_size.lower()
         )
-        verify_template_id(
-            deploy_config.resources.instance_size, instance_template_client
-        )
+        account_details = ecosystem_client.get_account_details()
+        if deploy_config.environments:
+            environments_config = list(
+                ecosystem_client.get_environments_names_to_details(
+                    deploy_config.environments
+                ).values()
+            )
+        else:
+            environments_config = [
+                account_details.environment_by_id[
+                    account_details.default_environment_id
+                ]
+            ]
+        for environment_config in environments_config:
+            provider = __get_provider(environment_config)
+            try:
+                verify_template_id(
+                    deploy_config.resources.instance_size,
+                    instance_template_client,
+                    provider=provider,
+                )
+            except QwakException as e:
+                raise QwakException(
+                    f"Error with template {deploy_config.resources.instance_size} for environment {environment_config.name}: {e.message}"
+                )
 
         return DeploymentSize(
             number_of_pods=deploy_config.resources.pods,
@@ -56,3 +82,15 @@ def deployment_size_from_deploy_config(
                 )
             ),
         )
+
+
+def __get_provider(environment_config):
+    provider = None
+    cloud_type = environment_config.configuration.cloud_configuration.WhichOneof(
+        "configuration"
+    )
+    if cloud_type == "aws_cloud_configuration":
+        provider = Provider.AWS
+    elif cloud_type == "gcp_cloud_configuration":
+        provider = Provider.GCP
+    return provider

qwak_sdk-0.5.63/qwak_sdk/commands/models/deployments/deploy/_logic/local_deployment.py

@@ -0,0 +1,193 @@
+import base64
+
+from _qwak_proto.qwak.ecosystem.v0.ecosystem_runtime_service_pb2 import (
+    GetCloudCredentialsParameters,
+    GetCloudCredentialsRequest,
+    PermissionSet,
+    PullModelsContainerRegistry,
+)
+from google.protobuf.duration_pb2 import Duration
+from qwak.clients.administration.eco_system.client import EcosystemClient
+from qwak.clients.build_orchestrator import BuildOrchestratorClient
+from qwak.exceptions import QwakException
+from rich.console import Console
+from rich.layout import Layout
+from rich.panel import Panel
+from rich.progress import Progress
+
+from qwak_sdk.commands.models.deployments.deploy._logic.deploy_config import (
+    DeployConfig,
+)
+
+tasks = {}
+
+
+def local_deploy(config: DeployConfig):
+    try:
+        import docker
+    except ImportError:
+        raise QwakException(
+            "Error: 'docker' package is required to for local model deployment."
+        )
+
+    console = Console()
+    console.print(Panel(f"Deploying model {config.model_id} locally", style="green"))
+
+    client = docker.from_env()
+    build_image = _get_build_image(config)
+
+    if not client.images.list(name=build_image):
+        console.print(
+            "Pulling serving image from Qwak's remote repository. Might take a few minutes...",
+            style="yellow",
+        )
+        _docker_login(client)
+        _image_pull(client, build_image)
+
+    try:
+        container = start_local_qwak_container(build_image, client, config)
+        container.reload()
+        host_port = container.ports.get("5000/tcp")[0]["HostPort"]
+
+        layout = example_usage_layout(host_port)
+        console.print(layout)
+
+        for line in container.logs(stream=True):
+            console.print(str(line.strip().decode()), style="blue")
+
+    except KeyboardInterrupt:
+        console.print(Panel("Stopping container...", style="red"))
+        container.stop()
+        container.remove()
+
+
+def example_usage_layout(host_port: str):
+    layout = Layout(size=6)
+    layout.split_row(
+        Layout(name="left"),
+        Layout(name="right"),
+    )
+    layout["left"].update(
+        Panel(
+            f"[bold]cURL usage:[bold]\n\n"
+            f"curl --location\n"
+            f"--request POST http://localhost:{host_port}/predict\n"
+            f"--header 'Content-Type: application/json'\n"
+            f"--data '...'",
+            style="green",
+        )
+    )
+    layout["right"].update(
+        Panel(
+            f"[bold]Python client usage:[bold]\n\n"
+            f"from qwak_inference import RealtimeClient\n\nfeature_vector=[...]\n"
+            f"client = RealTimeClient(model_api='http://localhost:{host_port}/predict')\n"
+            f"client.predict(feature_vector)",
+            style="green",
+        )
+    )
+    return layout
+
+
+def start_local_qwak_container(build_image: str, docker_client, config: DeployConfig):
+    return docker_client.containers.run(
+        build_image,
+        command=["bentoml", "serve-gunicorn", "./"],
+        entrypoint="./docker-entrypoint.sh",
+        environment=[
+            "BENTOML_GUNICORN_WORKERS=2",
+            "QWAK_DEBUG_MODE=True",
+            f"QWAK_MODEL_ID={config.model_id}",
+            "BENTOML_DO_NOT_TRACK=True",
+            "PYTHONPATH=/qwak/model_dir:/qwak/model_dir/main:$PYTHONPATH",
+            f"QWAK_BUILD_ID={config.build_id}",
+            "BUNDLE_PATH=/home/bentoml/bundle",
+            "BENTOML_HOME=/home/bentoml/",
+        ],
+        stream=True,
+        detach=True,
+        publish_all_ports=True,
+    )
+
+
+def _get_build_image(config: DeployConfig):
+    return (
+        BuildOrchestratorClient().get_build(config.build_id).build.build_destined_image
+    )
+
+
+def _show_progress(line, progress):
+    if line["status"] == "Downloading":
+        idx = f'[red][Download {line["id"]}]'
+    elif line["status"] == "Extracting":
+        idx = f'[green][Extract {line["id"]}]'
+    else:
+        # skip other statuses
+        return
+
+    if idx not in tasks.keys():
+        tasks[idx] = progress.add_task(f"{idx}", total=line["progressDetail"]["total"])
+    else:
+        progress.update(tasks[idx], completed=line["progressDetail"]["current"])
+
+
+def _image_pull(docker_client, image_name: str):
+    with Progress() as progress:
+        resp = docker_client.api.pull(image_name, stream=True, decode=True)
+        for line in resp:
+            _show_progress(line, progress)
+
+
+def _docker_login(docker_client):
+    try:
+        import boto3
+    except ImportError:
+        raise QwakException(
+            "Error: The 'boto3' package is necessary for local model deployment. Install it directly or by running"
+            " 'pip install qwak[local-deployment]'"
+        )
+
+    # TODO: block if not an AWS based container registry
+    credentials = _get_aws_credentials()
+
+    aws_credentials = credentials.cloud_credentials.aws_temporary_credentials
+    ecr_client = boto3.Session(
+        aws_access_key_id=aws_credentials.access_key_id,
+        aws_secret_access_key=aws_credentials.secret_access_key,
+        aws_session_token=aws_credentials.session_token,
+        region_name=aws_credentials.region,
+    ).client("ecr")
+
+    ecr_credentials = ecr_client.get_authorization_token()["authorizationData"][0]
+
+    try:
+        docker_client.login(
+            username="AWS",
+            registry=ecr_credentials["proxyEndpoint"],
+            password=base64.b64decode(ecr_credentials["authorizationToken"])
+            .replace(b"AWS:", b"")
+            .decode("utf-8"),
+        )
+
+    except Exception as e:
+        raise QwakException(f"Failed to login to Qwak's container registry: {e}")
+
+
+def _get_aws_credentials():
+    try:
+        eco_client = EcosystemClient()
+        credentials = eco_client.get_cloud_credentials(
+            request=GetCloudCredentialsRequest(
+                parameters=GetCloudCredentialsParameters(
+                    duration=Duration(seconds=60 * 60, nanos=0),  # 6 hours
+                    permission_set=PermissionSet(
+                        pull_models_container_registry=PullModelsContainerRegistry()
+                    ),
+                )
+            )
+        )
+        return credentials
+    except Exception as e:
+        raise QwakException(
+            f"Failed to get credentials to pull image from Qwak's container registry: {e}."
+        )

{qwak_sdk-0.5.61 → qwak_sdk-0.5.63}/qwak_sdk/commands/models/deployments/deploy/batch/_logic/advanced_deployment_mapper.py

@@ -11,4 +11,5 @@ def batch_advanced_deployment_options_from_deploy_config(
     return AdvancedDeploymentOptions(
         custom_iam_role_arn=deploy_config.advanced_options.iam_role_arn,
         purchase_option=deploy_config.advanced_options.purchase_option,
+        service_account_key_secret_name=deploy_config.advanced_options.service_account_key_secret_name,
     )

{qwak_sdk-0.5.61 → qwak_sdk-0.5.63}/qwak_sdk/commands/models/deployments/deploy/batch/ui.py

@@ -61,6 +61,11 @@ from qwak_sdk.inner.tools.config_handler import config_handler
     type=str,
     help="Custom IAM Role ARN.",
 )
+@click.option(
+    "--service-account-key-secret-name",
+    type=str,
+    help="Custom service account for Gcp.",
+)
 @click.option(
     "--sync",
     is_flag=True,

{qwak_sdk-0.5.61 → qwak_sdk-0.5.63}/qwak_sdk/commands/models/deployments/deploy/realtime/_logic/advanced_deployment_mapper.py

@@ -17,4 +17,5 @@ def realtime_advanced_deployment_options_from_deploy_config(
         custom_iam_role_arn=deploy_config.advanced_options.iam_role_arn,
         purchase_option=deploy_config.advanced_options.purchase_option,
         deployment_process_timeout_limit=deploy_config.realtime.deployment_timeout,
+        service_account_key_secret_name=deploy_config.advanced_options.service_account_key_secret_name,
     )

{qwak_sdk-0.5.61 → qwak_sdk-0.5.63}/qwak_sdk/commands/models/deployments/deploy/realtime/ui.py

@@ -14,6 +14,9 @@ from qwak_sdk.commands.models.deployments.deploy._logic.deploy_config import (
 from qwak_sdk.commands.models.deployments.deploy._logic.deployment_response_handler import (
     client_deployment,
 )
+from qwak_sdk.commands.models.deployments.deploy._logic.local_deployment import (
+    local_deploy,
+)
 from qwak_sdk.commands.models.deployments.deploy.realtime._logic.deploy_executor import (
     RealtimeDeployExecutor,
 )
@@ -84,6 +87,11 @@ logger = get_qwak_logger()
     type=str,
     help="Custom IAM Role ARN.",
 )
+@click.option(
+    "--service-account-key-secret-name",
+    type=str,
+    help="Custom service account for Gcp.",
+)
 @click.option(
     "--max-batch-size",
     type=int,
@@ -108,6 +116,12 @@ logger = get_qwak_logger()
     default=False,
     help="Waiting for deployments to be ready",
 )
+@click.option(
+    "--local",
+    is_flag=True,
+    default=False,
+    help="Deploy the model container locally, for development purposes only",
+)
 @click.option(
     "-v",
     "--verbose",
@@ -165,13 +179,20 @@ logger = get_qwak_logger()
     help="Whether the deployment variation is protected. Default is false",
 )
 def realtime(
-    verbose: bool, from_file: Optional[str], out_conf: bool, sync: bool, **kwargs
+    verbose: bool,
+    from_file: Optional[str],
+    out_conf: bool,
+    sync: bool,
+    local: bool,
+    **kwargs,
 ):
     set_qwak_logger_stdout_verbosity_level(verbose + 1)
-    deploy_realtime(from_file, out_conf, sync, **kwargs)
+    deploy_realtime(from_file, out_conf, sync, local, **kwargs)
 
 
-def deploy_realtime(from_file: Optional[str], out_conf: bool, sync: bool, **kwargs):
+def deploy_realtime(
+    from_file: Optional[str], out_conf: bool, sync: bool, local: bool, **kwargs
+):
     config: DeployConfig = config_handler(
         config=DeployConfig,
         from_file=from_file,
@@ -179,6 +200,10 @@ def deploy_realtime(from_file: Optional[str], out_conf: bool, sync: bool, **kwar
         sections=("realtime", "autoscaling"),
         **kwargs,
     )
-    if not out_conf:
+
+    if local:
+        local_deploy(config)
+
+    elif not out_conf:
         deploy_executor = RealtimeDeployExecutor(config)
         client_deployment(deploy=deploy_executor, sync=sync)

{qwak_sdk-0.5.61 → qwak_sdk-0.5.63}/setup.py

@@ -137,8 +137,9 @@ install_requires = \
  'croniter==1.4.1',
  'gitpython>=2.1.0',
  'python-json-logger>=2.0.2',
- 'qwak-core==0.3.85',
+ 'qwak-core==0.3.143',
  'qwak-inference>=0.1,<0.2',
+ 'rich>=13.0.0',
  'tabulate>=0.8.0',
  'yaspin>=2.0.0']
 
@@ -154,14 +155,15 @@ extras_require = \
  'feedback:python_full_version >= "3.7.1" and python_version < "3.8"': ['pandas<1.4',
                                                                         'pandas<1.4'],
  'feedback:python_version >= "3.8" and python_version < "3.10"': ['pandas>=1.4.3,<2.0.0',
-                                                                  'pandas>=1.4.3,<2.0.0']}
+                                                                  'pandas>=1.4.3,<2.0.0'],
+ 'local-deployment': ['boto3>=1.24.116,<2.0.0']}
 
 entry_points = \
 {'console_scripts': ['qwak = qwak_sdk.main:qwak_cli']}
 
 setup_kwargs = {
     'name': 'qwak-sdk',
-    'version': '0.5.61',
+    'version': '0.5.63',
     'description': 'Qwak SDK and CLI for qwak models',
     'long_description': '# Qwak SDK\n\nQwak is an end-to-end production ML platform designed to allow data scientists to build, deploy, and monitor their models in production with minimal engineering friction.\n',
     'author': 'Qwak',