qwak-core 0.1.37__py3-none-any.whl → 0.5.19__py3-none-any.whl

qwak/inner/tool/protobuf_factory.py

@@ -0,0 +1,45 @@
+from qwak.exceptions import QwakException
+
+
+def protobuf_factory(
+    protobuf_class, exclude_fields=None, include_only=None, mapping=None
+):
+    def get_final_field_names(cls):
+        fields = dict(cls.__dataclass_fields__)
+        all_field_names = set(fields.keys())
+        excluded_fields = set(exclude_fields) if exclude_fields else set()
+        included_fields = set(include_only) if include_only else all_field_names
+        unrecognized_fields = included_fields.difference(all_field_names)
+        if unrecognized_fields:
+            raise QwakException(
+                f"Unknown fields were included: {list(unrecognized_fields)}"
+            )
+        return included_fields.difference(excluded_fields)
+
+    def protofy_decorator(cls):
+        if not hasattr(cls, "__dataclass_fields__"):
+            raise QwakException("Protofy must receive a dataclass")
+
+        fields_mapping = mapping if mapping else {}
+        final_field_names = get_final_field_names(cls)
+
+        def to_proto(self) -> protobuf_class:
+            final_fields = {}
+            for field_name in final_field_names:
+                field_val = self.__getattribute__(field_name)
+                field_name = (
+                    fields_mapping[field_name]
+                    if field_name in fields_mapping
+                    else field_name
+                )
+                final_fields[field_name] = (
+                    field_val.to_proto()
+                    if hasattr(field_val, "to_proto")
+                    else field_val
+                )
+            return protobuf_class(**final_fields)
+
+        setattr(cls, "to_proto", to_proto)
+        return cls
+
+    return protofy_decorator

qwak/inner/tool/run_config/__init__.py

@@ -6,5 +6,7 @@ from .utils import (
     validate_float,
     validate_int,
     validate_list_of_strings,
+    validate_positive_int,
+    validate_purchase_option,
     validate_string,
 )

qwak/inner/tool/run_config/base.py

@@ -1,13 +1,19 @@
 from abc import ABC, abstractmethod
+from logging import Logger
 from pathlib import Path
-from typing import Any, Dict, List, Tuple
+from typing import Any, Dict, List, Tuple, Optional
 
+from marshmallow import RAISE, Schema
 from marshmallow_dataclass import class_schema
-from qwak.exceptions import QwakException
+from qwak.exceptions import QwakException, LoadConfigurationException
 from yaml import SafeLoader, dump, load
 
 from .utils import ConfigCliMap, rgetattr, rsetattr
 
+ERROR_OPENING_YAML_FILE_MSG = "Error opening the config file"
+ERROR_PARSING_YAML_FILE_MSG = "Error parsing the config file's yaml"
+ERROR_IN_CONFIG_MSG = "Error loading the config"
+
 
 class QwakConfigBase(ABC):
     """Base qwak config object."""
@@ -72,7 +78,9 @@ class QwakConfigBase(ABC):
 
 class YamlConfigMixin(object):
     @classmethod
-    def from_yaml(cls, yaml_path: str) -> Any:
+    def from_yaml(
+        cls, yaml_path: str, unknown: str = RAISE, logger: Optional[Logger] = None
+    ) -> Any:
         """Create instance of class from yaml and class scheme.
 
         Args:
@@ -83,11 +91,28 @@ class YamlConfigMixin(object):
         """
         if not yaml_path:
             return cls()
+        Schema.Meta.unknown = unknown
         schema = class_schema(cls)
-        yaml_content = Path(yaml_path).read_text()
-        yaml_parsed = load(stream=yaml_content, Loader=SafeLoader)
-
-        return schema().load(yaml_parsed)
+        try:
+            yaml_content = Path(yaml_path).read_text()
+        except Exception as e:
+            if logger:
+                logger.error(f"Error opening the config file {yaml_path}")
+            raise LoadConfigurationException(ERROR_OPENING_YAML_FILE_MSG) from e
+
+        try:
+            yaml_parsed = load(stream=yaml_content, Loader=SafeLoader)
+        except Exception as e:
+            if logger:
+                logger.exception(ERROR_PARSING_YAML_FILE_MSG, e)
+            raise LoadConfigurationException(ERROR_PARSING_YAML_FILE_MSG) from e
+
+        try:
+            return schema(unknown=unknown).load(yaml_parsed)
+        except Exception as e:
+            if logger:
+                logger.exception(ERROR_IN_CONFIG_MSG, e)
+            raise LoadConfigurationException(ERROR_IN_CONFIG_MSG) from e
 
     def to_yaml(self) -> str:
         """Convert class by scheme to yaml.

qwak/inner/tool/run_config/utils.py

@@ -1,7 +1,7 @@
 import functools
 from collections.abc import Iterable
 from dataclasses import dataclass, field
-from typing import Any, Callable
+from typing import Any, Callable, Optional
 
 
 @dataclass
@@ -125,6 +125,37 @@ def validate_int(value: Any, is_required: bool) -> bool:
     return True
 
 
+def validate_positive_int(value: Any, is_required: bool) -> bool:
+    """Validate if value is a positive int.
+
+    Args:
+        value: Value to perform validation on.
+        is_required: True if value is required.
+
+    Returns:
+        bool: True if value is valid.
+
+    Examples:
+        >>> validate_positive_int(3, True)
+        True
+        >>> validate_positive_int(3.5, True)
+        False
+        >>> validate_positive_int(None, True)
+        False
+        >>> validate_positive_int(-1, True)
+        False
+    """
+    if value:
+        if isinstance(value, int) or (isinstance(value, str) and value.isdigit()):
+            return int(value) > 0
+        else:
+            return False
+    elif is_required:
+        return False
+
+    return True
+
+
 def validate_bool(value: Any, is_required: bool) -> bool:
     """Validate if value is a boolean.
 
