fxn 0.0.41__tar.gz → 0.0.42__tar.gz

{fxn-0.0.41 → fxn-0.0.42}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: fxn
-Version: 0.0.41
+Version: 0.0.42
 Summary: Run prediction functions locally in Python. Register at https://fxn.ai.
 Author-email: "NatML Inc." <hi@fxn.ai>
 License:                                  Apache License

fxn-0.0.42/fxn/__init__.py

@@ -0,0 +1,10 @@
+# 
+#   Function
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
+#
+
+from .client import FunctionAPIError
+from .compile import *
+from .function import Function
+from .types import *
+from .version import *

fxn-0.0.42/fxn/beta/__init__.py

@@ -0,0 +1,6 @@
+# 
+#   Function
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
+#
+
+from .remote import RemoteAcceleration

fxn-0.0.42/fxn/beta/client.py

@@ -0,0 +1,16 @@
+# 
+#   Function
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
+#
+
+from ..client import FunctionClient
+from .prediction import PredictionService
+
+class BetaClient:
+    """
+    Client for incubating features.
+    """
+    predictions: PredictionService
+    
+    def __init__ (self, client: FunctionClient):
+        self.predictions = PredictionService(client)

fxn-0.0.42/fxn/beta/prediction.py

@@ -0,0 +1,16 @@
+# 
+#   Function
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
+#
+
+from ..client import FunctionClient
+from .remote import RemotePredictionService
+
+class PredictionService:
+    """
+    Make predictions.
+    """
+    remote: RemotePredictionService
+
+    def __init__ (self, client: FunctionClient):
+        self.remote = RemotePredictionService(client)

fxn-0.0.42/fxn/beta/remote.py

