fxn 0.0.41__py3-none-any.whl → 0.0.43__py3-none-any.whl

fxn/__init__.py

@@ -1,8 +1,11 @@
 # 
 #   Function
-#   Copyright © 2024 NatML Inc. All Rights Reserved.
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
 #
 
+from .client import FunctionAPIError
+from .compile import compile
 from .function import Function
+from .sandbox import Sandbox
 from .types import *
 from .version import *

fxn/beta/__init__.py

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

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/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/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/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/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/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/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/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/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/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/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/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 archive_predictor, delete_predictor, retrieve_predictor
 from ..version import __version__
 
 # Define CLI
@@ -26,20 +26,20 @@ 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)
+app.command(name="archive", help="Archive a predictor.")(archive_predictor)
+app.command(name="delete", help="Delete a predictor.")(delete_predictor)
 
 # Run
 if __name__ == "__main__":

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/cli/compile.py

@@ -0,0 +1,141 @@
+# 
+#   Function
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
+#
+
+from asyncio import run as run_async
+from importlib.util import module_from_spec, spec_from_file_location
+from inspect import getmembers, getmodulename, isfunction
+from pathlib import Path
+from pydantic import BaseModel
+from re import sub
+from rich import print as print_rich
+from rich.progress import SpinnerColumn, TextColumn
+import sys
+from typer import Argument, Option
+from typing import Callable, Literal
+from urllib.parse import urlparse, urlunparse
+
+from ..compile import PredictorSpec
+from ..function import Function
+from ..sandbox import EntrypointCommand
+from ..logging import CustomProgress, CustomProgressTask
+from .auth import get_access_key
+
+def compile_predictor (
+    path: str=Argument(..., help="Predictor path.")
+):
+    run_async(_compile_predictor_async(path))
+
+async def _compile_predictor_async (path: str):
+    fxn = Function(get_access_key())
+    path: Path = Path(path).resolve()
+    with CustomProgress(
+        SpinnerColumn(spinner_name="dots", finished_text="[bold green]✔[/bold green]"),
+        TextColumn("[progress.description]{task.description}"),
+    ):
+        # Load
+        with CustomProgressTask(loading_text="Loading predictor...") as task:
+            func = _load_predictor_func(path)
+            entrypoint = EntrypointCommand(from_path=str(path), to_path="./", name=func.__name__)
+            spec: PredictorSpec = func.__predictor_spec
+            task.finish(f"Loaded prediction function: [bold cyan]{spec.tag}[/bold cyan]")
+        # Populate
+        sandbox = spec.sandbox
+        sandbox.commands.append(entrypoint)
+        with CustomProgressTask(loading_text="Uploading sandbox...", done_text="Uploaded sandbox"):
+            sandbox.populate(fxn=fxn)
+        # Compile
+        with CustomProgressTask(loading_text="Running codegen...", done_text="Completed codegen"):
+            with CustomProgressTask(loading_text="Creating predictor..."):
+                predictor = fxn.client.request(
+                    method="POST",
+                    path="/predictors",
+                    body=spec.model_dump(mode="json"),
+                    response_type=_Predictor
+                )
+            with ProgressLogQueue() as task_queue:
+                async for event in fxn.client.stream(
+                    method="POST",
+                    path=f"/predictors/{predictor.tag}/compile",
+                    body={ },
+                    response_type=_LogEvent | _ErrorEvent
+                ):
+                    if isinstance(event, _LogEvent):
+                        task_queue.push_log(event)
+                    elif isinstance(event, _ErrorEvent):
+                        task_queue.push_error(event)
+                        raise RuntimeError(event.data.error)
+    predictor_url = _compute_predictor_url(fxn.client.api_url, spec.tag)
+    print_rich(f"\n[bold spring_green3]🎉 Predictor is now being compiled.[/bold spring_green3] Check it out at {predictor_url}")
+
+def _load_predictor_func (path: str) -> Callable[...,object]:
+    if "" not in sys.path:
+        sys.path.insert(0, "")
+    path: Path = Path(path).resolve()
+    sys.path.insert(0, str(path.parent))
+    name = getmodulename(path)
+    spec = spec_from_file_location(name, path)
+    module = module_from_spec(spec)
+    sys.modules[name] = module
+    spec.loader.exec_module(module)
+    main_func = next(func for _, func in getmembers(module, isfunction) if hasattr(func, "__predictor_spec"))
+    return main_func
+
+def _compute_predictor_url (api_url: str, tag: str) -> str:
+    parsed_url = urlparse(api_url)
+    hostname_parts = parsed_url.hostname.split(".")
+    if hostname_parts[0] == "api":
+        hostname_parts.pop(0)
+    hostname = ".".join(hostname_parts)
+    netloc = hostname if not parsed_url.port else f"{hostname}:{parsed_url.port}"
+    predictor_url = urlunparse(parsed_url._replace(netloc=netloc, path=f"{tag}"))
+    return predictor_url
+
+class _Predictor (BaseModel):
+    tag: str
+
+class _LogData (BaseModel):
+    message: str
+    level: int = 0
+
+class _LogEvent (BaseModel):
+    event: Literal["log"]
+    data: _LogData
+
+class _ErrorData (BaseModel):
+    error: str
+
+class _ErrorEvent (BaseModel):
+    event: Literal["error"]
+    data: _ErrorData
+
+class ProgressLogQueue:
+
+    def __init__ (self):
+        self.queue: list[tuple[int, CustomProgressTask]] = []
+
+    def push_log (self, event: _LogEvent):
+        while self.queue:
+            current_level, current_task = self.queue[-1]
+            if event.data.level > current_level:
+                break
+            current_task.__exit__(None, None, None)
+            self.queue.pop()
+        message = sub(r"`([^`]+)`", r"[hot_pink italic]\1[/hot_pink italic]", event.data.message)
+        task = CustomProgressTask(loading_text=message)
+        task.__enter__()
+        self.queue.append((event.data.level, task))
+
+    def push_error (self, error: _ErrorEvent):
+        while self.queue:
+            _, current_task = self.queue.pop()
+            current_task.__exit__(RuntimeError, None, None)
+
+    def __enter__ (self):
+        return self
+    
+    def __exit__ (self, exc_type, exc_value, traceback):
+        while self.queue:
+            _, current_task = self.queue.pop()
+            current_task.__exit__(None, None, None)

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/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
@@ -9,11 +9,11 @@ from numpy import array_repr, ndarray
 from pathlib import Path, PurePath
 from PIL import Image
 from rich import print_json
