fxn 0.0.21__py3-none-any.whl → 0.0.23__py3-none-any.whl

fxn/__init__.py

@@ -6,7 +6,7 @@
 from os import environ
 
 # Define API URL and access key
-api_url = environ.get("FXN_API_URL", "https://api.fxn.ai/graph")
+api_url = environ.get("FXN_API_URL", "https://api.fxn.ai")
 access_key: str = environ.get("FXN_ACCESS_KEY", None)
 
 # Import everything

fxn/api/api.py

@@ -3,11 +3,11 @@
 #   Copyright © 2023 NatML Inc. All Rights Reserved.
 #
 
-from requests import post
-
 import fxn
+from requests import post
+from typing import Any, Dict
 
-def query (query: str, variables: dict=None, access_key: str=None) -> dict:
+def query (query: str, variables: dict=None, access_key: str=None) -> Dict[str, Any]:
     """
     Query the Function graph API.
 
@@ -22,16 +22,19 @@ def query (query: str, variables: dict=None, access_key: str=None) -> dict:
     access_key = access_key or fxn.access_key
     headers = { "Authorization": f"Bearer {access_key}" } if access_key else { }
     response = post(
-        fxn.api_url,
+        f"{fxn.api_url}/graph",
         json={ "query": query, "variables": variables },
         headers=headers
     )
     # Check
-    response.raise_for_status()
-    response = response.json()
+    payload = response.json()
+    try:
+        response.raise_for_status()
+    except:
+        raise RuntimeError(payload.get("error"))
     # Check error
-    if "errors" in response:
-        raise RuntimeError(response["errors"][0]["message"])
+    if "errors" in payload:
+        raise RuntimeError(payload["errors"][0]["message"])
     # Return
-    result = response["data"]
+    result = payload["data"]
     return result

fxn/api/prediction.py

@@ -4,12 +4,15 @@
 #
 
 from __future__ import annotations
+from aiohttp import ClientSession
 from dataclasses import asdict, dataclass
+import fxn
+from json import dumps, loads
 from numpy import ndarray
 from pathlib import Path
 from PIL import Image
 from platform import system
-from typing import Any, Dict, List, Union
+from typing import Any, AsyncIterator, Dict, List, Union
 from uuid import uuid4
 
 from .api import query
@@ -72,7 +75,7 @@ class Prediction:
         Returns:
             CloudPrediction | EdgePrediction: Created prediction.
         """
-        # Collect inputs
+        # Serialize inputs
         key = uuid4().hex
         inputs = { name: Value.from_value(value, name, key=key) for name, value in inputs.items() }
         inputs = [{ "name": name, **asdict(value) } for name, value in inputs.items()]
@@ -86,19 +89,57 @@ class Prediction:
             { "input": { "tag": tag, "client": cls.__get_client(), "inputs": inputs, "dataUrlLimit": data_url_limit } },
             access_key=access_key
         )
-        # Check
-        prediction = response["createPrediction"]
-        if not prediction:
-            return None
-        # Parse results
-        if "results" in prediction and prediction["results"] is not None:
-            prediction["results"] = [Value(**value) for value in prediction["results"]]
-            if not raw_outputs:
-                prediction["results"] = [value.to_value(return_binary_path=return_binary_path) for value in prediction["results"]]
-        # Create
-        prediction = CloudPrediction(**prediction) if prediction["type"] == PredictorType.Cloud else EdgePrediction(**prediction)
+        # Parse
+        prediction = cls.__parse_prediction(response["createPrediction"])
         # Return
         return prediction