@@ -0,0 +1,207 @@
+# 
+#   Function
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
+#
+
+from __future__ import annotations
+from base64 import b64encode
+from dataclasses import asdict, is_dataclass
+from enum import Enum
+from io import BytesIO
+from json import dumps, loads
+from numpy import array, frombuffer, ndarray
+from PIL import Image
+from pydantic import BaseModel, Field
+from requests import get, put
+from typing import Any
+from urllib.request import urlopen
+
+from ..c import Configuration
+from ..client import FunctionClient
+from ..services import Value
+from ..types import Dtype, Prediction
+
+class RemoteAcceleration (str, Enum):
+    """
+    Remote acceleration.
+    """
+    Auto = "auto"
+    CPU = "cpu"
+    A40 = "a40"
+    A100 = "a100"
+
+class RemotePredictionService:
+    """
+    Make remote predictions.
+    """
+
+    def __init__ (self, client: FunctionClient):
+        self.client = client
+
+    def create (
+        self,
+        tag: str,
+        *,
+        inputs: dict[str, Value],
+        acceleration: RemoteAcceleration=RemoteAcceleration.Auto
+    ) -> Prediction:
+        """
+        Create a remote prediction.
+
+        Parameters:
+            tag (str): Predictor tag.
+            inputs (dict): Input values.
+            acceleration (RemoteAcceleration): Prediction acceleration.
+
+        Returns:
+            Prediction: Created prediction.
+        """
+        input_map = { name: self.__to_value(value, name=name).model_dump(mode="json") for name, value in inputs.items() }
+        prediction = self.client.request(
+            method="POST",
+            path="/predictions/remote",
+            body={
+                "tag": tag,
+                "inputs": input_map,
+                "acceleration": acceleration,
+                "clientId": Configuration.get_client_id()
+            },
+            response_type=RemotePrediction
+        )
+        results = list(map(self.__to_object, prediction.results)) if prediction.results is not None else None
+        prediction = Prediction(**{ **prediction.model_dump(), "results": results })
+        return prediction
+
+    def __to_value (
+        self,
+        object: Value,
+        *,
+        name: str,
+        max_data_url_size: int=4 * 1024 * 1024
+    ) -> RemoteValue:
+        object = self.__try_ensure_serializable(object)
+        if object is None:
+            return RemoteValue(data=None, type=Dtype.null)
+        elif isinstance(object, float):
+            object = array(object, dtype=Dtype.float32)
+            return self.__to_value(object, name=name, max_data_url_size=max_data_url_size)
+        elif isinstance(object, bool):
+            object = array(object, dtype=Dtype.bool)
+            return self.__to_value(object, name=name, max_data_url_size=max_data_url_size)
+        elif isinstance(object, int):
+            object = array(object, dtype=Dtype.int32)
+            return self.__to_value(object, name=name, max_data_url_size=max_data_url_size)
+        elif isinstance(object, ndarray):
+            buffer = BytesIO(object.tobytes())
+            data = self.__upload(buffer, name=name, max_data_url_size=max_data_url_size)
+            return RemoteValue(data=data, type=object.dtype.name, shape=list(object.shape))
+        elif isinstance(object, str):
+            buffer = BytesIO(object.encode())
+            data = self.__upload(buffer, name=name, mime="text/plain", max_data_url_size=max_data_url_size)
+            return RemoteValue(data=data, type=Dtype.string)
+        elif isinstance(object, list):
+            buffer = BytesIO(dumps(object).encode())
+            data = self.__upload(buffer, name=name, mime="application/json", max_data_url_size=max_data_url_size)
+            return RemoteValue(data=data, type=Dtype.list)
+        elif isinstance(object, dict):
+            buffer = BytesIO(dumps(object).encode())
+            data = self.__upload(buffer, name=name, mime="application/json", max_data_url_size=max_data_url_size)
+            return RemoteValue(data=data, type=Dtype.dict)
+        elif isinstance(object, Image.Image):
+            buffer = BytesIO()
+            format = "PNG" if object.mode == "RGBA" else "JPEG"
+            mime = f"image/{format.lower()}"
+            object.save(buffer, format=format)
+            data = self.__upload(buffer, name=name, mime=mime, max_data_url_size=max_data_url_size)
+            return RemoteValue(data=data, type=Dtype.image)
+        elif isinstance(object, BytesIO):
+            data = self.__upload(object, name=name, max_data_url_size=max_data_url_size)
+            return RemoteValue(data=data, type=Dtype.binary)
+        else:
+            raise ValueError(f"Failed to serialize value '{object}' of type `{type(object)}` because it is not supported")
+
+    def __to_object (self, value: RemoteValue) -> Value:
+        if value.type == Dtype.null:
+            return None
+        buffer = self.__download(value.data)
+        if value.type in [
+            Dtype.int8, Dtype.int16, Dtype.int32, Dtype.int64,
+            Dtype.uint8, Dtype.uint16, Dtype.uint32, Dtype.uint64,
+            Dtype.float16, Dtype.float32, Dtype.float64, Dtype.bool
+        ]:
+            assert value.shape is not None, "Array value must have a shape specified"
+            array = frombuffer(buffer.getbuffer(), dtype=value.type).reshape(value.shape)
+            return array if len(value.shape) > 0 else array.item()
+        elif value.type == Dtype.string:
+            return buffer.getvalue().decode("utf-8")
+        elif value.type in [Dtype.list, Dtype.dict]:
+            return loads(buffer.getvalue().decode("utf-8"))
+        elif value.type == Dtype.image:
+            return Image.open(buffer)
+        elif value.type == Dtype.binary:
+            return buffer
+        else:
+            raise ValueError(f"Failed to deserialize value with type `{value.type}` because it is not supported")
+
+    def __upload (
+        self,
+        data: BytesIO,
+        *,
+        name: str,
+        mime: str="application/octet-stream",
+        max_data_url_size: int=4 * 1024 * 1024
+    ) -> str:
+        if data.getbuffer().nbytes <= max_data_url_size:
+            encoded_data = b64encode(data.getvalue()).decode("ascii")
+            return f"data:{mime};base64,{encoded_data}"
+        value = self.client.request(
+            method="POST",
+            path="/values",
+            body={ "name": name },
+            response_type=CreateValueResponse
+        )
+        put(
+            value.upload_url,
+            data=data,
+            headers={ "Content-Type": mime }
+        ).raise_for_status()
+        return value.download_url
+
+    def __download (self, url: str) -> BytesIO:
+        if url.startswith("data:"):
+            with urlopen(url) as response:
+                return BytesIO(response.read())
+        response = get(url)
+        response.raise_for_status()
+        result = BytesIO(response.content)
+        return result
+
+    @classmethod
+    def __try_ensure_serializable (cls, object: Any) -> Any:
+        if object is None:
+            return object
+        if isinstance(object, list):
+            return [cls.__try_ensure_serializable(x) for x in object]
+        if is_dataclass(object) and not isinstance(object, type):
+            return asdict(object)
+        if isinstance(object, BaseModel):
+            return object.model_dump(mode="json", by_alias=True)
+        return object
+
+class RemoteValue (BaseModel):
+    data: str | None
+    type: Dtype
+    shape: list[int] | None = None
+
+class RemotePrediction (BaseModel):
+    id: str
+    tag: str
+    created: str
+    results: list[RemoteValue] | None
+    latency: float | None
+    error: str | None
+    logs: str | None
+
+class CreateValueResponse (BaseModel):
+    upload_url: str = Field(validation_alias="uploadUrl")
+    download_url: str = Field(validation_alias="downloadUrl")

