kaggle 1.7.4.2__py3-none-any.whl → 1.8.0__py3-none-any.whl

kaggle/models/model_new_instance_request.py

@@ -32,35 +32,49 @@ class ModelNewInstanceRequest(object):
       attribute_map (dict): The key is attribute name
                             and the value is json key in definition.
     """
+
     project_types = {
-        'instance_slug': 'str',
-        'framework': 'str',
-        'overview': 'str',
-        'usage': 'str',
-        'license_name': 'str',
-        'fine_tunable': 'bool',
-        'training_data': 'list[str]',
-        'model_instance_type': 'str',
-        'base_model_instance': 'str',
-        'external_base_model_url': 'int',
-        'files': 'list[UploadFile]'
+        "instance_slug": "str",
+        "framework": "str",
+        "overview": "str",
+        "usage": "str",
+        "license_name": "str",
+        "fine_tunable": "bool",
+        "training_data": "list[str]",
+        "model_instance_type": "str",
+        "base_model_instance": "str",
+        "external_base_model_url": "int",
+        "files": "list[UploadFile]",
     }
 
     attribute_map = {
-        'instance_slug': 'instanceSlug',
-        'framework': 'framework',
-        'overview': 'overview',
-        'usage': 'usage',
-        'license_name': 'licenseName',
-        'fine_tunable': 'fineTunable',
-        'training_data': 'trainingData',
-        'model_instance_type': 'modelInstanceType',
-        'base_model_instance': 'baseModelInstance',
-        'external_base_model_url': 'externalBaseModelUrl',
-        'files': 'files'
+        "instance_slug": "instanceSlug",
+        "framework": "framework",
+        "overview": "overview",
+        "usage": "usage",
+        "license_name": "licenseName",
+        "fine_tunable": "fineTunable",
+        "training_data": "trainingData",
+        "model_instance_type": "modelInstanceType",
+        "base_model_instance": "baseModelInstance",
+        "external_base_model_url": "externalBaseModelUrl",
+        "files": "files",
     }
 
-    def __init__(self, instance_slug=None, framework=None, overview=None, usage=None, license_name='Apache 2.0', fine_tunable=True, training_data=None, model_instance_type=None, base_model_instance=None, external_base_model_url=None, files=None):  # noqa: E501
+    def __init__(
+        self,
+        instance_slug=None,
+        framework=None,
+        overview=None,
+        usage=None,
+        license_name="Apache 2.0",
+        fine_tunable=True,
+        training_data=None,
+        model_instance_type=None,
+        base_model_instance=None,
+        external_base_model_url=None,
+        files=None,
+    ):  # noqa: E501
 
         self._instance_slug = None
         self._framework = None
@@ -97,11 +111,14 @@ class ModelNewInstanceRequest(object):
 
     @property
     def instance_slug(self):
-        """Gets the instance_slug of this ModelNewInstanceRequest.  # noqa: E501
+        """Gets the instance_slug of this ModelNewInstanceRequest.  # noqa:
+        E501.
 
-        The slug that the model instance should be created with  # noqa: E501
+        The slug that the model instance should be created with  # noqa:
+        E501
 
-        :return: The instance_slug of this ModelNewInstanceRequest.  # noqa: E501
+        :return: The instance_slug of this ModelNewInstanceRequest. #
+            noqa: E501
         :rtype: str
         """
         return self._instance_slug
@@ -110,9 +127,11 @@ class ModelNewInstanceRequest(object):
     def instance_slug(self, instance_slug):
         """Sets the instance_slug of this ModelNewInstanceRequest.
 
-        The slug that the model instance should be created with  # noqa: E501
+        The slug that the model instance should be created with  # noqa:
+        E501
 
-        :param instance_slug: The instance_slug of this ModelNewInstanceRequest.  # noqa: E501
+        :param instance_slug: The instance_slug of this
+            ModelNewInstanceRequest. # noqa: E501
         :type: str
         """
         if instance_slug is None:
@@ -122,11 +141,12 @@ class ModelNewInstanceRequest(object):
 
     @property
     def framework(self):
-        """Gets the framework of this ModelNewInstanceRequest.  # noqa: E501
+        """Gets the framework of this ModelNewInstanceRequest.  # noqa: E501.
 
         The framework of the model instance  # noqa: E501
 
