lightning-sdk 0.1.32__py3-none-any.whl → 0.1.34__py3-none-any.whl

lightning_sdk/__init__.py

@@ -27,5 +27,5 @@ __all__ = [
     "AIHub",
 ]
 
-__version__ = "0.1.32"
+__version__ = "0.1.34"
 _check_version_and_prompt_upgrade(__version__)

lightning_sdk/ai_hub.py

@@ -1,6 +1,14 @@
-from typing import Dict, List
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union
+from urllib.parse import quote
 
-from lightning_sdk.api.ai_hub_api import AIHubApi
+from lightning_sdk.api import AIHubApi, UserApi
+from lightning_sdk.lightning_cloud import login
+from lightning_sdk.lightning_cloud.env import LIGHTNING_CLOUD_URL
+from lightning_sdk.user import User
+from lightning_sdk.utils.resolve import _resolve_org, _resolve_teamspace
+
+if TYPE_CHECKING:
+    from lightning_sdk import Organization, Teamspace
 
 
 class AIHub:
@@ -13,10 +21,17 @@ class AIHub:
 
     def __init__(self) -> None:
         self._api = AIHubApi()
+        self._auth = None
+
+    def list_apis(self, search: Optional[str] = None) -> List[Dict[str, str]]:
+        """Get a list of AI Hub API templates.
 
-    def list_apis(self) -> List[Dict[str, str]]:
-        """Get a list of AI Hub API templates."""
-        api_templates = self._api.list_apis()
+        Example:
+            api_hub = AIHub()
+            api_list = api_hub.list_apis(search="Llama")
+        """
+        search_query = search or ""
+        api_templates = self._api.list_apis(search_query=search_query)
         results = []
         for template in api_templates:
             result = {
@@ -24,6 +39,76 @@ class AIHub:
                 "name": template.name,
                 "description": template.description,
                 "creator_username": template.creator_username,
+                "created_on": template.creation_timestamp.strftime("%Y-%m-%d %H:%M:%S")
+                if template.creation_timestamp
+                else None,
             }
             results.append(result)
         return results
+
+    def _authenticate(
+        self,
+        teamspace: Optional[Union[str, "Teamspace"]] = None,
+        org: Optional[Union[str, "Organization"]] = None,
+        user: Optional[Union[str, "User"]] = None,
+    ) -> "Teamspace":
+        if self._auth is None:
+            self._auth = login.Auth()
+        try:
+            self._auth.authenticate()
+            user = User(name=UserApi()._get_user_by_id(self._auth.user_id).username)
+        except ConnectionError as e:
+            raise e
+
+        org = _resolve_org(org)
+        teamspace = _resolve_teamspace(teamspace=teamspace, org=org, user=user if org is None else None)
+        if teamspace is None:
+            raise ValueError("You need to pass a teamspace or an org for your deployment.")
+        return teamspace
+
+    def deploy(
+        self,
+        api_id: str,
+        cluster: Optional[str] = None,
+        name: Optional[str] = None,
+        teamspace: Optional[Union[str, "Teamspace"]] = None,
+        org: Optional[Union[str, "Organization"]] = None,
+        **kwargs: Dict[str, Any],
+    ) -> Dict[str, Union[str, bool]]:
+        """Deploy an API from the AI Hub.
+
+        Example:
+            from lightning_sdk import AIHub
+            ai_hub = AIHub()
+            deployment = ai_hub.deploy("temp_01jc37n6qpqkdptjpyep0z06hy", batch_size=10)
+
+        Args:
+            api_id: The ID of the API you want to deploy.
+            cluster: The cluster where you want to deploy the API, such as "lightning-public-prod".
+            name: Name for the deployed API. Defaults to None.
+            teamspace: The team or group for deployment. Defaults to None.
+            org: The organization for deployment. Defaults to None.
+            **kwargs: Additional keyword arguments for deployment.
+
+        Returns:
+            A dictionary containing the name of the deployed API,
+            the URL to access it, and whether it is interruptible.
+
+        Raises:
+            ValueError: If a teamspace or organization is not provided.
+            ConnectionError: If there is an issue with logging in.
+        """
+        teamspace = self._authenticate(teamspace, org)
+        teamspace_id = teamspace.id
+
+        deployment = self._api.deploy_api(
+            template_id=api_id, cluster_id=cluster, project_id=teamspace_id, name=name, **kwargs
+        )
+        url = quote(f"{LIGHTNING_CLOUD_URL}/{teamspace._org.name}/{teamspace.name}/jobs/{deployment.name}", safe=":/()")
+        print("Deployment available at:", url)
+        return {
+            "id": deployment.id,
+            "name": deployment.name,
+            "base_url": deployment.status.urls[0],
+            "interruptible": deployment.spec.spot,
+        }

