fxn 0.0.37__tar.gz → 0.0.39__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fxn
-Version: 0.0.37
+Version: 0.0.39
 Summary: Run prediction functions locally in Python. Register at https://fxn.ai.
 Author-email: "NatML Inc." <hi@fxn.ai>
 License:                                  Apache License
@@ -239,20 +239,24 @@ $ pip install --upgrade fxn
 ```
 
 > [!NOTE]
-> Function requires Python 3.9+
+> Function requires Python 3.10+
 
 ## Retrieving your Access Key
-Head over to [fxn.ai](https://fxn.ai) to create an account by logging in. Once you do, generate an access key:
+Head over to [fxn.ai](https://www.fxn.ai/account/developer) to create an account by logging in. Once you do, generate an access key:
 
 ![generate access key](https://raw.githubusercontent.com/fxnai/.github/main/access_key.gif)
 
 ## Making a Prediction
-Let's run the [`@fxn/greeting`](https://fxn.ai/@fxn/greeting) predictor which accepts a `name` and returns a congenial greeting. Run the following Python script:
+First, create a Function client, specifying your access key:
 ```py
 from fxn import Function
 
 # Create the Function client
 fxn = Function(access_key="<Function access key>")
+```
+
+Then make a prediction:
+```py
 # Create a prediction
 prediction = fxn.predictions.create(
     tag="@fxn/greeting",
@@ -264,16 +268,18 @@ print(prediction.results[0])
 
 > [!TIP]
 > Explore public predictors [on Function](https://fxn.ai/explore) or [create your own](https://fxn.ai/waitlist).
-r
-## Using the Function CLI
-Open up a terminal and run the following command:
 
+## Using the Function CLI
+Open up a terminal and login to the Function CLI:
 ```sh
 # Login to Function
-fxn auth login <ACCESS KEY>
+$ fxn auth login <ACCESS KEY>
+```
 
+Then make a prediction:
+```sh
 # Make a prediction using the Function CLI
-fxn predict @fxn/greeting --name Peter
+$ fxn predict @fxn/greeting --name Peter
 ```
 
 ___

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

@@ -14,20 +14,24 @@ $ pip install --upgrade fxn
 ```
 
 > [!NOTE]
-> Function requires Python 3.9+
+> Function requires Python 3.10+
 
 ## Retrieving your Access Key
-Head over to [fxn.ai](https://fxn.ai) to create an account by logging in. Once you do, generate an access key:
+Head over to [fxn.ai](https://www.fxn.ai/account/developer) to create an account by logging in. Once you do, generate an access key:
 
 ![generate access key](https://raw.githubusercontent.com/fxnai/.github/main/access_key.gif)
 
 ## Making a Prediction
-Let's run the [`@fxn/greeting`](https://fxn.ai/@fxn/greeting) predictor which accepts a `name` and returns a congenial greeting. Run the following Python script:
+First, create a Function client, specifying your access key:
 ```py
 from fxn import Function
 
 # Create the Function client
 fxn = Function(access_key="<Function access key>")
+```
+
+Then make a prediction:
+```py
 # Create a prediction
 prediction = fxn.predictions.create(
     tag="@fxn/greeting",
@@ -39,16 +43,18 @@ print(prediction.results[0])
 
 > [!TIP]
 > Explore public predictors [on Function](https://fxn.ai/explore) or [create your own](https://fxn.ai/waitlist).
-r
-## Using the Function CLI
-Open up a terminal and run the following command:
 
+## Using the Function CLI
+Open up a terminal and login to the Function CLI:
 ```sh
 # Login to Function
-fxn auth login <ACCESS KEY>
+$ fxn auth login <ACCESS KEY>
+```
 
+Then make a prediction:
+```sh
 # Make a prediction using the Function CLI
-fxn predict @fxn/greeting --name Peter
+$ fxn predict @fxn/greeting --name Peter
 ```
 
 ___

{fxn-0.0.37 → fxn-0.0.39}/fxn/__init__.py

@@ -5,4 +5,4 @@
 
 from .function import Function
 from .types import *
-from .version import __version__
+from .version import *

{fxn-0.0.37 → fxn-0.0.39}/fxn/services/prediction.py

@@ -17,6 +17,7 @@ from PIL import Image
 from platform import machine, system
 from pydantic import BaseModel
 from requests import get, post
+from tempfile import gettempdir
 from typing import Any, AsyncIterator, Dict, List, Optional, Union
 from urllib.parse import urlparse
 
@@ -30,12 +31,14 @@ class PredictionService:
         self.client = client
         self.__fxnc = PredictionService.__load_fxnc()
         self.__cache = { }
+        self.__cache_dir = self.__class__.__get_resource_dir() / ".fxn" / "cache"
+        self.__cache_dir.mkdir(exist_ok=True)
 
     def create (
         self,
         tag: str,
         *,
-        inputs: Optional[Dict[str, Union[ndarray, str, float, int, bool, List, Dict[str, Any], Path, Image.Image]]] = None,
+        inputs: Optional[Dict[str, ndarray | str | float | int | bool | List[Any] | Dict[str, Any] | Path | Image.Image]] = None,
         acceleration: Acceleration=Acceleration.Default,
         client_id: str=None,
         configuration_id: str=None
@@ -58,7 +61,7 @@ class PredictionService:
             return self.__predict(tag=tag, predictor=self.__cache[tag], inputs=inputs)
         # Query
         response = post(
-            f"{self.client.api_url}/predict/{tag}?rawOutputs=true",
+            f"{self.client.api_url}/predict/{tag}",
             json={ },
             headers={
                 "Authorization": f"Bearer {self.client.access_key}",
@@ -88,7 +91,7 @@ class PredictionService:
         self,
         tag: str,
         *,
-        inputs: Dict[str, Union[float, int, str, bool, NDArray, List[Any], Dict[str, Any], Path, Image.Image]] = {},
+        inputs: Dict[str, float | int | str | bool | NDArray | List[Any] | Dict[str, Any] | Path | Image.Image] = {},
         acceleration: Acceleration=Acceleration.Default,
         client_id: str=None,
         configuration_id: str=None
@@ -124,35 +127,22 @@ class PredictionService:
         prediction = self.__predict(tag=tag, predictor=predictor, inputs=inputs)
         # Yield
         yield prediction
-    
+
     @classmethod
-    def __load_fxnc (self) -> Optional[CDLL]:
-        # Get resource
-        package, resource = None, None
-        os = system()
-        if os == "Darwin":
-            package = f"fxn.lib.macos.{machine()}"
-            resource = f"Function.dylib"
-        elif os == "Linux" and False: # INCOMPLETE # Linux
-            package = f"fxn.lib.linux.{machine()}"
-            resource = f"libFunction.so"
-        elif os == "Windows":
-            package = f"fxn.lib.windows.{machine()}"
-            resource = f"Function.dll"
-        else:
-            return None
-        # Load
+    def __load_fxnc (cls) -> Optional[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 fxnc_path:
             return load_fxnc(fxnc_path)
 
     def __get_client_id (self) -> str:
-        # Fallback if fxnc failed to load
-        if not self.__fxnc:
-            return {
-                "Darwin":  f"macos-{machine()}",
-                "Linux": f"linux-{machine()}",
-                "Windows": f"windows-{machine()}"
-            }[system()]
         # Get
         buffer = create_string_buffer(64)
         status = self.__fxnc.FXNConfigurationGetClientID(buffer, len(buffer))
@@ -285,7 +275,7 @@ class PredictionService:
     
     def __to_value (
         self,
-        value: Union[float, int, bool, str, NDArray, List[Any], Dict[str, Any], Image.Image, bytes, bytearray, memoryview, BytesIO, None]
+        value: float | int | bool | str | NDArray | List[Any] | Dict[str, Any] | Image.Image | bytes | bytearray | memoryview | BytesIO | None
     ) -> type[FXNValueRef]:
         value = PredictionService.__try_ensure_serializable(value)
         fxnc = self.__fxnc
@@ -343,7 +333,7 @@ class PredictionService:
     def __to_object (
         self,
         value: type[FXNValueRef]
-    ) -> Union[float, int, bool, str, NDArray, List[Any], Dict[str, Any], Image.Image, BytesIO, None]:
+    ) -> float | int | bool | str | NDArray | List[Any] | Dict[str, Any] | Image.Image | BytesIO | None:
         # Type
         fxnc = self.__fxnc
         dtype = FXNDtype()
@@ -383,10 +373,8 @@ class PredictionService:
             raise RuntimeError(f"Failed to convert Function value to Python value because Function value has unsupported type: {dtype}")
 
     def __get_resource_path (self, resource: PredictionResource) -> Path:
-        cache_dir = Path.home() / ".fxn" / "cache"
-        cache_dir.mkdir(exist_ok=True)
         res_name = Path(urlparse(resource.url).path).name
-        res_path = cache_dir / res_name
+        res_path = self.__cache_dir / res_name
         if res_path.exists():
             return res_path
         req = get(resource.url)
@@ -394,7 +382,18 @@ class PredictionService:
         with open(res_path, "wb") as f:
             f.write(req.content)
         return res_path
-    
+
+    @classmethod
+    def __get_resource_dir (cls) -> Path:
+        try:
+            check = Path.home() / ".fxntest"
+            with open(check, "w") as f:
+                f.write("fxn")
+            check.unlink()
+            return Path.home()
+        except:
+            return Path(gettempdir())
+
     @classmethod
     def __try_ensure_serializable (cls, object: Any) -> Any:
         if object is None:
@@ -427,11 +426,6 @@ resources {{
     url
     name
 }}
-results {{
-    data
-    type
-    shape
-}}
 latency
 error
 logs

{fxn-0.0.37 → fxn-0.0.39}/fxn/services/predictor.py

@@ -83,7 +83,7 @@ class PredictorService:
         predictors = [Predictor(**predictor) for predictor in predictors]
         # Return
         return predictors
-    
+
     def search (
         self,
         query: str,

{fxn-0.0.37 → fxn-0.0.39}/fxn/types/__init__.py

@@ -4,9 +4,6 @@
 #
 
 from .dtype import Dtype
-from .environment import EnvironmentVariable
 from .prediction import Prediction, PredictionResource
 from .predictor import Acceleration, AccessMode, EnumerationMember, Parameter, Predictor, PredictorStatus, Signature
-from .profile import Profile
-from .storage import UploadType
-from .user import User
+from .user import Profile, User

{fxn-0.0.37 → fxn-0.0.39}/fxn/types/predictor.py

@@ -11,16 +11,16 @@ from pydantic import AliasChoices, BaseModel, ConfigDict, Field
 from typing import Any, Dict, List, Optional, Tuple
 
 from .dtype import Dtype
-from .profile import Profile
+from .user import Profile
 
 class Acceleration (IntFlag):
     """
     Predictor acceleration.
     """
     Default = 0,
-    CPU = 1 << 0,
-    GPU = 1 << 1,
-    NPU = 1 << 2
+    CPU     = 1 << 0,
+    GPU     = 1 << 1,
+    NPU     = 1 << 2
 
 class AccessMode (str, Enum):
     """

fxn-0.0.37/fxn/types/profile.py → fxn-0.0.39/fxn/types/user.py

@@ -27,4 +27,9 @@ class Profile (BaseModel):
     avatar: Optional[str] = Field(default=None, description="User avatar URL.")
     bio: Optional[str] = Field(default=None, description="User bio.")
     website: Optional[str] = Field(default=None, description="User website.")
-    github: Optional[str] = Field(default=None, description="User GitHub handle.")
+    github: Optional[str] = Field(default=None, description="User GitHub handle.")
+
+class User (Profile):
+    """
+    User.
+    """

{fxn-0.0.37 → fxn-0.0.39}/fxn/version.py

@@ -3,4 +3,4 @@
 #   Copyright © 2024 NatML Inc. All Rights Reserved.
 #
 
-__version__ = "0.0.37"
+__version__ = "0.0.39"

{fxn-0.0.37 → fxn-0.0.39}/fxn.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fxn
-Version: 0.0.37
+Version: 0.0.39
 Summary: Run prediction functions locally in Python. Register at https://fxn.ai.
 Author-email: "NatML Inc." <hi@fxn.ai>
 License:                                  Apache License
@@ -239,20 +239,24 @@ $ pip install --upgrade fxn
 ```
 
 > [!NOTE]
-> Function requires Python 3.9+
+> Function requires Python 3.10+
 
 ## Retrieving your Access Key
-Head over to [fxn.ai](https://fxn.ai) to create an account by logging in. Once you do, generate an access key:
+Head over to [fxn.ai](https://www.fxn.ai/account/developer) to create an account by logging in. Once you do, generate an access key:
 
 ![generate access key](https://raw.githubusercontent.com/fxnai/.github/main/access_key.gif)
 
 ## Making a Prediction
-Let's run the [`@fxn/greeting`](https://fxn.ai/@fxn/greeting) predictor which accepts a `name` and returns a congenial greeting. Run the following Python script:
+First, create a Function client, specifying your access key:
 ```py
 from fxn import Function
 
 # Create the Function client
 fxn = Function(access_key="<Function access key>")
+```
+
+Then make a prediction:
+```py
 # Create a prediction
 prediction = fxn.predictions.create(
     tag="@fxn/greeting",
@@ -264,16 +268,18 @@ print(prediction.results[0])
 
 > [!TIP]
 > Explore public predictors [on Function](https://fxn.ai/explore) or [create your own](https://fxn.ai/waitlist).
-r
-## Using the Function CLI
-Open up a terminal and run the following command:
 
+## Using the Function CLI
+Open up a terminal and login to the Function CLI:
 ```sh
 # Login to Function
-fxn auth login <ACCESS KEY>
+$ fxn auth login <ACCESS KEY>
+```
 
+Then make a prediction:
+```sh
 # Make a prediction using the Function CLI
-fxn predict @fxn/greeting --name Peter
+$ fxn predict @fxn/greeting --name Peter
 ```
 
 ___

{fxn-0.0.37 → fxn-0.0.39}/fxn.egg-info/SOURCES.txt

@@ -30,6 +30,8 @@ fxn/cli/misc.py
 fxn/cli/predict.py
 fxn/cli/predictors.py
 fxn/lib/__init__.py
+fxn/lib/linux/arm64/libFunction.so
+fxn/lib/linux/x86_64/libFunction.so
 fxn/lib/macos/arm64/Function.dylib
 fxn/lib/macos/x86_64/Function.dylib
 fxn/lib/windows/arm64/Function.dll
@@ -40,10 +42,6 @@ fxn/services/predictor.py
 fxn/services/user.py
 fxn/types/__init__.py
 fxn/types/dtype.py
-fxn/types/environment.py
 fxn/types/prediction.py
 fxn/types/predictor.py
-fxn/types/profile.py
-fxn/types/storage.py
-fxn/types/tag.py
 fxn/types/user.py

fxn-0.0.37/fxn/types/environment.py

@@ -1,17 +0,0 @@
-# 
-#   Function
-#   Copyright © 2024 NatML Inc. All Rights Reserved.
-#
-
-from pydantic import BaseModel, Field
-
-class EnvironmentVariable (BaseModel):
-    """
-    Predictor environment variable.
-
-    Members:
-        name (str): Variable name.
-        value (str): Variable value.
-    """
-    name: str = Field(description="Variable name.")
-    value: str = Field(description="Variable value.")

fxn-0.0.37/fxn/types/storage.py

@@ -1,14 +0,0 @@
-# 
-#   Function
-#   Copyright © 2024 NatML Inc. All Rights Reserved.
-#
-
-from enum import Enum
-
-class UploadType (str, Enum):
-    """
-    Upload URL type.
-    """
-    Media = "MEDIA"
-    Notebook = "NOTEBOOK"
-    Value = "VALUE"

fxn-0.0.37/fxn/types/tag.py

@@ -1,28 +0,0 @@
-#
-#   Function
-#   Copyright © 2024 NatML Inc. All Rights Reserved.
-#
-
-from __future__ import annotations
-from pydantic import BaseModel, Field
-
-class Tag (BaseModel):
-    """
-    Predictor tag.
-
-    Members:
-        username (str): Predictor owner username.
-        name (str): Predictor name.
-    """
-    username: str = Field(description="Predictor owner username.")
-    name: str = Field(description="Predictor name.")
-
-    def from_str (cls, tag: str) -> Tag:
-        """
-        Parse a predictor tag from a string.
-        """
-        username, name = tag.lower()[1:].split("/")
-        return Tag(username=username, name=name)
-
-    def __str__ (self):
-        return f"@{self.username}/{self.name}"

fxn-0.0.37/fxn/types/user.py

@@ -1,11 +0,0 @@
-# 
-#   Function
-#   Copyright © 2024 NatML Inc. All Rights Reserved.
-#
-
-from .profile import Profile
-
-class User (Profile):
-    """
-    User.
-    """