-        :return: The framework of this ModelNewInstanceRequest.  # noqa: E501
+        :return: The framework of this ModelNewInstanceRequest. # noqa:
+            E501
         :rtype: str
         """
         return self._framework
@@ -137,27 +157,55 @@ class ModelNewInstanceRequest(object):
 
         The framework of the model instance  # noqa: E501
 
-        :param framework: The framework of this ModelNewInstanceRequest.  # noqa: E501
+        :param framework: The framework of this ModelNewInstanceRequest.
+            # noqa: E501
         :type: str
         """
         if framework is None:
             raise ValueError("Invalid value for `framework`, must not be `None`")  # noqa: E501
-        allowed_values = ["tensorFlow1", "tensorFlow2", "tfLite", "tfJs", "pyTorch", "jax", "flax", "pax", "maxText", "gemmaCpp", "tensorRtLlm", "ggml", "gguf", "coral", "scikitLearn", "mxnet", "onnx", "keras", "transformers", "triton", "api", "triton", "tensorRtLlm","other"]  # noqa: E501
+        allowed_values = [
+            "tensorFlow1",
+            "tensorFlow2",
+            "tfLite",
+            "tfJs",
+            "pyTorch",
+            "jax",
+            "flax",
+            "pax",
+            "maxText",
+            "gemmaCpp",
+            "tensorRtLlm",
+            "ggml",
+            "gguf",
+            "coral",
+            "scikitLearn",
+            "mxnet",
+            "onnx",
+            "keras",
+            "transformers",
+            "triton",
+            "api",
+            "triton",
+            "tensorRtLlm",
+            "other",
+        ]  # noqa: E501
         if framework not in allowed_values:
             raise ValueError(
-                "Invalid value for `framework` ({0}), must be one of {1}"  # noqa: E501
-                .format(framework, allowed_values)
+                "Invalid value for `framework` ({0}), must be one of {1}".format(  # noqa: E501
+                    framework, allowed_values
+                )
             )
 
         self._framework = framework
 
     @property
     def overview(self):
-        """Gets the overview of this ModelNewInstanceRequest.  # noqa: E501
+        """Gets the overview of this ModelNewInstanceRequest.  # noqa: E501.
 
         The overview of the model instance (markdown)  # noqa: E501
 
-        :return: The overview of this ModelNewInstanceRequest.  # noqa: E501
+        :return: The overview of this ModelNewInstanceRequest. # noqa:
+            E501
         :rtype: str
         """
         return self._overview
@@ -168,7 +216,8 @@ class ModelNewInstanceRequest(object):
 
         The overview of the model instance (markdown)  # noqa: E501
 
-        :param overview: The overview of this ModelNewInstanceRequest.  # noqa: E501
+        :param overview: The overview of this ModelNewInstanceRequest. #
+            noqa: E501
         :type: str
         """
 
@@ -176,11 +225,13 @@ class ModelNewInstanceRequest(object):
 
     @property
     def usage(self):
-        """Gets the usage of this ModelNewInstanceRequest.  # noqa: E501
+        """Gets the usage of this ModelNewInstanceRequest.  # noqa: E501.
 
-        The description of how to use the model instance (markdown)  # noqa: E501
+        The description of how to use the model instance (markdown)  #
+        noqa: E501
 
-        :return: The usage of this ModelNewInstanceRequest.  # noqa: E501
+        :return: The usage of this ModelNewInstanceRequest. # noqa:
+            E501
         :rtype: str
         """
         return self._usage
@@ -189,9 +240,11 @@ class ModelNewInstanceRequest(object):
     def usage(self, usage):
         """Sets the usage of this ModelNewInstanceRequest.
 
-        The description of how to use the model instance (markdown)  # noqa: E501
+        The description of how to use the model instance (markdown)  #
+        noqa: E501
 
-        :param usage: The usage of this ModelNewInstanceRequest.  # noqa: E501
+        :param usage: The usage of this ModelNewInstanceRequest. #
+            noqa: E501
         :type: str
         """
 
@@ -199,11 +252,14 @@ class ModelNewInstanceRequest(object):
 
     @property
     def license_name(self):
-        """Gets the license_name of this ModelNewInstanceRequest.  # noqa: E501
+        """Gets the license_name of this ModelNewInstanceRequest.  # noqa:
+        E501.
 
-        The license that should be associated with the model instance  # noqa: E501
+        The license that should be associated with the model instance  #
+        noqa: E501
 
-        :return: The license_name of this ModelNewInstanceRequest.  # noqa: E501
+        :return: The license_name of this ModelNewInstanceRequest. #
+            noqa: E501
         :rtype: str
         """
         return self._license_name