lightning_sdk/api/ai_hub_api.py

@@ -1,5 +1,13 @@
-from typing import List
+import re
+from typing import List, Optional
 
+import backoff
+
+from lightning_sdk.lightning_cloud.openapi.models import (
+    CreateDeploymentRequestDefinesASpecForTheJobThatAllowsForAutoscalingJobs,
+    V1Deployment,
+    V1ParameterizationSpec,
+)
 from lightning_sdk.lightning_cloud.openapi.models.v1_deployment_template_gallery_response import (
     V1DeploymentTemplateGalleryResponse,
 )
@@ -8,8 +16,49 @@ from lightning_sdk.lightning_cloud.rest_client import LightningClient
 
 class AIHubApi:
     def __init__(self) -> None:
-        self._client = LightningClient(max_tries=7)
+        self._client = LightningClient(max_tries=3)
 
-    def list_apis(self) -> List[V1DeploymentTemplateGalleryResponse]:
+    @backoff.on_predicate(backoff.expo, lambda x: not x, max_tries=5)
+    def list_apis(self, search_query: str) -> List[V1DeploymentTemplateGalleryResponse]:
         kwargs = {"show_globally_visible": True}
-        return self._client.deployment_templates_service_list_published_deployment_templates(**kwargs).templates
+        return self._client.deployment_templates_service_list_published_deployment_templates(
+            search_query=search_query, **kwargs
+        ).templates
+
+    @staticmethod
+    def _parse_and_update_args(cmd: str, **kwargs: dict) -> list:
+        """Parse the command and update the arguments with the provided kwargs.
+
+        >>> _parse_and_update_args("--arg1 1 --arg2=2", arg1=3)
+        ['--arg1 3']
+        """
+        keys = [key.lstrip("-") for key in re.findall(r"--\w+", cmd)]
+        arguments = {}
+        for key in keys:
+            if key in kwargs:
+                arguments[key] = kwargs[key]
+        return [f"--{k} {v}" for k, v in arguments.items()]
+
+    @staticmethod
+    def _resolve_api_arguments(parameter_spec: "V1ParameterizationSpec", **kwargs: dict) -> str:
+        return " ".join(AIHubApi._parse_and_update_args(parameter_spec.command, **kwargs))
+
+    def deploy_api(
+        self, template_id: str, project_id: str, cluster_id: str, name: Optional[str], **kwargs: dict
+    ) -> V1Deployment:
+        template = self._client.deployment_templates_service_get_deployment_template(template_id)
+        name = name or template.name
+        template.spec_v2.endpoint.id = None
+        command = self._resolve_api_arguments(template.parameter_spec, **kwargs)
+        template.spec_v2.job.command = command
+        return self._client.jobs_service_create_deployment(
+            project_id=project_id,
+            body=CreateDeploymentRequestDefinesASpecForTheJobThatAllowsForAutoscalingJobs(
+                autoscaling=template.spec_v2.autoscaling,
+                cluster_id=cluster_id,
+                endpoint=template.spec_v2.endpoint,
+                name=name,
+                replicas=0,
+                spec=template.spec_v2.job,
+            ),
+        )

lightning_sdk/api/studio_api.py

@@ -5,7 +5,7 @@ import time
 import warnings
 import zipfile
 from threading import Event, Thread
-from typing import Any, Dict, Mapping, Optional, Tuple
+from typing import Any, Dict, Mapping, Optional, Tuple, Union
 
 import backoff
 import requests
