frogml-inference 0.0.1__tar.gz

frogml_inference-0.0.1/LICENSE

@@ -0,0 +1,194 @@
+Apache License
+==============
+
+_Version 2.0, January 2004_
+_&lt;<http://www.apache.org/licenses/>&gt;_
+
+### 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 [yyyy] [name of copyright owner]
+
+    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.

frogml_inference-0.0.1/PKG-INFO

@@ -0,0 +1,38 @@
+Metadata-Version: 2.3
+Name: frogml-inference
+Version: 0.0.1
+Summary: FrogML Inference is a Python library for running predictions again Frogml Models.
+License: Apache-2.0
+Keywords: mlops,ml,deployment,serving,model
+Author: JFrog Ltd.
+Author-email: contact@jfrog.com
+Requires-Python: >=3.9,<3.12
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Provides-Extra: batch
+Requires-Dist: boto3 (>=1.24.89,<2.0.0) ; extra == "batch"
+Requires-Dist: frogml (>=1.1.0) ; extra == "batch"
+Requires-Dist: google-cloud-storage (>=2.14.0,<3.0.0)
+Requires-Dist: joblib (>=1.1.0,<2.0.0) ; extra == "batch"
+Requires-Dist: numpy (>=1.21.6) ; python_full_version >= "3.7.1" and python_version < "3.10"
+Requires-Dist: numpy (>=1.24.0) ; python_version >= "3.10"
+Requires-Dist: pandas (<1.4) ; (python_full_version >= "3.7.1" and python_version < "3.8") and (extra == "batch")
+Requires-Dist: pandas (>=1.4.0) ; (python_version >= "3.8" and python_version < "3.12") and (extra == "batch")
+Requires-Dist: pyarrow (>=6.0.0,<11.0.0) ; extra == "batch"
+Requires-Dist: requests (>=2.0.0,<3.0.0)
+Requires-Dist: tenacity (>=8.0.0,<9.0.0) ; extra == "batch"
+Description-Content-Type: text/markdown
+
+# Qwak Inference
+
+FrogML 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.
+FrogML Inference contains tools that allow predicting against the FrogML Platform
+

frogml_inference-0.0.1/README.md

@@ -0,0 +1,4 @@
+# Qwak Inference
+
+FrogML 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.
+FrogML Inference contains tools that allow predicting against the FrogML Platform

frogml_inference-0.0.1/frogml_inference/__init__.py

@@ -0,0 +1,22 @@
+from frogml_inference.realtime_client import RealTimeClient
+
+clients = ["RealTimeClient"]
+try:
+    from frogml import wire_dependencies
+
+    from frogml_inference.batch_client.batch_client import BatchInferenceClient
+
+    clients.extend(["BatchInferenceClient"])
+
+    wire_dependencies()
+except ImportError:
+    # We are conditional loading these clients since the skinny does
+    # not support them due to the pandas, numpy, joblib, etc. dependencies
+    print(
+        "Notice that BatchInferenceClient is not available in the skinny package. "
+        'In order to use it, please install them as extras: pip install "frogml-inference[batch]".'
+    )
+
+__all__ = clients
+
+__version__ = "0.0.1"

frogml_inference-0.0.1/frogml_inference/authentication/_login_arguments.py

@@ -0,0 +1,22 @@
+from typing import Optional
+
+
+class LoginArguments:
+    is_anonymous: bool = False
+    server_id: Optional[str] = None
+    username: Optional[str] = None
+    password: Optional[str] = None
+    access_token: Optional[str] = None
+    artifactory_url: Optional[str] = None
+
+    def __eq__(self, __value):
+        if not isinstance(__value, LoginArguments):
+            return False
+        return (
+            self.is_anonymous == __value.is_anonymous
+            and self.server_id == __value.server_id
+            and self.username == __value.username
+            and self.password == __value.password
+            and self.access_token == __value.access_token
+            and self.artifactory_url == __value.artifactory_url
+        )

frogml_inference-0.0.1/frogml_inference/authentication/_utils.py