@@ -212,29 +268,92 @@ class ModelNewInstanceRequest(object):
     def license_name(self, license_name):
         """Sets the license_name of this ModelNewInstanceRequest.
 
-        The license that should be associated with the model instance  # noqa: E501
+        The license that should be associated with the model instance  #
+        noqa: E501
 
-        :param license_name: The license_name of this ModelNewInstanceRequest.  # noqa: E501
+        :param license_name: The license_name of this
+            ModelNewInstanceRequest. # noqa: E501
         :type: str
         """
         if license_name is None:
             raise ValueError("Invalid value for `license_name`, must not be `None`")  # noqa: E501
-        allowed_values = ["CC0 1.0", "CC BY-NC-SA 4.0", "Unknown", "CC BY-SA 4.0", "GPL 2", "CC BY-SA 3.0", "Other", "Other (specified in description)", "CC BY 4.0", "Attribution 4.0 International (CC BY 4.0)", "CC BY-NC 4.0", "Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)", "PDDL", "ODC Public Domain Dedication and Licence (PDDL)", "CC BY 3.0", "Attribution 3.0 Unported (CC BY 3.0)", "CC BY 3.0 IGO", "Attribution 3.0 IGO (CC BY 3.0 IGO)", "CC BY-NC-SA 3.0 IGO", "Attribution-NonCommercial-ShareAlike 3.0 IGO (CC BY-NC-SA 3.0 IGO)", "CDLA Permissive 1.0", "Community Data License Agreement - Permissive - Version 1.0", "CDLA Sharing 1.0", "Community Data License Agreement - Sharing - Version 1.0", "CC BY-ND 4.0", "Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)", "CC BY-NC-ND 4.0", "Attribution-NonCommercial-NoDerivatives 4.0 International (CC BY-NC-ND 4.0)", "ODC-BY 1.0", "ODC Attribution License (ODC-By)", "LGPL 3.0", "GNU Lesser General Public License 3.0", "AGPL 3.0", "GNU Affero General Public License 3.0", "FDL 1.3", "GNU Free Documentation License 1.3", "apache-2.0", "Apache 2.0", "mit", "MIT", "bsd-3-clause", "BSD-3-Clause", "Llama 2", "Llama 2 Community License", "Gemma", "gpl-3", "GPL 3", "RAIL-M", "AI Pubs Open RAIL-M License", "AIPubs Research-Use RAIL-M", "AI Pubs Research-Use RAIL-M License", "BigScience OpenRAIL-M", "BigScience Open RAIL-M License", "RAIL", "RAIL (specified in description)", "Llama 3", "Llama 3 Community License"]  # noqa: E501
+        allowed_values = [
+            "CC0 1.0",
+            "CC BY-NC-SA 4.0",
+            "Unknown",
+            "CC BY-SA 4.0",
+            "GPL 2",
+            "CC BY-SA 3.0",
+            "Other",
+            "Other (specified in description)",
+            "CC BY 4.0",
+            "Attribution 4.0 International (CC BY 4.0)",
+            "CC BY-NC 4.0",
+            "Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)",
+            "PDDL",
+            "ODC Public Domain Dedication and Licence (PDDL)",
+            "CC BY 3.0",
+            "Attribution 3.0 Unported (CC BY 3.0)",
+            "CC BY 3.0 IGO",
+            "Attribution 3.0 IGO (CC BY 3.0 IGO)",
+            "CC BY-NC-SA 3.0 IGO",
+            "Attribution-NonCommercial-ShareAlike 3.0 IGO (CC BY-NC-SA 3.0 IGO)",
+            "CDLA Permissive 1.0",
+            "Community Data License Agreement - Permissive - Version 1.0",
+            "CDLA Sharing 1.0",
+            "Community Data License Agreement - Sharing - Version 1.0",
+            "CC BY-ND 4.0",
+            "Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)",
+            "CC BY-NC-ND 4.0",
+            "Attribution-NonCommercial-NoDerivatives 4.0 International (CC BY-NC-ND 4.0)",
+            "ODC-BY 1.0",
+            "ODC Attribution License (ODC-By)",
+            "LGPL 3.0",
+            "GNU Lesser General Public License 3.0",
+            "AGPL 3.0",
+            "GNU Affero General Public License 3.0",
+            "FDL 1.3",
+            "GNU Free Documentation License 1.3",
+            "apache-2.0",
+            "Apache 2.0",
+            "mit",
+            "MIT",
+            "bsd-3-clause",
+            "BSD-3-Clause",
+            "Llama 2",
+            "Llama 2 Community License",
+            "Gemma",
+            "gpl-3",
+            "GPL 3",
+            "RAIL-M",
+            "AI Pubs Open RAIL-M License",
+            "AIPubs Research-Use RAIL-M",
+            "AI Pubs Research-Use RAIL-M License",
+            "BigScience OpenRAIL-M",
+            "BigScience Open RAIL-M License",
+            "RAIL",
+            "RAIL (specified in description)",
+            "Llama 3",
+            "Llama 3 Community License",
+        ]  # noqa: E501
         if license_name not in allowed_values:
             raise ValueError(
-                "Invalid value for `license_name` ({0}), must be one of {1}"  # noqa: E501
-                .format(license_name, allowed_values)
+                "Invalid value for `license_name` ({0}), must be one of {1}".format(  # noqa: E501
+                    license_name, allowed_values
+                )
             )
 
         self._license_name = license_name
 
     @property
     def fine_tunable(self):