{fxn-0.0.41 → fxn-0.0.42}/fxn/c/__init__.py

@@ -1,6 +1,6 @@
 #
 #   Function
-#   Copyright © 2024 NatML Inc. All Rights Reserved.
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
 #
 
 # https://github.com/fxnai/fxnc

{fxn-0.0.41 → fxn-0.0.42}/fxn/c/configuration.py

@@ -1,6 +1,6 @@
 #
 #   Function
-#   Copyright © 2024 NatML Inc. All Rights Reserved.
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
 #
 
 from ctypes import byref, c_int, c_void_p, create_string_buffer

{fxn-0.0.41 → fxn-0.0.42}/fxn/c/fxnc.py

@@ -1,6 +1,6 @@
 #
 #   Function
-#   Copyright © 2024 NatML Inc. All Rights Reserved.
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
 #
 
 from ctypes import CDLL

{fxn-0.0.41 → fxn-0.0.42}/fxn/c/map.py

@@ -1,6 +1,6 @@
 #
 #   Function
-#   Copyright © 2024 NatML Inc. All Rights Reserved.
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
 #
 
 from ctypes import byref, c_int, c_int32, c_void_p, create_string_buffer

{fxn-0.0.41 → fxn-0.0.42}/fxn/c/prediction.py

@@ -1,9 +1,9 @@
 #
 #   Function
-#   Copyright © 2024 NatML Inc. All Rights Reserved.
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
 #
 
-from ctypes import byref, c_double, c_int, c_int32, c_void_p, create_string_buffer
+from ctypes import byref, c_double, c_int32, c_void_p, create_string_buffer
 from pathlib import Path
 from typing import final
 

{fxn-0.0.41 → fxn-0.0.42}/fxn/c/predictor.py

@@ -1,10 +1,9 @@
 #
 #   Function
-#   Copyright © 2024 NatML Inc. All Rights Reserved.
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
 #
 
-from ctypes import byref, c_int, c_int32, c_void_p, create_string_buffer
-from pathlib import Path
+from ctypes import byref, c_void_p
 from typing import final
 
 from .configuration import Configuration

{fxn-0.0.41 → fxn-0.0.42}/fxn/c/stream.py

@@ -1,10 +1,9 @@
 #
 #   Function
-#   Copyright © 2024 NatML Inc. All Rights Reserved.
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
 #
 
-from ctypes import byref, c_int, c_int32, c_void_p, create_string_buffer
-from pathlib import Path
+from ctypes import byref, c_void_p
 from typing import final
 
 from .fxnc import get_fxnc, status_to_error, FXNStatus

{fxn-0.0.41 → fxn-0.0.42}/fxn/c/value.py

@@ -1,6 +1,6 @@
 #
 #   Function
-#   Copyright © 2024 NatML Inc. All Rights Reserved.
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
 #
 
 from __future__ import annotations

{fxn-0.0.41 → fxn-0.0.42}/fxn/cli/__init__.py