-from rich.progress import Progress, SpinnerColumn, TextColumn
 from tempfile import mkstemp
 from typer import Argument, Context, Option
 
 from ..function import Function
+from ..logging import CustomProgress, CustomProgressTask
 from ..types import Prediction
 from .auth import get_access_key
 
@@ -26,18 +26,21 @@ def create_prediction (
 
 async def _predict_async (tag: str, quiet: bool, context: Context):
     # Preload
-    fxn = Function(get_access_key())
-    fxn.predictions.create(tag, inputs={ }, verbose=not quiet)
-    # Predict
-    with Progress(
-        SpinnerColumn(spinner_name="dots"),
-        TextColumn("[progress.description]{task.description}"),
-        transient=True
-    ) as progress:
-        progress.add_task(description="Running Function...", total=None)
-        inputs = { context.args[i].replace("-", ""): _parse_value(context.args[i+1]) for i in range(0, len(context.args), 2) }
-        prediction = fxn.predictions.create(tag, inputs=inputs)
-        _log_prediction(prediction)
+    with CustomProgress(transient=True, disable=quiet):
+        fxn = Function(get_access_key())
+        with CustomProgressTask(
+            loading_text="Preloading predictor...",
+            done_text="Preloaded predictor"
+        ):
+            fxn.predictions.create(tag, inputs={ })
+        with CustomProgressTask(loading_text="Making prediction..."):
+            inputs = { }
+            for i in range(0, len(context.args), 2):
+                name = context.args[i].replace("-", "")
+                value = _parse_value(context.args[i+1])
+                inputs[name] = value
+            prediction = fxn.predictions.create(tag, inputs=inputs)
+    _log_prediction(prediction)
 
 def _parse_value (value: str):
     """