-        """Gets the fine_tunable of this ModelNewInstanceRequest.  # noqa: E501
+        """Gets the fine_tunable of this ModelNewInstanceRequest.  # noqa:
+        E501.
 
         Whether the model instance is fine tunable  # noqa: E501
 
-        :return: The fine_tunable of this ModelNewInstanceRequest.  # noqa: E501
+        :return: The fine_tunable of this ModelNewInstanceRequest. #
+            noqa: E501
         :rtype: bool
         """
         return self._fine_tunable
@@ -245,7 +364,8 @@ class ModelNewInstanceRequest(object):
 
         Whether the model instance is fine tunable  # noqa: E501
 
-        :param fine_tunable: The fine_tunable of this ModelNewInstanceRequest.  # noqa: E501
+        :param fine_tunable: The fine_tunable of this
+            ModelNewInstanceRequest. # noqa: E501
         :type: bool
         """
 
@@ -253,11 +373,13 @@ class ModelNewInstanceRequest(object):
 
     @property
     def training_data(self):
-        """Gets the training_data of this ModelNewInstanceRequest.  # noqa: E501
+        """Gets the training_data of this ModelNewInstanceRequest.  # noqa:
+        E501.
 
         A list of training data (urls or names)  # noqa: E501
 
-        :return: The training_data of this ModelNewInstanceRequest.  # noqa: E501
+        :return: The training_data of this ModelNewInstanceRequest. #
+            noqa: E501
         :rtype: list[str]
         """
         return self._training_data
@@ -268,7 +390,8 @@ class ModelNewInstanceRequest(object):
 
         A list of training data (urls or names)  # noqa: E501
 
-        :param training_data: The training_data of this ModelNewInstanceRequest.  # noqa: E501
+        :param training_data: The training_data of this
+            ModelNewInstanceRequest. # noqa: E501
         :type: list[str]
         """
 
@@ -276,11 +399,14 @@ class ModelNewInstanceRequest(object):
 
     @property
     def model_instance_type(self):
-        """Gets the model_instance_type of this ModelNewInstanceRequest.  # noqa: E501
+        """Gets the model_instance_type of this ModelNewInstanceRequest.  #
+        noqa: E501.
 
-        Whether the model instance is a base model, external variant, internal variant, or unspecified  # noqa: E501
+        Whether the model instance is a base model, external variant,
+        internal variant, or unspecified  # noqa: E501
 
-        :return: The model_instance_type of this ModelNewInstanceRequest.  # noqa: E501
+        :return: The model_instance_type of this
+            ModelNewInstanceRequest. # noqa: E501
         :rtype: str
         """
         return self._model_instance_type
@@ -289,23 +415,27 @@ class ModelNewInstanceRequest(object):
     def model_instance_type(self, model_instance_type):
         """Sets the model_instance_type of this ModelNewInstanceRequest.
 
-        Whether the model instance is a base model, external variant, internal variant, or unspecified  # noqa: E501
+        Whether the model instance is a base model, external variant,
+        internal variant, or unspecified  # noqa: E501
 