@@ -1,15 +1,15 @@
 # 
 #   Function
-#   Copyright © 2024 NatML Inc. All Rights Reserved.
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
 #
 
 from typer import Typer
 
 from .auth import app as auth_app
-from .env import app as env_app
+#from .compile import compile_predictor
 from .misc import cli_options
 from .predictions import create_prediction
-from .predictors import archive_predictor, delete_predictor, list_predictors, retrieve_predictor, search_predictors
+from .predictors import retrieve_predictor
 from ..version import __version__
 
 # Define CLI
@@ -26,20 +26,18 @@ app.callback()(cli_options)
 
 # Add subcommands
 app.add_typer(auth_app, name="auth", help="Login, logout, and check your authentication status.")
-#app.add_typer(env_app, name="env", help="Manage predictor environment variables.")
 
 # Add top-level commands
-#app.command(name="create", help="Create a predictor.")(create_predictor)
-#app.command(name="delete", help="Delete a predictor.")(delete_predictor)
 app.command(
     name="predict",
     help="Make a prediction.",
     context_settings={ "allow_extra_args": True, "ignore_unknown_options": True }
 )(create_prediction)
-#app.command(name="list", help="List predictors.")(list_predictors)
-#app.command(name="search", help="Search predictors.")(search_predictors)
-#app.command(name="retrieve", help="Retrieve a predictor.")(retrieve_predictor)
-#app.command(name="archive", help="Archive a predictor.")(archive_predictor)
+# app.command(
+#     name="compile",
+#     help="Create a predictor by compiling a Python function."
+# )(compile_predictor)
+app.command(name="retrieve", help="Retrieve a predictor.")(retrieve_predictor)
 
 # Run
 if __name__ == "__main__":

{fxn-0.0.41 → fxn-0.0.42}/fxn/cli/auth.py

@@ -1,6 +1,6 @@
 # 
 #   Function
-#   Copyright © 2024 NatML Inc. All Rights Reserved.
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
 #
 
 from pathlib import Path

{fxn-0.0.41 → fxn-0.0.42}/fxn/cli/misc.py

@@ -1,6 +1,6 @@
 # 
 #   Function
-#   Copyright © 2024 NatML Inc. All Rights Reserved.
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
 #
 
 from rich import print

{fxn-0.0.41 → fxn-0.0.42}/fxn/cli/predictions.py

@@ -1,6 +1,6 @@
 # 
 #   Function
-#   Copyright © 2024 NatML Inc. All Rights Reserved.
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
 #
 
 from asyncio import run as run_async

fxn-0.0.42/fxn/cli/predictors.py

@@ -0,0 +1,18 @@
+# 
+#   Function
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
+#
+
+from rich import print_json
+from typer import Argument
+
+from ..function import Function
+from .auth import get_access_key
+
+def retrieve_predictor (
+    tag: str=Argument(..., help="Predictor tag.")
+):
+    fxn = Function(get_access_key())
+    predictor = fxn.predictors.retrieve(tag)
+    predictor = predictor.model_dump() if predictor else None
+    print_json(data=predictor)

{fxn-0.0.41 → fxn-0.0.42}/fxn/client.py

@@ -1,10 +1,14 @@
 #
 #   Function
-#   Copyright © 2024 NatML Inc. All Rights Reserved.
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
 #
 
+from json import loads, JSONDecodeError
+from pydantic import BaseModel
 from requests import request
-from typing import Any, Literal
+from typing import Any, Literal, Type, TypeVar
+
+T = TypeVar("T", bound=BaseModel)
 
 class FunctionClient:
     
@@ -17,23 +21,25 @@ class FunctionClient:
         *,
         method: Literal["GET", "POST", "DELETE"],
         path: str,
-        body: dict[str, Any]=None
-    ) -> dict[str, Any] | list[Any]:
+        body: dict[str, Any]=None,
+        response_type: Type[T]=None
+    ) -> T:
         response = request(
             method=method,
             url=f"{self.api_url}{path}",
             json=body,
             headers={ "Authorization": f"Bearer {self.access_key}" }
         )