@@ -18,6 +18,7 @@ from lightning_sdk.api.utils import (
     _DummyBody,
     _DummyResponse,
     _FileUploader,
+    _machine_to_compute_name,
     _sanitize_studio_remote_path,
 )
 from lightning_sdk.api.utils import (
@@ -146,9 +147,11 @@ class StudioApi:
         """Retries checking the sync_in_progress value of the code status when there's an AttributeError."""
         return self.get_studio_status(studio_id, teamspace_id).in_use.sync_in_progress
 
-    def start_studio(self, studio_id: str, teamspace_id: str, machine: Machine, interruptible: False) -> None:
+    def start_studio(
+        self, studio_id: str, teamspace_id: str, machine: Union[Machine, str], interruptible: False
+    ) -> None:
         """Start an existing Studio."""
-        if machine == Machine.CPU_SMALL:
+        if _machine_to_compute_name(machine) == _machine_to_compute_name(Machine.CPU_SMALL):
             warnings.warn(
                 f"{Machine.CPU_SMALL} is not a valid machine for starting a Studio. "
                 "It is reserved for running jobs only. "
@@ -158,7 +161,7 @@ class StudioApi:
 
         self._client.cloud_space_service_start_cloud_space_instance(
             IdStartBody(
-                compute_config=V1UserRequestedComputeConfig(name=_MACHINE_TO_COMPUTE_NAME[machine], spot=interruptible)
+                compute_config=V1UserRequestedComputeConfig(name=_machine_to_compute_name(machine), spot=interruptible)
             ),
             teamspace_id,
             studio_id,
@@ -204,9 +207,11 @@ class StudioApi:
     def _get_studio_instance_status_from_object(self, studio: V1CloudSpace) -> Optional[str]:
         return getattr(getattr(studio.code_status, "in_use", None), "phase", None)
 
-    def _request_switch(self, studio_id: str, teamspace_id: str, machine: Machine, interruptible: bool) -> None:
+    def _request_switch(
+        self, studio_id: str, teamspace_id: str, machine: Union[Machine, str], interruptible: bool
+    ) -> None:
         """Switches given Studio to a new machine type."""
-        if machine == Machine.CPU_SMALL:
+        if _machine_to_compute_name(machine) == _machine_to_compute_name(Machine.CPU_SMALL):
             warnings.warn(
                 f"{Machine.CPU_SMALL} is not a valid machine for switching a Studio. "
                 "It is reserved for running jobs only. "
@@ -214,7 +219,7 @@ class StudioApi:
             )
             machine = Machine.CPU
 
-        compute_name = _MACHINE_TO_COMPUTE_NAME[machine]
+        compute_name = _machine_to_compute_name(machine)
         # TODO: UI sends disk size here, maybe we need to also?
         body = IdCodeconfigBody(compute_config=V1UserRequestedComputeConfig(name=compute_name, spot=interruptible))
         self._client.cloud_space_service_update_cloud_space_instance_config(
@@ -223,7 +228,9 @@ class StudioApi:
             body=body,
         )
 
-    def switch_studio_machine(self, studio_id: str, teamspace_id: str, machine: Machine, interruptible: bool) -> None:
+    def switch_studio_machine(
+        self, studio_id: str, teamspace_id: str, machine: Union[Machine, str], interruptible: bool
+    ) -> None:
         """Switches given Studio to a new machine type."""
         self._request_switch(
             studio_id=studio_id, teamspace_id=teamspace_id, machine=machine, interruptible=interruptible

lightning_sdk/api/utils.py

@@ -4,7 +4,7 @@ import os
 from concurrent.futures import ThreadPoolExecutor
 from functools import partial
 from pathlib import Path
-from typing import Any, Dict, List, Optional, Tuple
+from typing import Any, Dict, List, Optional, Tuple, Union
 
 import backoff
 import requests
@@ -340,6 +340,13 @@ _MACHINE_TO_COMPUTE_NAME: Dict[Machine, str] = {
     Machine.H200_X_8: "p5e.48xlarge",
 }
 
+
+def _machine_to_compute_name(machine: Union[Machine, str]) -> str:
+    if isinstance(machine, Machine):
+        return _MACHINE_TO_COMPUTE_NAME[machine]
+    return machine
+
+
 _COMPUTE_NAME_TO_MACHINE: Dict[str, Machine] = {v: k for k, v in _MACHINE_TO_COMPUTE_NAME.items()}
 
 _DEFAULT_CLOUD_URL = "https://lightning.ai:443"

lightning_sdk/cli/ai_hub.py

@@ -0,0 +1,38 @@
+from typing import List, Optional
+
+from lightning_sdk.ai_hub import AIHub
+from lightning_sdk.cli.studios_menu import _StudiosMenu
+
+
+class _AIHub(_StudiosMenu):
+    """Interact with Lightning Studio - AI Hub."""
+
+    def __init__(self) -> None:
+        self._hub = AIHub()
+
+    def list_apis(self, search: Optional[str] = None) -> List[dict]:
+        """List API templates available in the AI Hub.
+
+        Args:
+          search: Search for API templates by name.
+        """
+        return self._hub.list_apis(search=search)
+
+    def deploy(
+        self,
+        api_id: str,
+        cluster: Optional[str] = None,
+        name: Optional[str] = None,
+        teamspace: Optional[str] = None,
+        org: Optional[str] = None,
+    ) -> dict:
+        """Deploy an API template from the AI Hub.
+
+        Args:
+          api_id: API template ID.
+          cluster: Cluster to deploy the API to. Defaults to user's default cluster.
+          name: Name of the deployed API. Defaults to the name of the API template.
+          teamspace: Teamspace to deploy the API to. Defaults to user's default teamspace.
+          org: Organization to deploy the API to. Defaults to user's default organization.
+        """
+        return self._hub.deploy(api_id, cluster=cluster, name=name, teamspace=teamspace, org=org)

lightning_sdk/cli/entrypoint.py

@@ -2,6 +2,7 @@ from fire import Fire
 from lightning_utilities.core.imports import RequirementCache
 
 from lightning_sdk.api.studio_api import _cloud_url
+from lightning_sdk.cli.ai_hub import _AIHub
 from lightning_sdk.cli.download import _Downloads
 from lightning_sdk.cli.legacy import _LegacyLightningCLI
 from lightning_sdk.cli.upload import _Uploads
@@ -16,6 +17,7 @@ class StudioCLI:
     def __init__(self) -> None:
         self.download = _Downloads()
         self.upload = _Uploads()
+        self.aihub = _AIHub()
 
         if _LIGHTNING_AVAILABLE:
             self.run = _LegacyLightningCLI()

lightning_sdk/lightning_cloud/openapi/__init__.py

@@ -226,6 +226,7 @@ from lightning_sdk.lightning_cloud.openapi.models.v1_cancellation_metadata impor
 from lightning_sdk.lightning_cloud.openapi.models.v1_capacity_block_offering import V1CapacityBlockOffering
 from lightning_sdk.lightning_cloud.openapi.models.v1_check_external_service_status_response import V1CheckExternalServiceStatusResponse
 from lightning_sdk.lightning_cloud.openapi.models.v1_check_snowflake_connection_response import V1CheckSnowflakeConnectionResponse
+from lightning_sdk.lightning_cloud.openapi.models.v1_checkbox import V1Checkbox
 from lightning_sdk.lightning_cloud.openapi.models.v1_cloud_space import V1CloudSpace
 from lightning_sdk.lightning_cloud.openapi.models.v1_cloud_space_app import V1CloudSpaceApp
 from lightning_sdk.lightning_cloud.openapi.models.v1_cloud_space_app_action import V1CloudSpaceAppAction

lightning_sdk/lightning_cloud/openapi/models/__init__.py

@@ -190,6 +190,7 @@ from lightning_sdk.lightning_cloud.openapi.models.v1_cancellation_metadata impor
 from lightning_sdk.lightning_cloud.openapi.models.v1_capacity_block_offering import V1CapacityBlockOffering
 from lightning_sdk.lightning_cloud.openapi.models.v1_check_external_service_status_response import V1CheckExternalServiceStatusResponse
 from lightning_sdk.lightning_cloud.openapi.models.v1_check_snowflake_connection_response import V1CheckSnowflakeConnectionResponse
+from lightning_sdk.lightning_cloud.openapi.models.v1_checkbox import V1Checkbox
 from lightning_sdk.lightning_cloud.openapi.models.v1_cloud_space import V1CloudSpace
 from lightning_sdk.lightning_cloud.openapi.models.v1_cloud_space_app import V1CloudSpaceApp
 from lightning_sdk.lightning_cloud.openapi.models.v1_cloud_space_app_action import V1CloudSpaceAppAction

lightning_sdk/lightning_cloud/openapi/models/create_deployment_request_defines_a_spec_for_the_job_that_allows_for_autoscaling_jobs.py

@@ -45,6 +45,7 @@ class CreateDeploymentRequestDefinesASpecForTheJobThatAllowsForAutoscalingJobs(o
         'cluster_id': 'str',
         'endpoint': 'V1Endpoint',
         'name': 'str',
+        'parameter_spec': 'V1ParameterizationSpec',
         'replicas': 'int',
         'spec': 'V1JobSpec',
         'strategy': 'V1DeploymentStrategy'
@@ -55,17 +56,19 @@ class CreateDeploymentRequestDefinesASpecForTheJobThatAllowsForAutoscalingJobs(o
         'cluster_id': 'clusterId',
         'endpoint': 'endpoint',
         'name': 'name',
+        'parameter_spec': 'parameterSpec',
         'replicas': 'replicas',
         'spec': 'spec',
         'strategy': 'strategy'
     }
 
-    def __init__(self, autoscaling: 'V1AutoscalingSpec' =None, cluster_id: 'str' =None, endpoint: 'V1Endpoint' =None, name: 'str' =None, replicas: 'int' =None, spec: 'V1JobSpec' =None, strategy: 'V1DeploymentStrategy' =None):  # noqa: E501
+    def __init__(self, autoscaling: 'V1AutoscalingSpec' =None, cluster_id: 'str' =None, endpoint: 'V1Endpoint' =None, name: 'str' =None, parameter_spec: 'V1ParameterizationSpec' =None, replicas: 'int' =None, spec: 'V1JobSpec' =None, strategy: 'V1DeploymentStrategy' =None):  # noqa: E501
         """CreateDeploymentRequestDefinesASpecForTheJobThatAllowsForAutoscalingJobs - a model defined in Swagger"""  # noqa: E501
         self._autoscaling = None
         self._cluster_id = None
         self._endpoint = None
         self._name = None
+        self._parameter_spec = None
         self._replicas = None
         self._spec = None
         self._strategy = None
@@ -78,6 +81,8 @@ class CreateDeploymentRequestDefinesASpecForTheJobThatAllowsForAutoscalingJobs(o
             self.endpoint = endpoint
         if name is not None:
             self.name = name
+        if parameter_spec is not None:
+            self.parameter_spec = parameter_spec
         if replicas is not None:
             self.replicas = replicas
         if spec is not None:
@@ -169,6 +174,27 @@ class CreateDeploymentRequestDefinesASpecForTheJobThatAllowsForAutoscalingJobs(o
 
         self._name = name
 
+    @property
+    def parameter_spec(self) -> 'V1ParameterizationSpec':
+        """Gets the parameter_spec of this CreateDeploymentRequestDefinesASpecForTheJobThatAllowsForAutoscalingJobs.  # noqa: E501
+
+
+        :return: The parameter_spec of this CreateDeploymentRequestDefinesASpecForTheJobThatAllowsForAutoscalingJobs.  # noqa: E501
+        :rtype: V1ParameterizationSpec
+        """
+        return self._parameter_spec
+
+    @parameter_spec.setter
+    def parameter_spec(self, parameter_spec: 'V1ParameterizationSpec'):
+        """Sets the parameter_spec of this CreateDeploymentRequestDefinesASpecForTheJobThatAllowsForAutoscalingJobs.
+
+
+        :param parameter_spec: The parameter_spec of this CreateDeploymentRequestDefinesASpecForTheJobThatAllowsForAutoscalingJobs.  # noqa: E501
+        :type: V1ParameterizationSpec
+        """
+
+        self._parameter_spec = parameter_spec
+
     @property
     def replicas(self) -> 'int':
         """Gets the replicas of this CreateDeploymentRequestDefinesASpecForTheJobThatAllowsForAutoscalingJobs.  # noqa: E501

lightning_sdk/lightning_cloud/openapi/models/deployments_id_body.py

@@ -47,6 +47,7 @@ class DeploymentsIdBody(object):
         'endpoint': 'V1Endpoint',
         'is_published': 'bool',
         'name': 'str',
+        'parameter_spec': 'V1ParameterizationSpec',
         'release_id': 'str',
         'replicas': 'int',
         'spec': 'V1JobSpec',
@@ -63,6 +64,7 @@ class DeploymentsIdBody(object):
         'endpoint': 'endpoint',
         'is_published': 'isPublished',
         'name': 'name',
+        'parameter_spec': 'parameterSpec',
         'release_id': 'releaseId',
         'replicas': 'replicas',
         'spec': 'spec',
@@ -72,7 +74,7 @@ class DeploymentsIdBody(object):
         'user_id': 'userId'
     }
 
-    def __init__(self, autoscaling: 'V1AutoscalingSpec' =None, created_at: 'datetime' =None, desired_state: 'V1DeploymentState' =None, endpoint: 'V1Endpoint' =None, is_published: 'bool' =None, name: 'str' =None, release_id: 'str' =None, replicas: 'int' =None, spec: 'V1JobSpec' =None, status: 'V1DeploymentStatus' =None, strategy: 'V1DeploymentStrategy' =None, updated_at: 'datetime' =None, user_id: 'str' =None):  # noqa: E501
+    def __init__(self, autoscaling: 'V1AutoscalingSpec' =None, created_at: 'datetime' =None, desired_state: 'V1DeploymentState' =None, endpoint: 'V1Endpoint' =None, is_published: 'bool' =None, name: 'str' =None, parameter_spec: 'V1ParameterizationSpec' =None, release_id: 'str' =None, replicas: 'int' =None, spec: 'V1JobSpec' =None, status: 'V1DeploymentStatus' =None, strategy: 'V1DeploymentStrategy' =None, updated_at: 'datetime' =None, user_id: 'str' =None):  # noqa: E501
         """DeploymentsIdBody - a model defined in Swagger"""  # noqa: E501
         self._autoscaling = None
         self._created_at = None
@@ -80,6 +82,7 @@ class DeploymentsIdBody(object):
         self._endpoint = None
         self._is_published = None
         self._name = None
+        self._parameter_spec = None
         self._release_id = None
         self._replicas = None
         self._spec = None
@@ -100,6 +103,8 @@ class DeploymentsIdBody(object):
             self.is_published = is_published
         if name is not None:
             self.name = name
+        if parameter_spec is not None:
+            self.parameter_spec = parameter_spec
         if release_id is not None:
             self.release_id = release_id
         if replicas is not None:
@@ -241,6 +246,27 @@ class DeploymentsIdBody(object):
 
         self._name = name
 
+    @property
+    def parameter_spec(self) -> 'V1ParameterizationSpec':
+        """Gets the parameter_spec of this DeploymentsIdBody.  # noqa: E501
+
+
+        :return: The parameter_spec of this DeploymentsIdBody.  # noqa: E501
+        :rtype: V1ParameterizationSpec
+        """
+        return self._parameter_spec
+
+    @parameter_spec.setter
+    def parameter_spec(self, parameter_spec: 'V1ParameterizationSpec'):
+        """Sets the parameter_spec of this DeploymentsIdBody.
+
+
+        :param parameter_spec: The parameter_spec of this DeploymentsIdBody.  # noqa: E501
+        :type: V1ParameterizationSpec
+        """
+
+        self._parameter_spec = parameter_spec
+
     @property
     def release_id(self) -> 'str':
         """Gets the release_id of this DeploymentsIdBody.  # noqa: E501

lightning_sdk/lightning_cloud/openapi/models/v1_checkbox.py

@@ -0,0 +1,175 @@
+# coding: utf-8
+
+"""
+    external/v1/auth_service.proto
+
+    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
+
+    OpenAPI spec version: version not set
+    
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+    NOTE
+    ----
+    standard swagger-codegen-cli for this python client has been modified
+    by custom templates. The purpose of these templates is to include
+    typing information in the API and Model code. Please refer to the
+    main grid repository for more info
+"""
+
+import pprint
+import re  # noqa: F401
+
+from typing import TYPE_CHECKING
+
+import six
+
+if TYPE_CHECKING:
+    from datetime import datetime
+    from lightning_sdk.lightning_cloud.openapi.models import *
+
+class V1Checkbox(object):
+    """NOTE: This class is auto generated by the swagger code generator program.
+
+    Do not edit the class manually.
+    """
+    """
+    Attributes:
+      swagger_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    swagger_types = {
+        'false_value': 'str',
+        'is_checked': 'bool',
+        'true_value': 'str'
+    }
+
+    attribute_map = {
+        'false_value': 'falseValue',
+        'is_checked': 'isChecked',
+        'true_value': 'trueValue'
+    }
+
+    def __init__(self, false_value: 'str' =None, is_checked: 'bool' =None, true_value: 'str' =None):  # noqa: E501
+        """V1Checkbox - a model defined in Swagger"""  # noqa: E501
+        self._false_value = None
+        self._is_checked = None
+        self._true_value = None
+        self.discriminator = None
+        if false_value is not None:
+            self.false_value = false_value
+        if is_checked is not None:
+            self.is_checked = is_checked
+        if true_value is not None:
+            self.true_value = true_value
+
+    @property
+    def false_value(self) -> 'str':
+        """Gets the false_value of this V1Checkbox.  # noqa: E501
+
+
+        :return: The false_value of this V1Checkbox.  # noqa: E501
+        :rtype: str
+        """
+        return self._false_value
+
+    @false_value.setter
+    def false_value(self, false_value: 'str'):
+        """Sets the false_value of this V1Checkbox.
+
+
+        :param false_value: The false_value of this V1Checkbox.  # noqa: E501
+        :type: str
+        """
+
+        self._false_value = false_value
+
+    @property
+    def is_checked(self) -> 'bool':
+        """Gets the is_checked of this V1Checkbox.  # noqa: E501
+
+
+        :return: The is_checked of this V1Checkbox.  # noqa: E501
+        :rtype: bool
+        """
+        return self._is_checked
+
+    @is_checked.setter
+    def is_checked(self, is_checked: 'bool'):
+        """Sets the is_checked of this V1Checkbox.
+
+
+        :param is_checked: The is_checked of this V1Checkbox.  # noqa: E501
+        :type: bool
+        """
+
+        self._is_checked = is_checked
+
+    @property
+    def true_value(self) -> 'str':
+        """Gets the true_value of this V1Checkbox.  # noqa: E501
+
+
+        :return: The true_value of this V1Checkbox.  # noqa: E501
+        :rtype: str
+        """
+        return self._true_value
+
+    @true_value.setter
+    def true_value(self, true_value: 'str'):
+        """Sets the true_value of this V1Checkbox.
+
+
+        :param true_value: The true_value of this V1Checkbox.  # noqa: E501
+        :type: str
+        """
+
+        self._true_value = true_value
+
+    def to_dict(self) -> dict:
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.swagger_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+        if issubclass(V1Checkbox, dict):
+            for key, value in self.items():
+                result[key] = value
+
+        return result
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self) -> str:
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other: 'V1Checkbox') -> bool:
+        """Returns true if both objects are equal"""
+        if not isinstance(other, V1Checkbox):
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other: 'V1Checkbox') -> bool:
+        """Returns true if both objects are not equal"""
+        return not self == other