+    
+    @classmethod
+    async def stream (
+        cls,
+        tag: str,
+        raw_outputs: bool=False,
+        return_binary_path: bool=True,
+        data_url_limit: int=None,
+        access_key: str=None,
+        **inputs: Dict[str, Union[ndarray, str, float, int, bool, List, Dict[str, Any], Path, Image.Image, Value]],
+    ) -> AsyncIterator[Union[CloudPrediction, EdgePrediction]]:
+        """
+        Create a streaming prediction.
+
+        NOTE: This feature is currently experimental.
+
+        Parameters:
+            tag (str): Predictor tag.
+            raw_outputs (bool): Skip converting output values into Pythonic types.
+            return_binary_path (bool): Write binary values to file and return a `Path` instead of returning `BytesIO` instance.
+            data_url_limit (int): Return a data URL if a given output value is smaller than this size in bytes. Only applies to `CLOUD` predictions.
+            access_key (str): Function access key.
+            inputs (dict): Input values. Only applies to `CLOUD` predictions.
+
+        Returns:
+            CloudPrediction | EdgePrediction: Created prediction.
+        """
+        # Serialize inputs
+        key = uuid4().hex
+        inputs = { name: asdict(Value.from_value(value, name, key=key)) for name, value in inputs.items() }
+        # Request
+        url = f"{fxn.api_url}/predict/{tag}?stream=true&rawOutputs=true&dataUrlLimit={data_url_limit}"
+        headers = {
+            "Content-Type": "application/json",
+            "Authorization": f"Bearer {access_key or fxn.access_key}",
+            "fxn-client": cls.__get_client()
+        }
+        async with ClientSession(headers=headers) as session:
+            async with session.post(url, data=dumps(inputs)) as response:
+                async for chunk in response.content.iter_any():
+                    payload = loads(chunk)
+                    # Check status
+                    if response.status >= 400:
+                        raise RuntimeError(payload.get("error"))
+                    # Yield
+                    prediction = cls.__parse_prediction(payload, raw_outputs=raw_outputs, return_binary_path=return_binary_path)
+                    yield prediction
 
     @classmethod
     def __get_client (cls) -> str:
@@ -110,6 +151,22 @@ class Prediction:
         if id == "Windows":
             return "windows"
         raise RuntimeError(f"Function cannot make predictions on the {id} platform")
+    
+    @classmethod
+    def __parse_prediction (
+        cls,
+        prediction: Dict[str, Any],
+        raw_outputs: bool=False,
+        return_binary_path: bool=True
+    ) -> Union[CloudPrediction, EdgePrediction]:
+        if not prediction:
+            return None
+        if "results" in prediction and prediction["results"] is not None:
+            prediction["results"] = [Value(**value) for value in prediction["results"]]
+            if not raw_outputs:
+                prediction["results"] = [value.to_value(return_binary_path=return_binary_path) for value in prediction["results"]]
+        prediction = CloudPrediction(**prediction) if prediction["type"] == PredictorType.Cloud else EdgePrediction(**prediction)
+        return prediction
 
 @dataclass(frozen=True)
 class CloudPrediction (Prediction):

fxn/api/predictor.py

@@ -417,6 +417,7 @@ class AccessMode (str, Enum):
     """
     Public = "PUBLIC"
     Private = "PRIVATE"
+    Protected = "PROTECTED"
 
 class PredictorType (str, Enum):
     """

fxn/version.py

@@ -3,4 +3,4 @@
 #   Copyright © 2023 NatML Inc. All Rights Reserved.
 #
 
-__version__ = "0.0.21"
+__version__ = "0.0.23"