-        :param model_instance_type: The model_instance_type of this ModelNewInstanceRequest.  # noqa: E501
+        :param model_instance_type: The model_instance_type of this
+            ModelNewInstanceRequest. # noqa: E501
         :type: str
         """
         allowed_values = ["Unspecified", "BaseModel", "KaggleVariant", "ExternalVariant"]  # noqa: E501
         if model_instance_type not in allowed_values:
             raise ValueError(
-                "Invalid value for `model_instance_type` ({0}), must be one of {1}"  # noqa: E501
-                .format(model_instance_type, allowed_values)
+                "Invalid value for `model_instance_type` ({0}), must be one of {1}".format(  # noqa: E501
+                    model_instance_type, allowed_values
+                )
             )
 
         self._model_instance_type = model_instance_type
 
     @property
     def base_model_instance(self):
-        """Gets the base_model_instance of this ModelNewInstanceRequest.  # noqa: E501
+        """Gets the base_model_instance of this ModelNewInstanceRequest.  #
+        noqa: E501.
 
         If this is an internal variant, the `{owner-slug}/{model-slug}/{framework}/{instance-slug}` of the base model instance  # noqa: E501
 
@@ -328,11 +458,14 @@ class ModelNewInstanceRequest(object):
 
     @property
     def external_base_model_url(self):
-        """Gets the external_base_model_url of this ModelNewInstanceRequest.  # noqa: E501
+        """Gets the external_base_model_url of this ModelNewInstanceRequest.  #
+        noqa: E501.
 
-        If this is an external variant, a URL to the base model  # noqa: E501
+        If this is an external variant, a URL to the base model  # noqa:
+        E501
 
-        :return: The external_base_model_url of this ModelNewInstanceRequest.  # noqa: E501
+        :return: The external_base_model_url of this
+            ModelNewInstanceRequest. # noqa: E501
         :rtype: int
         """
         return self._external_base_model_url
@@ -341,9 +474,11 @@ class ModelNewInstanceRequest(object):
     def external_base_model_url(self, external_base_model_url):
         """Sets the external_base_model_url of this ModelNewInstanceRequest.
 
-        If this is an external variant, a URL to the base model  # noqa: E501
+        If this is an external variant, a URL to the base model  # noqa:
+        E501
 
-        :param external_base_model_url: The external_base_model_url of this ModelNewInstanceRequest.  # noqa: E501
+        :param external_base_model_url: The external_base_model_url of
+            this ModelNewInstanceRequest. # noqa: E501
         :type: int
         """
 
@@ -351,11 +486,12 @@ class ModelNewInstanceRequest(object):
 
     @property
     def files(self):
-        """Gets the files of this ModelNewInstanceRequest.  # noqa: E501
+        """Gets the files of this ModelNewInstanceRequest.  # noqa: E501.
 
-        A list of files that should be associated with the model instance version  # noqa: E501
+        A list of files that should be associated with the model
+        instance version  # noqa: E501
 
-        :return: The files of this ModelNewInstanceRequest.  # noqa: E501
+        :return: The files of this ModelNewInstanceRequest. # noqa: E501
         :rtype: list[UploadFile]
         """
         return self._files
@@ -364,40 +500,40 @@ class ModelNewInstanceRequest(object):
     def files(self, files):
         """Sets the files of this ModelNewInstanceRequest.
 
-        A list of files that should be associated with the model instance version  # noqa: E501
+        A list of files that should be associated with the model
+        instance version  # noqa: E501
 
-        :param files: The files of this ModelNewInstanceRequest.  # noqa: E501
+        :param files: The files of this ModelNewInstanceRequest. #
+            noqa: E501
         :type: list[UploadFile]
         """
 
         self._files = files
 
     def to_dict(self):
-        """Returns the model properties as a dict"""
+        """Returns the model properties as a dict."""
         result = {}
 
         for attr, _ in six.iteritems(self.project_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
-                ))
+                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()
-                ))
+                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
 
         return result
 
     def to_str(self):
-        """Returns the string representation of the model"""
+        """Returns the string representation of the model."""
         return pprint.pformat(self.to_dict())
 
     def __repr__(self):
@@ -405,13 +541,12 @@ class ModelNewInstanceRequest(object):
         return self.to_str()
 
     def __eq__(self, other):
-        """Returns true if both objects are equal"""
+        """Returns true if both objects are equal."""
         if not isinstance(other, ModelNewInstanceRequest):
             return False
 
         return self.__dict__ == other.__dict__
 
     def __ne__(self, other):
-        """Returns true if both objects are not equal"""
+        """Returns true if both objects are not equal."""
         return not self == other
-