fxn 0.0.39__tar.gz → 0.0.41__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fxn
-Version: 0.0.39
+Version: 0.0.41
 Summary: Run prediction functions locally in Python. Register at https://fxn.ai.
 Author-email: "NatML Inc." <hi@fxn.ai>
 License:                                  Apache License
@@ -227,9 +227,12 @@ Requires-Dist: typer
 
 ![function logo](https://raw.githubusercontent.com/fxnai/.github/main/logo_wide.png)
 
-[![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fdiscord.com%2Fapi%2Finvites%2Fy5vwgXkz2f%3Fwith_counts%3Dtrue&query=%24.approximate_member_count&logo=discord&logoColor=white&label=Function%20community)](https://fxn.ai/community)
+[![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fdiscord.com%2Fapi%2Finvites%2Fy5vwgXkz2f%3Fwith_counts%3Dtrue&query=%24.approximate_member_count&logo=discord&logoColor=white&label=Function%20community)](https://discord.gg/fxn)
 
-Run prediction functions (a.k.a "predictors") locally in your Python apps, with full GPU acceleration and zero dependencies. In a few steps:
+Run prediction functions (a.k.a "predictors") locally in your Python apps, with full GPU acceleration and zero dependencies.
+
+> [!TIP]
+> [Join our waitlist](https://fxn.ai/waitlist) to bring your custom Python functions and run them on-device across Android, iOS, macOS, Linux, web, and Windows.
 
 ## Installing Function
 Function is distributed on PyPi. This distribution contains both the Python client and the command line interface (CLI). To install, open a terminal and run the following command:
@@ -266,9 +269,6 @@ prediction = fxn.predictions.create(
 print(prediction.results[0])
 ```
 
-> [!TIP]
-> Explore public predictors [on Function](https://fxn.ai/explore) or [create your own](https://fxn.ai/waitlist).
-
 ## Using the Function CLI
 Open up a terminal and login to the Function CLI:
 ```sh
@@ -286,7 +286,7 @@ ___
 
 ## Useful Links
 - [Discover predictors to use in your apps](https://fxn.ai/explore).
-- [Join our Discord community](https://fxn.ai/community).
+- [Join our Discord community](https://discord.gg/fxn).
 - [Check out our docs](https://docs.fxn.ai).
 - Learn more about us [on our blog](https://blog.fxn.ai).
 - Reach out to us at [hi@fxn.ai](mailto:hi@fxn.ai).

{fxn-0.0.39 → fxn-0.0.41}/README.md

@@ -2,9 +2,12 @@
 
 ![function logo](https://raw.githubusercontent.com/fxnai/.github/main/logo_wide.png)
 
-[![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fdiscord.com%2Fapi%2Finvites%2Fy5vwgXkz2f%3Fwith_counts%3Dtrue&query=%24.approximate_member_count&logo=discord&logoColor=white&label=Function%20community)](https://fxn.ai/community)
+[![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fdiscord.com%2Fapi%2Finvites%2Fy5vwgXkz2f%3Fwith_counts%3Dtrue&query=%24.approximate_member_count&logo=discord&logoColor=white&label=Function%20community)](https://discord.gg/fxn)
 
-Run prediction functions (a.k.a "predictors") locally in your Python apps, with full GPU acceleration and zero dependencies. In a few steps:
+Run prediction functions (a.k.a "predictors") locally in your Python apps, with full GPU acceleration and zero dependencies.
+
+> [!TIP]
+> [Join our waitlist](https://fxn.ai/waitlist) to bring your custom Python functions and run them on-device across Android, iOS, macOS, Linux, web, and Windows.
 
 ## Installing Function
 Function is distributed on PyPi. This distribution contains both the Python client and the command line interface (CLI). To install, open a terminal and run the following command:
@@ -41,9 +44,6 @@ prediction = fxn.predictions.create(
 print(prediction.results[0])
 ```
 
-> [!TIP]
-> Explore public predictors [on Function](https://fxn.ai/explore) or [create your own](https://fxn.ai/waitlist).
-
 ## Using the Function CLI
 Open up a terminal and login to the Function CLI:
 ```sh
@@ -61,7 +61,7 @@ ___
 
 ## Useful Links
 - [Discover predictors to use in your apps](https://fxn.ai/explore).
-- [Join our Discord community](https://fxn.ai/community).
+- [Join our Discord community](https://discord.gg/fxn).
 - [Check out our docs](https://docs.fxn.ai).
 - Learn more about us [on our blog](https://blog.fxn.ai).
 - Reach out to us at [hi@fxn.ai](mailto:hi@fxn.ai).

fxn-0.0.41/fxn/c/__init__.py

@@ -0,0 +1,13 @@
+#
+#   Function
+#   Copyright © 2024 NatML Inc. All Rights Reserved.
+#
+
+# https://github.com/fxnai/fxnc
+
+from .configuration import Configuration
+from .map import ValueMap
+from .prediction import Prediction
+from .predictor import Predictor
+from .stream import PredictionStream
+from .value import Value, ValueFlags

fxn-0.0.41/fxn/c/configuration.py

@@ -0,0 +1,118 @@
+#
+#   Function
+#   Copyright © 2024 NatML Inc. All Rights Reserved.
+#
+
+from ctypes import byref, c_int, c_void_p, create_string_buffer
+from pathlib import Path
+from typing import final
+
+from ..types import Acceleration
+from .fxnc import get_fxnc, status_to_error, FXNStatus
+
+@final
+class Configuration:
+
+    def __init__ (self):
+        configuration = c_void_p()
+        status = get_fxnc().FXNConfigurationCreate(byref(configuration))
+        if status == FXNStatus.OK:
+            self.__configuration = configuration
+        else:
+            raise RuntimeError(f"Failed to create configuration with error: {status_to_error(status)}")
+
+    @property
+    def tag (self) -> str:
+        buffer = create_string_buffer(2048)
+        status = get_fxnc().FXNConfigurationGetTag(self.__configuration, buffer, len(buffer))
+        if status != FXNStatus.OK:
+            raise RuntimeError(f"Failed to get configuration tag with error: {status_to_error(status)}")
+        tag = buffer.value.decode("utf-8")
+        return tag if tag else None
+
+    @tag.setter
+    def tag (self, tag: str):
+        tag = tag.encode() if tag is not None else None
+        status = get_fxnc().FXNConfigurationSetTag(self.__configuration, tag)
+        if status != FXNStatus.OK:
+            raise RuntimeError(f"Failed to set configuration tag with error: {status_to_error(status)}")
+
+    @property
+    def token (self) -> str:
+        buffer = create_string_buffer(2048)
+        status = get_fxnc().FXNConfigurationGetToken(self.__configuration, buffer, len(buffer))
+        if status != FXNStatus.OK:
+            raise RuntimeError(f"Failed to get configuration token with error: {status_to_error(status)}")
+        token = buffer.value.decode("utf-8")
+        return token if token else None
+
+    @token.setter
+    def token (self, token: str):
+        token = token.encode() if token is not None else None
+        status = get_fxnc().FXNConfigurationSetToken(self.__configuration, token)
+        if status != FXNStatus.OK:
+            raise RuntimeError(f"Failed to set configuration token with error: {status_to_error(status)}")            
+
+    @property
+    def acceleration (self) -> Acceleration:
+        acceleration = c_int()
+        status = get_fxnc().FXNConfigurationGetAcceleration(self.__configuration, byref(acceleration))
+        if status == FXNStatus.OK:
+            return Acceleration(acceleration.value)
+        else:
+            raise RuntimeError(f"Failed to get configuration acceleration with error: {status_to_error(status)}")
+
+    @acceleration.setter
+    def acceleration (self, acceleration: Acceleration):
+        status = get_fxnc().FXNConfigurationSetAcceleration(self.__configuration, acceleration.value)
+        if status != FXNStatus.OK:
+            raise RuntimeError(f"Failed to set configuration acceleration with error: {status_to_error(status)}")
+
+    @property
+    def device (self):
+        device = c_void_p()
+        status = get_fxnc().FXNConfigurationGetDevice(self.__configuration, byref(device))
+        if status == FXNStatus.OK:
+            return device if device.value else None
+        else:
+            raise RuntimeError(f"Failed to get configuration device with error: {status_to_error(status)}")
+
+    @device.setter
+    def device (self, device):
+        status = get_fxnc().FXNConfigurationSetDevice(self.__configuration, device)
+        if status != FXNStatus.OK:
+            raise RuntimeError(f"Failed to set configuration device with error: {status_to_error(status)}")
+
+    def add_resource (self, type: str, path: Path):
+        status = get_fxnc().FXNConfigurationAddResource(self.__configuration, type.encode(), str(path).encode())
+        if status != FXNStatus.OK:
+            raise RuntimeError(f"Failed to add configuration resource with error: {status_to_error(status)}")
+
+    def __enter__ (self):
+        return self
+    
+    def __exit__ (self, exc_type, exc_value, traceback):
+        self.__release()
+
+    def __release (self):
+        if self.__configuration:
+            get_fxnc().FXNConfigurationRelease(self.__configuration)
+        self.__configuration = None
+
+    @classmethod
+    def get_unique_id (cls) -> str:
+        buffer = create_string_buffer(2048)
+        status = get_fxnc().FXNConfigurationGetUniqueID(buffer, len(buffer))
+        if status == FXNStatus.OK:
+            return buffer.value.decode("utf-8")
+        else:
+            raise RuntimeError(f"Failed to retrieve configuration identifier with error: {status_to_error(status)}")
+
+    @classmethod
+    def get_client_id (cls) -> str:
+        buffer = create_string_buffer(64)
+        status = get_fxnc().FXNConfigurationGetClientID(buffer, len(buffer))
+        if status == FXNStatus.OK:
+            return buffer.value.decode("utf-8")
+        else:
+            raise RuntimeError(f"Failed to retrieve client identifier with error: {status_to_error(status)}")

fxn-0.0.41/fxn/c/fxnc.py

@@ -0,0 +1,48 @@
+#
+#   Function
+#   Copyright © 2024 NatML Inc. All Rights Reserved.
+#
+
+from ctypes import CDLL
+from enum import IntEnum
+from importlib import resources
+from platform import machine, system
+
+_fxnc: CDLL = None
+
+class FXNStatus(IntEnum):
+    OK = 0
+    ERROR_INVALID_ARGUMENT = 1
+    ERROR_INVALID_OPERATION = 2
+    ERROR_NOT_IMPLEMENTED = 3
+
+def get_fxnc () -> CDLL:
+    global _fxnc
+    _fxnc = _fxnc if _fxnc is not None else _load_fxnc()
+    return _fxnc
+
+def set_fxnc (fxnc: CDLL):
+    global _fxnc
+    _fxnc = fxnc
+
+def _load_fxnc () -> CDLL:
+    os = system().lower()
+    os = "macos" if os == "darwin" else os
+    arch = machine().lower()
+    arch = "arm64" if arch == "aarch64" else arch
+    arch = "x86_64" if arch in ["x64", "amd64"] else arch
+    package = f"fxn.lib.{os}.{arch}"
+    resource = "libFunction.so"
+    resource = "Function.dylib" if os == "macos" else resource
+    resource = "Function.dll" if os == "windows" else resource
+    with resources.path(package, resource) as path:
+        return CDLL(str(path))
+    
+def status_to_error (status: int) -> str:
+    if status == FXNStatus.ERROR_INVALID_ARGUMENT:
+        return "FXN_ERROR_INVALID_ARGUMENT"
+    elif status == FXNStatus.ERROR_INVALID_OPERATION:
+        return "FXN_ERROR_INVALID_OPERATION"
+    elif status == FXNStatus.ERROR_NOT_IMPLEMENTED:
+        return "FXN_ERROR_NOT_IMPLEMENTED"
+    return ""

fxn-0.0.41/fxn/c/map.py

@@ -0,0 +1,64 @@
+#
+#   Function
+#   Copyright © 2024 NatML Inc. All Rights Reserved.
+#
+
+from ctypes import byref, c_int, c_int32, c_void_p, create_string_buffer
+from pathlib import Path
+from typing import final
+
+from .fxnc import get_fxnc, status_to_error, FXNStatus
+from .value import Value
+
+@final
+class ValueMap:
+
+    def __init__ (self, map=None, *, owner: bool=True):
+        if map is None:
+            map = c_void_p()
+            owner = True
+            status = get_fxnc().FXNValueMapCreate(byref(map))
+            if status != FXNStatus.OK:
+                raise RuntimeError(f"Failed to create value map with error: {status_to_error(status)}")
+        self.__map = map
+        self.__owner = owner
+
+    def key (self, index: int) -> str:
+        buffer = create_string_buffer(256)
+        status = get_fxnc().FXNValueMapGetKey(self.__map, index, buffer, len(buffer))
+        if status == FXNStatus.OK:
+            return buffer.value.decode("utf-8")
+        else:
+            raise RuntimeError(f"Failed to get value map key at index {index} with error: {status_to_error(status)}")
+
+    def __getitem__ (self, key: str) -> Value | None:
+        value = c_void_p()
+        status = get_fxnc().FXNValueMapGetValue(self.__map, key.encode(), byref(value))
+        if status == FXNStatus.OK:
+            return Value(value, owner=False)
+        else:
+            raise RuntimeError(f"Failed to get value map value for key '{key}' with error: {status_to_error(status)}")
+
+    def __setitem__ (self, key: str, value: Value):
+        status = get_fxnc().FXNValueMapSetValue(self.__map, key.encode(), value._Value__value)
+        if status != FXNStatus.OK:
+            raise RuntimeError(f"Failed to set value map value for key '{key}' with error: {status_to_error(status)}")
+
+    def __len__ (self) -> int:
+        count = c_int32()
+        status = get_fxnc().FXNValueMapGetSize(self.__map, byref(count))
+        if status == FXNStatus.OK:
+            return count.value
+        else:
+            raise RuntimeError(f"Failed to get value map size with error: {status_to_error(status)}")
+
+    def __enter__ (self):
+        return self
+
+    def __exit__ (self, exc_type, exc_value, traceback):
+        self.__release()
+
+    def __release (self):
+        if self.__map and self.__owner:
+            get_fxnc().FXNValueMapRelease(self.__map)
+        self.__map = None

fxn-0.0.41/fxn/c/prediction.py

@@ -0,0 +1,76 @@
+#
+#   Function
+#   Copyright © 2024 NatML Inc. All Rights Reserved.
+#
+
+from ctypes import byref, c_double, c_int, c_int32, c_void_p, create_string_buffer
+from pathlib import Path
+from typing import final
+
+from .fxnc import get_fxnc, status_to_error, FXNStatus
+from .map import ValueMap
+
+@final
+class Prediction:
+
+    def __init__ (self, prediction):
+        self.__prediction = prediction
+
+    @property
+    def id (self) -> str:
+        id = create_string_buffer(256)
+        status = get_fxnc().FXNPredictionGetID(self.__prediction, id, len(id))
+        if status == FXNStatus.OK:
+            return id.value.decode("utf-8")
+        else:
+            raise RuntimeError(f"Failed to get prediction id with error: {status_to_error(status)}")
+    
+    @property
+    def latency (self) -> float:
+        latency = c_double()
+        status = get_fxnc().FXNPredictionGetLatency(self.__prediction, byref(latency))
+        if status == FXNStatus.OK:
+            return latency.value
+        else:
+            raise RuntimeError(f"Failed to get prediction latency with error: {status_to_error(status)}")
+
+    @property
+    def results (self) -> ValueMap | None:
+        map = c_void_p()
+        status = get_fxnc().FXNPredictionGetResults(self.__prediction, byref(map))
+        if status != FXNStatus.OK:
+            raise RuntimeError(f"Failed to get prediction results with error: {status_to_error(status)}")
+        map = ValueMap(map, owner=False)
+        return map if len(map) > 0 else None
+
+    @property
+    def error (self) -> str | None:
+        error = create_string_buffer(2048)
+        get_fxnc().FXNPredictionGetError(self.__prediction, error, len(error))
+        error = error.value.decode("utf-8")
+        return error if error else None
+
+    @property
+    def logs (self) -> str:
+        fxnc = get_fxnc()
+        log_length = c_int32()
+        status = fxnc.FXNPredictionGetLogLength(self.__prediction, byref(log_length))
+        if status != FXNStatus.OK:
+            raise RuntimeError(f"Failed to get prediction log length with error: {status_to_error(status)}")
+        logs = create_string_buffer(log_length.value + 1)
+        status = fxnc.FXNPredictionGetLogs(self.__prediction, logs, len(logs))
+        if status == FXNStatus.OK:
+            return logs.value.decode("utf-8")
+        else:
+            raise RuntimeError(f"Failed to get prediction logs with error: {status_to_error(status)}")
+
+    def __enter__ (self):
+        return self
+
+    def __exit__ (self, exc_type, exc_value, traceback):
+        self.__release()
+
+    def __release (self):
+        if self.__prediction:
+            get_fxnc().FXNPredictionRelease(self.__prediction)
+        self.__prediction = None

fxn-0.0.41/fxn/c/predictor.py

@@ -0,0 +1,60 @@
+#
+#   Function
+#   Copyright © 2024 NatML Inc. All Rights Reserved.
+#
+
+from ctypes import byref, c_int, c_int32, c_void_p, create_string_buffer
+from pathlib import Path
+from typing import final
+
+from .configuration import Configuration
+from .fxnc import get_fxnc, status_to_error, FXNStatus
+from .map import ValueMap
+from .prediction import Prediction
+from .stream import PredictionStream
+
+@final
+class Predictor:
+
+    def __init__ (self, configuration: Configuration):
+        predictor = c_void_p()
+        status = get_fxnc().FXNPredictorCreate(configuration._Configuration__configuration, byref(predictor))
+        if status == FXNStatus.OK:
+            self.__predictor = predictor
+        else:
+            raise RuntimeError(f"Failed to create predictor with error: {status_to_error(status)}")
+
+    def create_prediction (self, inputs: ValueMap) -> Prediction:
+        prediction = c_void_p()
+        status = get_fxnc().FXNPredictorCreatePrediction(
+            self.__predictor,
+            inputs._ValueMap__map,
+            byref(prediction)
+        )
+        if status == FXNStatus.OK:
+            return Prediction(prediction)
+        else:
+            raise RuntimeError(f"Failed to create prediction with error: {status_to_error(status)}")
+
+    def stream_prediction (self, inputs: ValueMap) -> PredictionStream:
+        stream = c_void_p()
+        status = get_fxnc().FXNPredictorStreamPrediction(
+            self.__predictor,
+            inputs._ValueMap__map,
+            byref(stream)
+        )
+        if status == FXNStatus.OK:
+            return PredictionStream(stream)
+        else:
+            raise RuntimeError(f"Failed to stream prediction with error: {status_to_error(status)}")
+
+    def __enter__ (self):
+        return self
+
+    def __exit__ (self, exc_type, exc_value, traceback):
+        self.__release()
+
+    def __release (self):
+        if self.__predictor:
+            get_fxnc().FXNPredictorRelease(self.__predictor)
+        self.__predictor = None

fxn-0.0.41/fxn/c/stream.py

@@ -0,0 +1,41 @@
+#
+#   Function
+#   Copyright © 2024 NatML Inc. All Rights Reserved.
+#
+
+from ctypes import byref, c_int, c_int32, c_void_p, create_string_buffer
+from pathlib import Path
+from typing import final
+
+from .fxnc import get_fxnc, status_to_error, FXNStatus
+from .prediction import Prediction
+
+@final
+class PredictionStream:
+
+    def __init__ (self, stream):
+        self.__stream = stream
+
+    def __iter__ (self):
+        return self
+    
+    def __next__ (self) -> Prediction:
+        prediction = c_void_p()
+        status = get_fxnc().FXNPredictionStreamReadNext(self.__stream, byref(prediction))
+        if status == FXNStatus.ERROR_INVALID_OPERATION:
+            raise StopIteration()
+        elif status != FXNStatus.OK:
+            raise RuntimeError(f"Failed to read next prediction in stream with error: {status_to_error(status)}")
+        else:
+            return Prediction(prediction)
+
+    def __enter__ (self):
+        return self
+
+    def __exit__ (self, exc_type, exc_value, traceback):
+        self.__release()
+
+    def __release (self):
+        if self.__stream:
+            get_fxnc().FXNPredictionStreamRelease(self.__stream)
+        self.__stream = None