{fxn-0.0.21.dist-info → fxn-0.0.23.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fxn
-Version: 0.0.21
+Version: 0.0.23
 Summary: Run on-device and cloud AI prediction functions in Python. Register at https://fxn.ai.
 Home-page: https://fxn.ai
 Author: NatML Inc.
@@ -17,9 +17,11 @@ Classifier: Topic :: Software Development :: Libraries
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: aiohttp
 Requires-Dist: filetype
 Requires-Dist: numpy
 Requires-Dist: pillow
+Requires-Dist: pydantic
 Requires-Dist: requests
 Requires-Dist: rich
 Requires-Dist: typer

{fxn-0.0.21.dist-info → fxn-0.0.23.dist-info}/RECORD

@@ -1,12 +1,12 @@
-fxn/__init__.py,sha256=0NzZl5hRQ0MPNN4Wp9-ghqak2NJzhfHvVyBGX-IntKs,320
+fxn/__init__.py,sha256=S_HfYZK-ppKazPThGnm3Ei9NG51fq_2dJVLnYiZH20U,314
 fxn/magic.py,sha256=TRgE68OAo1djmeQRiqxnSJqa72td6zxnwo0s0bkdUKM,1041
-fxn/version.py,sha256=pS0q_JGq_GGDrxYMd6x6dFCVcxH7u2LZZZT1h2PnK4g,95
+fxn/version.py,sha256=3ETsrDYC7I_z2qdkmyQKAUISJj_eLlE6C7S-GZ8bisA,95
 fxn/api/__init__.py,sha256=UcCERjadfSbqnt7urXYbrdRRFwA0QwpC9uBQYPJC5rE,460
-fxn/api/api.py,sha256=X2LRjer0s7ifecYsZmdqv5txEwPjA2ekdSCGUaQJ5So,927
+fxn/api/api.py,sha256=rvrj7L37F1YQBnfJJT4rkGWIp1Q-XACFThu3D0kyiFA,1046
 fxn/api/dtype.py,sha256=z9zjjsOk8X8LTCEpwLuWOTUys6nP_3L6VmZXLt0ilAY,617
 fxn/api/environment.py,sha256=qZObVWl2UneTy9iYm4b1KRHiapW1qafvVp4P6s5KBCc,3874
-fxn/api/prediction.py,sha256=IKyFZ593FvlVVF0sljPR8S3m7JSX0TSOAK_9s24I5eU,4140
-fxn/api/predictor.py,sha256=kPoHL50dr7RvDmznkBLy9KgUWSy7PPBYkn8FRWk9jv8,13133
+fxn/api/prediction.py,sha256=EU-k68BNnY-56yHj3yikJRh2FFjf32LDl44vWipOSFw,6663
+fxn/api/predictor.py,sha256=nzrcYArtCFXOt_FD-EoF-2rmVI4Rw0CztvdbNAelwtM,13161
 fxn/api/profile.py,sha256=76RVnP0wF9eT5kefqbRVj2T7e-6yZbK4bzggDS1CYjY,876
 fxn/api/storage.py,sha256=GxSwYN5xOWovVJh1WfkVkwkWdCoBkeNP9OHTX8KgEiQ,4560
 fxn/api/tag.py,sha256=g7HuRv5ZCYYDy4iV8P0hR1tEQ1pZjv-HeqbE0-Li1Bs,832
@@ -18,9 +18,9 @@ fxn/cli/env.py,sha256=mnyaL27n59pCU-p2Jm1fo03se7btMV2zdoJWWVshF_M,1658
 fxn/cli/misc.py,sha256=gLEGGWyawUQaLOuy8bfS2wrJuS-tN-bleOrv5A07xck,690
 fxn/cli/predict.py,sha256=YP7BiqnT39AeeA3A9EXfHmw-6t5vCxOu27_kjinWdGE,3178
 fxn/cli/predictors.py,sha256=vAL1FioQSseEiu7jbXY0DRiHnnMmThK2csJLThizS7A,3481
-fxn-0.0.21.dist-info/LICENSE,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
-fxn-0.0.21.dist-info/METADATA,sha256=1TAftjeYqJAaSUEgkUioXFghSBPyEK0P_NdPaeDNjSk,2887
-fxn-0.0.21.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-fxn-0.0.21.dist-info/entry_points.txt,sha256=QBwKIRed76CRY98VYQYrQDVEBZtJugxJJmBpilxuios,46
-fxn-0.0.21.dist-info/top_level.txt,sha256=1ULIEGrnMlhId8nYAkjmRn9g3KEFuHKboq193SEKQkA,4
-fxn-0.0.21.dist-info/RECORD,,
+fxn-0.0.23.dist-info/LICENSE,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
+fxn-0.0.23.dist-info/METADATA,sha256=AOo1jp5RVouQOm6Q68lhVgA4w0Bo3wGoknRkyB38kUY,2934
+fxn-0.0.23.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+fxn-0.0.23.dist-info/entry_points.txt,sha256=QBwKIRed76CRY98VYQYrQDVEBZtJugxJJmBpilxuios,46
+fxn-0.0.23.dist-info/top_level.txt,sha256=1ULIEGrnMlhId8nYAkjmRn9g3KEFuHKboq193SEKQkA,4
+fxn-0.0.23.dist-info/RECORD,,