-        data = None
+        data = response.text
         try:
             data = response.json()
-        except Exception as ex:
-            raise FunctionAPIError(str(ex), response.status_code)
-        if not response.ok:
-            error = data["errors"][0]["message"] if "errors" in data else str(ex)
+        except JSONDecodeError:
+            pass
+        if response.ok:
+            return response_type(**data) if response_type is not None else None
+        else:
+            error = _ErrorResponse(**data).errors[0].message if isinstance(data, dict) else data
             raise FunctionAPIError(error, response.status_code)
-        return data
 
 class FunctionAPIError (Exception):
 
@@ -43,4 +49,10 @@ class FunctionAPIError (Exception):
         self.status_code = status_code
 
     def __str__(self):
-        return f"FunctionAPIError: {self.message} (Status Code: {self.status_code})"
+        return f"FunctionAPIError: {self.message} (Status Code: {self.status_code})"
+    
+class _APIError (BaseModel):
+    message: str
+
+class _ErrorResponse (BaseModel):
+    errors: list[_APIError]

fxn-0.0.42/fxn/compile/__init__.py

@@ -0,0 +1,7 @@
+# 
+#   Function
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
+#
+
+from .compile import compile
+from .sandbox import Sandbox

fxn-0.0.42/fxn/compile/compile.py

@@ -0,0 +1,80 @@
+# 
+#   Function
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
+#
+
+from collections.abc import Callable
+from functools import wraps
+from pathlib import Path
+from pydantic import BaseModel, Field
+
+from ..types import AccessMode, Signature
+from .sandbox import Sandbox
+from .signature import get_function_type, infer_function_signature, FunctionType
+
+class PredictorSpec (BaseModel):
+    """
+    Descriptor of a predictor to be compiled.
+    """
+    tag: str = Field(description="Predictor tag.")
+    description: str = Field(description="Predictor description. MUST be less than 100 characters long.", min_length=4, max_length=100)
+    sandbox: Sandbox = Field(description="Sandbox to compile the function.")
+    access: AccessMode = Field(description="Predictor access.")
+    signature: Signature = Field(description="Predictor signature.")
+    card: str | None = Field(default=None, description="Predictor card (markdown).")
+    media: str | None = Field(default=None, description="Predictor media URL.")
+    license: str | None = Field(default=None, description="Predictor license URL. This is required for public predictors.")
+
+def compile (
+    tag: str,
+    *,
+    description: str,
+    sandbox: Sandbox=None,
+    access: AccessMode=AccessMode.Private,
+    card: str | Path=None,
+    media: Path=None,
+    license: str=None,
+):
+    """
+    Create a predictor by compiling a stateless function.
+
+    Parameters:
+        tag (str): Predictor tag.
+        description (str): Predictor description. MUST be less than 100 characters long.
+        sandbox (Sandbox): Sandbox to compile the function.
+        access (AccessMode): Predictor access.
+        card (str | Path): Predictor card markdown string or path to card.
+        media (Path): Predictor thumbnail image (jpeg or png) path.
+        license (str): Predictor license URL. This is required for public predictors.
+    """
+    def decorator (func: Callable):
+        # Check type
+        if not callable(func):
+            raise TypeError("Cannot compile non-function objects")
+        func_type = get_function_type(func)
+        if func_type not in { FunctionType.Function, FunctionType.Generator }:
+            raise TypeError(f"Function '{func.__name__}' must be a regular function or generator")
+        # Gather metadata
+        signature = infer_function_signature(func) # throws
+        if isinstance(card, Path):
+            with open(card_content, "r") as f:
+                card_content = f.read()
+        else:
+            card_content = card
+        spec = PredictorSpec(
+            tag=tag,
+            description=description,
+            sandbox=sandbox if sandbox is not None else Sandbox(),
+            access=access,
+            signature=signature,
+            card=card_content,
+            media=None, # INCOMPLETE
+            license=license
+        )
+        # Wrap
+        @wraps(func)
+        def wrapper (*args, **kwargs):
+            return func(*args, **kwargs)
+        wrapper.__predictor_spec = spec
+        return wrapper
+    return decorator