@@ -225,6 +256,40 @@ def validate_variations(value: Any, is_required: bool) -> bool:
     return all(validate_variation(variation) for variation in value)
 
 
+def validate_purchase_option(purchase_option: Optional[str], is_required: bool):
+    """Validate purchase option strings
+
+    Args:
+        purchase_option: the purchase option to validate.
+        is_required: True if value is required.
+
+    Returns:
+        bool: True if value is valid.
+
+    Examples:
+        >>> validate_purchase_option("spot", False)
+        True
+        >>> validate_purchase_option("ondemand", False)
+        True
+        >>> validate_purchase_option(None, False)
+        True
+        >>> validate_purchase_option("Ondemand", False)
+        False
+    """
+    if not purchase_option and not is_required:
+        return True
+    if purchase_option and (
+        not validate_string(purchase_option, False)
+        or purchase_option
+        not in [
+            "ondemand",
+            "spot",
+        ]
+    ):
+        return False
+    return True
+
+
 def rsetattr(obj: object, attr: str, val: Any):
     """Set attribute in object recursively.
 

qwak/llmops/generation/_steaming.py

@@ -0,0 +1,77 @@
+import json
+from typing import Iterator, Type, TypeVar
+
+import requests
+from dacite import Config, from_dict
+from qwak.exceptions.qwak_decode_exception import QwakDecodeException
+from qwak.exceptions.qwak_external_exception import QwakExternalException
+from qwak.llmops.generation.streaming import Stream
+
+_SSEvent = TypeVar("_SSEvent")
+
+
+class BaseSSEDecoder(Stream[_SSEvent]):
+    _response: requests.Response
+    _iterator: Iterator[_SSEvent]
+
+    def __init__(self, response: requests.Response, parse_to: Type[_SSEvent]):
+        if response.encoding is None:
+            response.encoding = "utf-8"
+
+        self._parse_to = parse_to
+
+        self._response = response
+        self._iterator = self.__decode(response=response)
+
+    def _is_chunk_empty(self, chunk: str) -> bool:
+        return not chunk or chunk == "" or chunk.startswith(":") or chunk == ":"
+
+    def _raise_on_chunk_error(self, chunk: str):
+        is_error: bool = False
+        try:
+            maybe_error = json.loads(chunk)
+            if "error" in maybe_error:
+                is_error = True
+        except Exception:  # nosec
+            pass
+
+        if chunk.strip().startswith("error"):
+            is_error = True
+
+        if is_error:
+            raise QwakExternalException(message=chunk)
+
+    def __decode(self, response: requests.Response) -> Iterator[_SSEvent]:
+        chunk: str
+        for chunk in response.iter_lines(chunk_size=None, decode_unicode=True):
+            if self._is_chunk_empty(chunk=chunk):
+                continue
+
+            self._raise_on_chunk_error(chunk=chunk)
+
+            try:
+                if chunk.strip().startswith("[DONE]"):
+                    break
+
+                _, _, content = chunk.partition(":")
+
+                if content.strip().startswith("[DONE]"):
+                    break
+
+                yield self._parse_event(event=content)
+            except Exception as e:
+                raise QwakDecodeException(f"Failed to decode event: {chunk}") from e
+
+    def __iter__(self) -> Iterator[_SSEvent]:
+        for chunk in self._iterator:
+            yield chunk
+
+    def __next__(self) -> _SSEvent:
+        return self._iterator.__next__()
+
+    def _parse_event(self, event: str) -> _SSEvent:
+        return from_dict(
+            data_class=self._parse_to,
+            data=json.loads(event),
+            config=Config(check_types=False),
+        )

qwak/llmops/generation/base.py

@@ -0,0 +1,5 @@
+from abc import ABC
+
+
+class ModelResponse(ABC):
+    pass

qwak/llmops/generation/chat/openai/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 OpenAI
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

qwak/llmops/generation/chat/openai/types/chat/chat_completion.py

@@ -0,0 +1,105 @@
+#
+#    Copyright 2024 OpenAI
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+from dataclasses import dataclass
+from typing import List, Optional
+
+from qwak.llmops.generation.base import ModelResponse
+from .chat_completion_message import ChatCompletionMessage
+from .chat_completion_token_logprob import ChatCompletionTokenLogprob
+from ..completion_usage import CompletionUsage
+
+__all__ = ["ChatCompletion", "Choice", "ChoiceLogprobs"]
+
+
+@dataclass
+class ChoiceLogprobs:
+    content: Optional[List[ChatCompletionTokenLogprob]] = None
+    """A list of message content tokens with log probability information."""
+
+
+@dataclass
+class Choice:
+    finish_reason: str
+    """The reason the model stopped generating tokens.
+
+    This will be `stop` if the model hit a natural stop point or a provided stop
+    sequence, `length` if the maximum number of tokens specified in the request was
+    reached, `content_filter` if content was omitted due to a flag from our content
+    filters, `tool_calls` if the model called a tool, or `function_call`
+    (deprecated) if the model called a function.
+    """
+
+    index: int
+    """The index of the choice in the list of choices."""
+
+    message: ChatCompletionMessage
+    """A chat completion message generated by the model."""
+
+    logprobs: Optional[ChoiceLogprobs] = None
+    """Log probability information for the choice."""
+
+    def __post_init__(self):
+        """Validates that finish_reason is one of the allowed values."""
+        allowed_reasons = {
+            "stop",
+            "length",
+            "tool_calls",
+            "content_filter",
+            "function_call",
+        }
+        if self.finish_reason not in allowed_reasons:
+            raise ValueError(
+                f"Invalid finish_reason: '{self.finish_reason}'. "
+                f"Must be one of {allowed_reasons}"
+            )
+
+
+@dataclass
+class ChatCompletion(ModelResponse):
+    id: str
+    """A unique identifier for the chat completion."""
+
+    choices: List[Choice]
+    """A list of chat completion choices.
+
+    Can be more than one if `n` is greater than 1.
+    """
+
+    created: int
+    """The Unix timestamp (in seconds) of when the chat completion was created."""
+
+    model: str
+    """The model used for the chat completion."""
+
+    object: str
+    """The object type, which is always `chat.completion`."""
+
+    system_fingerprint: Optional[str] = None
+    """This fingerprint represents the backend configuration that the model runs with.
+
+    Can be used in conjunction with the `seed` request parameter to understand when
+    backend changes have been made that might impact determinism.
+    """
+
+    usage: Optional[CompletionUsage] = None
+    """Usage statistics for the completion request."""
+
+    def __post_init__(self):
+        """Validates that the object type is correct."""
+        if self.object != "chat.completion":
+            raise ValueError(
+                f"Invalid object type: '{self.object}'. Must be 'chat.completion'"
+            )

qwak/llmops/generation/chat/openai/types/chat/chat_completion_assistant_message_param.py

@@ -0,0 +1,65 @@
+#
+#    Copyright 2024 OpenAI
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+from __future__ import annotations
+
+from typing import Iterable, Optional
+
+from typing_extensions import Literal, Required, TypedDict
+
+from .chat_completion_message_tool_call_param import ChatCompletionMessageToolCallParam
+
+__all__ = ["ChatCompletionAssistantMessageParam", "FunctionCall"]
+
+
+class FunctionCall(TypedDict, total=False):
+    arguments: Required[str]
+    """
+    The arguments to call the function with, as generated by the model in JSON
+    format. Note that the model does not always generate valid JSON, and may
+    hallucinate parameters not defined by your function schema. Validate the
+    arguments in your code before calling your function.
+    """
+
+    name: Required[str]
+    """The name of the function to call."""
+
+
+class ChatCompletionAssistantMessageParam(TypedDict, total=False):
+    role: Required[Literal["assistant"]]
+    """The role of the messages author, in this case `assistant`."""
+
+    content: Optional[str]
+    """The contents of the assistant message.
+
+    Required unless `tool_calls` or `function_call` is specified.
+    """
+
+    function_call: FunctionCall
+    """Deprecated and replaced by `tool_calls`.
+
+    The name and arguments of a function that should be called, as generated by the
+    model.
+    """
+
+    name: str
+    """An optional name for the participant.
+
+    Provides the model information to differentiate between participants of the same
+    role.
+    """
+
+    tool_calls: Iterable[ChatCompletionMessageToolCallParam]
+    """The tool calls generated by the model, such as function calls."""