@@ -0,0 +1,20 @@
+from requests.auth import AuthBase
+
+
+class BearerAuth(AuthBase):
+    def __init__(self, token):
+        self.token = token
+
+    def __call__(self, r):
+        r.headers["Authorization"] = f"Bearer {self.token}"
+        return r
+
+    def __eq__(self, other):
+        if not isinstance(other, BearerAuth):
+            return False
+        return self.token == other.token
+
+
+class EmptyAuth(AuthBase):
+    def __call__(self, r):
+        return r

frogml_inference-0.0.1/frogml_inference/authentication/authentication_utils.py

@@ -0,0 +1,198 @@
+import json
+import os
+from typing import Optional, Tuple
+
+from requests.auth import AuthBase, HTTPBasicAuth
+
+from frogml_inference.authentication._login_arguments import LoginArguments
+from frogml_inference.authentication._utils import BearerAuth, EmptyAuth
+from frogml_inference.authentication.constants import (
+    CONFIG_FILE_PATH,
+    FROG_ML_CONFIG_ACCESS_TOKEN,
+    FROG_ML_CONFIG_ARTIFACTORY_URL,
+    FROG_ML_CONFIG_PASSWORD,
+    FROG_ML_CONFIG_USER,
+    JF_ACCESS_TOKEN,
+    JF_URL,
+)
+from frogml_inference.configuration.auth_config import AuthConfig
+from frogml_inference.configuration.log_config import logger
+
+
+def read_frogml_config() -> Optional[dict]:
+    try:
+        with open(CONFIG_FILE_PATH, "r") as file:
+            config_data = json.load(file)
+            return config_data
+    except FileNotFoundError:
+        logger.debug("FrogMl config file was not found.")
+        return None
+    except json.JSONDecodeError as e:
+        logger.debug(f"FrogMl config file is not a valid JSON {e}.")
+        return None
+
+
+def __check_is_valid_frogml_auth_file(server_config: dict) -> bool:
+    has_url: bool = FROG_ML_CONFIG_ARTIFACTORY_URL in server_config
+    if not has_url:
+        logger.debug(
+            "Invalid FrogMl authentication file, expected either artifactory_url in FrogMl authentication file"
+        )
+        return False
+
+    has_user: bool = FROG_ML_CONFIG_USER in server_config
+    has_password: bool = FROG_ML_CONFIG_PASSWORD in server_config
+    is_missing_user_or_password: bool = (has_user and not has_password) or (
+        not has_user and has_password
+    )
+
+    if is_missing_user_or_password:
+        logger.debug(
+            "Invalid FrogMl authentication file, username or password is missing in FrogMl authentication file"
+        )
+        return False
+
+    return True
+
+
+def __get_login_arguments(server_config: dict) -> LoginArguments:
+    login_args = LoginArguments()
+    login_args.artifactory_url = server_config.get(FROG_ML_CONFIG_ARTIFACTORY_URL)
+
+    has_access_token: bool = FROG_ML_CONFIG_ACCESS_TOKEN in server_config
+    has_user: bool = FROG_ML_CONFIG_USER in server_config
+    has_password: bool = FROG_ML_CONFIG_PASSWORD in server_config
+
+    if has_access_token:
+        login_args.access_token = server_config.get(FROG_ML_CONFIG_ACCESS_TOKEN)
+    elif has_user and has_password:
+        login_args.username = server_config.get(FROG_ML_CONFIG_USER)
+        login_args.password = server_config.get(FROG_ML_CONFIG_PASSWORD)
+
+    is_anonymous = (
+        login_args.username is None
+        and login_args.password is None
+        and login_args.access_token is None
+    )
+    if is_anonymous:
+        login_args.is_anonymous = True
+
+    return login_args
+
+
+def get_frogml_configuration() -> Optional[LoginArguments]:
+    frog_ml_config: Optional[dict] = read_frogml_config()
+    is_frogml_config_not_defined: bool = (
+        not frog_ml_config
+        or frog_ml_config.get("servers") is None
+        or len(frog_ml_config["servers"]) <= 0
+    )
+
+    if is_frogml_config_not_defined:
+        return None
+
+    server_config: dict = frog_ml_config["servers"][0]
+    is_valid_auth_file: bool = __check_is_valid_frogml_auth_file(server_config)
+
+    if not is_valid_auth_file:
+        return None
+
+    login_args: LoginArguments = __get_login_arguments(server_config)
+
+    return login_args
+
+
+def get_credentials(auth_config: Optional[AuthConfig] = None) -> Tuple[str, AuthBase]:
+    if not __should_use_file_auth(auth_config):
+        __validate_credentials(auth_config)
+        return __auth_config_to_auth_tuple(auth_config)
+    logger.debug(
+        "Login configuration not supplied, attempting to find environment variables"
+    )
+
+    if __should_use_environment_variables():
+        return get_environment_variables()
+
+    logger.debug(
+        "Environment variables not supplied, attempting to load configuration from file"
+    )
+
+    if os.path.exists(CONFIG_FILE_PATH):
+        return __read_credentials_from_file(CONFIG_FILE_PATH)
+    raise ValueError(
+        f"Configuration were not provided and configuration file not found in {CONFIG_FILE_PATH},"
+        f" either pass configuration in the constructor, add env variables or create the configuration file by "
+        f"running `frogml login`"
+    )
+
+
+def __should_use_environment_variables() -> bool:
+    return os.getenv("JF_URL") is not None
+
+
+def get_environment_variables() -> Tuple[str, AuthBase]:
+    auth_config: AuthConfig = AuthConfig(
+        artifactory_url=os.getenv(JF_URL),
+        access_token=os.getenv(JF_ACCESS_TOKEN),
+    )
+
+    return __auth_config_to_auth_tuple(auth_config)
+
+
+def __should_use_file_auth(credentials: Optional[AuthConfig] = None) -> bool:
+    return credentials is None or (
+        credentials.artifactory_url is None
+        and credentials.user is None
+        and credentials.password is None
+        and credentials.access_token is None
+    )
+
+
+def __validate_credentials(credentials: Optional[AuthConfig]) -> None:
+    if credentials is None:
+        raise ValueError("Credentials must be provided.")
+    if credentials.artifactory_url is None:
+        raise ValueError("Credentials must contain artifactory url.")
+    return None
+
+
+def __read_credentials_from_file(file_path: str) -> Tuple[str, AuthBase]:
+    try:
+        with open(file_path, "r") as file:
+            config_content: dict = json.load(file)
+            servers = config_content.get("servers")
+            if servers is None or len(servers) == 0:
+                raise ValueError(
+                    "Configuration file was found but it's empty, failing authentication"
+                )
+            server = servers[0]
+            return __auth_config_to_auth_tuple(AuthConfig.from_dict(server))
+    except json.JSONDecodeError:
+        raise ValueError(f"Error when reading {file_path}, please recreate the file.")
+
+
+def __auth_config_to_auth_tuple(
+    auth_config: Optional[AuthConfig],
+) -> Tuple[str, AuthBase]:
+    if auth_config.artifactory_url is None:
+        raise ValueError("No artifactory URL provided")
+
+    auth: AuthBase = __get_auth_provider(auth_config)
+
+    return auth_config.artifactory_url, auth
+
+
+def __get_auth_provider(auth_config: Optional[AuthConfig]) -> AuthBase:
+    auth: AuthBase = EmptyAuth()
+
+    if auth_config is None:
+        raise ValueError("No authentication configuration provided")
+
+    if auth_config.access_token is not None:
+        auth = BearerAuth(auth_config.access_token)
+    elif auth_config.user is not None and auth_config.password is not None:
+        auth = HTTPBasicAuth(auth_config.user, auth_config.password)
+    elif auth_config.user is not None or auth_config.password is not None:
+        raise ValueError("User and password must be provided together")
+
+    return auth

frogml_inference-0.0.1/frogml_inference/authentication/constants.py

@@ -0,0 +1,12 @@
+import os
+from pathlib import Path, PosixPath
+
+FROGML_DIR_PATH: PosixPath = Path.home() / ".frogml"
+CONFIG_FILE_PATH: str = os.path.join(FROGML_DIR_PATH, "config.json")
+FROG_ML_CONFIG_USER = "user"
+FROG_ML_CONFIG_ARTIFACTORY_URL = "artifactory_url"
+SERVER_ID = "server_id"
+JF_URL = "JF_URL"
+JF_ACCESS_TOKEN = "JF_ACCESS_TOKEN"  # nosec B105
+FROG_ML_CONFIG_PASSWORD = "password"  # nosec B105
+FROG_ML_CONFIG_ACCESS_TOKEN = "access_token"  # nosec B105