fxn 0.0.44__py3-none-any.whl → 0.0.46__py3-none-any.whl

fxn/__init__.py

@@ -4,8 +4,8 @@
 #
 
 from .client import FunctionAPIError
-from .compile import compile, CompileTarget
+from .compile import compile, CompileMetadata, CompileTarget
 from .function import Function
 from .sandbox import Sandbox
 from .types import *
-from .version import *
+from .version import __version__

fxn/beta/__init__.py

@@ -3,4 +3,8 @@
 #   Copyright © 2025 NatML Inc. All Rights Reserved.
 #
 
+from .metadata import (
+    CoreMLInferenceMetadata, GGUFInferenceMetadata,
+    ONNXInferenceMetadata, ONNXRuntimeInferenceSessionMetadata
+)
 from .remote import RemoteAcceleration

fxn/beta/metadata.py

@@ -0,0 +1,61 @@
+# 
+#   Function
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
+#
+
+from pathlib import Path
+from pydantic import BaseModel, BeforeValidator, ConfigDict, Field
+from typing import Annotated, Literal
+
+def _validate_torch_module (module: "torch.nn.Module") -> "torch.nn.Module": # type: ignore
+    try:
+        from torch.nn import Module # type: ignore
+        if not isinstance(module, Module):
+            raise ValueError(f"Expected torch.nn.Module, got {type(module)}")
+        return module
+    except ImportError:
+        raise ImportError("PyTorch is required to create this metadata but is not installed.")
+
+def _validate_ort_inference_session (session: "onnxruntime.InferenceSession") -> "onnxruntime.InferenceSession": # type: ignore
+    try:
+        from onnxruntime import InferenceSession # type: ignore
+        if not isinstance(session, InferenceSession):
+            raise ValueError(f"Expected onnxruntime.InferenceSession, got {type(session)}")
+        return session
+    except ImportError:
+        raise ImportError("ONNXRuntime is required to create this metadata but is not installed.")
+
+class CoreMLInferenceMetadata (BaseModel):
+    """
+    Metadata required to lower PyTorch models for inference on iOS, macOS, and visionOS with CoreML.
+    """
+    kind: Literal["meta.inference.coreml"] = "meta.inference.coreml"
+    model: Annotated[object, BeforeValidator(_validate_torch_module)] = Field(description="PyTorch module to apply metadata to.")
+    model_args: list[object] = Field(description="Positional inputs to the model.")
+    model_config = ConfigDict(arbitrary_types_allowed=True, frozen=True)
+
+class ONNXInferenceMetadata (BaseModel):
+    """
+    Metadata required to lower PyTorch models for inference.
+    """
+    kind: Literal["meta.inference.onnx"] = "meta.inference.onnx"
+    model: Annotated[object, BeforeValidator(_validate_torch_module)] = Field(description="PyTorch module to apply metadata to.")
+    model_args: list[object] = Field(description="Positional inputs to the model.")
+    model_config = ConfigDict(arbitrary_types_allowed=True, frozen=True)
+
+class ONNXRuntimeInferenceSessionMetadata (BaseModel):
+    """
+    Metadata required to lower ONNXRuntime inference sessions for inference.
+    """
+    kind: Literal["meta.inference.onnxruntime"] = "meta.inference.onnxruntime"
+    session: Annotated[object, BeforeValidator(_validate_ort_inference_session)] = Field(description="ONNXRuntime inference session to apply metadata to.")
+    model_path: Path = Field(description="ONNX model path. The model must exist at this path in the compiler sandbox.")
+    model_config = ConfigDict(arbitrary_types_allowed=True, frozen=True)
+
+class GGUFInferenceMetadata (BaseModel): # INCOMPLETE
+    """
+    Metadata required to lower GGUF models for LLM inference.
+    """
+    kind: Literal["meta.inference.gguf"] = "meta.inference.gguf"
+    model_path: Path = Field(description="GGUF model path. The model must exist at this path in the compiler sandbox.")
+    model_config = ConfigDict(arbitrary_types_allowed=True, frozen=True)

fxn/cli/__init__.py

@@ -5,13 +5,15 @@
 
 import typer
 
+from ..logging import TracebackMarkupConsole
+from ..version import __version__
+
 from .auth import app as auth_app
 from .compile import compile_predictor
 from .misc import cli_options
 from .predictions import create_prediction
 from .predictors import archive_predictor, delete_predictor, retrieve_predictor
-from ..logging import TracebackMarkupConsole
-from ..version import __version__
+from .sources import retrieve_source
 
 # Define CLI
 typer.main.console_stderr = TracebackMarkupConsole()
@@ -42,6 +44,7 @@ app.command(
 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)
+app.command(name="source", help="Retrieve the native source code for a given prediction.")(retrieve_source)
 
 # Run
 if __name__ == "__main__":

fxn/cli/compile.py

@@ -9,12 +9,12 @@ from inspect import getmembers, getmodulename, isfunction
 from pathlib import Path
 from pydantic import BaseModel
 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 ..client import FunctionAPIError
 from ..compile import PredictorSpec
 from ..function import Function
 from ..sandbox import EntrypointCommand
@@ -25,11 +25,16 @@ class CompileError (Exception):
     pass
 
 def compile_predictor (
-    path: str=Argument(..., help="Predictor path.")
+    path: str=Argument(..., help="Predictor path."),
+    overwrite: bool=Option(False, "--overwrite", help="Whether to delete any existing predictor with the same tag before compiling."),
 ):
-    run_async(_compile_predictor_async(path))
+    run_async(_compile_predictor_async(path, overwrite=overwrite))
 
-async def _compile_predictor_async (path: str):
+async def _compile_predictor_async (
+    path: str,
+    *,
+    overwrite: bool
+):
     fxn = Function(get_access_key())
     path: Path = Path(path).resolve()
     with CustomProgress():
@@ -47,6 +52,15 @@ async def _compile_predictor_async (path: str):
         # Compile
         with CustomProgressTask(loading_text="Running codegen...", done_text="Completed codegen"):
             with CustomProgressTask(loading_text="Creating predictor..."):
+                if overwrite:
+                    try:
+                        fxn.client.request(
+                            method="DELETE",
+                            path=f"/predictors/{spec.tag}"
+                        )
+                    except FunctionAPIError as error:
+                        if error.status_code != 404:
+                            raise
                 predictor = fxn.client.request(
                     method="POST",
                     path="/predictors",

fxn/cli/sources.py

@@ -0,0 +1,46 @@
+# 
+#   Function
+#   Copyright © 2025 NatML Inc. All Rights Reserved.
+#
+
+from datetime import datetime
+from pathlib import Path
+from pydantic import BaseModel
+from rich import print_json
+from typer import Argument, Option
+from typing_extensions import Annotated
+
+from ..function import Function
+from ..logging import CustomProgress, CustomProgressTask
+from .auth import get_access_key
+
+def retrieve_source (
+    predictor: Annotated[str, Option(help="Predictor tag.")] = None,
+    prediction: Annotated[str, Option(help="Prediction identifier. If specified, this MUST be from a prediction returned by the Function API.")] = None,
+    output: Annotated[Path, Option(help="Path to output source file.")] = Path("predictor.cpp")
+):
+    if not ((predictor is not None) ^ (prediction is not None)):
+        raise ValueError(f"Predictor tag or prediction identifier must be provided, but not both.")
+    fxn = Function(get_access_key())
+    with CustomProgress(transient=True):
+        if prediction is None:
+            with CustomProgressTask(loading_text="Creating prediction..."):
+                empty_prediction = fxn.predictions.create(tag=predictor)
+                prediction = empty_prediction.id
+        with CustomProgressTask(loading_text="Retrieving source..."):
+            source = fxn.client.request(
+                method="GET",
+                path=f"/predictions/{prediction}/source",
+                response_type=_PredictionSource
+            )
+            output.write_text(source.code)
+            source.code = str(output.resolve())
+            print_json(data=source.model_dump(mode="json", by_alias=True))
+
+class _PredictionSource (BaseModel):
+    tag: str
+    target: str
+    code: str
+    created: datetime
+    compiled: datetime
+    latency: float # millis

fxn/compile.py

@@ -11,11 +11,22 @@ from pydantic import BaseModel, ConfigDict, Field
 from types import ModuleType
 from typing import Literal
 
+from .beta import (
+    CoreMLInferenceMetadata, GGUFInferenceMetadata,
+    ONNXInferenceMetadata, ONNXRuntimeInferenceSessionMetadata
+)
 from .sandbox import Sandbox
 from .types import AccessMode
 
 CompileTarget = Literal["android", "ios", "linux", "macos", "visionos", "wasm", "windows"]
 
+CompileMetadata = (
+    CoreMLInferenceMetadata             |
+    GGUFInferenceMetadata               |
+    ONNXInferenceMetadata               |
+    ONNXRuntimeInferenceSessionMetadata
+)
+
 class PredictorSpec (BaseModel):
     """
     Descriptor of a predictor to be compiled.
@@ -23,7 +34,6 @@ class PredictorSpec (BaseModel):
     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.")
-    trace_modules: list[ModuleType] = Field(description="Modules to trace and compile.", exclude=True)
     targets: list[str] | None = Field(description="Targets to compile this predictor for. Pass `None` to compile for our default targets.")
     access: AccessMode = Field(description="Predictor access.")
     card: str | None = Field(default=None, description="Predictor card (markdown).")
@@ -39,6 +49,7 @@ def compile (
     trace_modules: list[ModuleType]=[],
     targets: list[CompileTarget]=None,
     access: AccessMode=AccessMode.Private,
+    metadata: list[CompileMetadata]=[],
     card: str | Path=None,
     media: Path=None,
     license: str=None,
@@ -54,6 +65,7 @@ def compile (
         trace_modules (list): Modules to trace and compile.
         targets (list): Targets to compile this predictor for. Pass `None` to compile for our default targets.
         access (AccessMode): Predictor access.
+        metadata (list): Metadata to use while compiling the function.
         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.
@@ -69,12 +81,13 @@ def compile (
             tag=tag,
             description=description,
             sandbox=sandbox if sandbox is not None else Sandbox(),
-            trace_modules=trace_modules,
             targets=targets,
             access=access,
             card=card.read_text() if isinstance(card, Path) else card,
             media=None, # INCOMPLETE
             license=license,
+            trace_modules=trace_modules,
+            metadata=metadata,
             **kwargs
         )
         # Wrap

fxn/version.py

@@ -3,4 +3,4 @@
 #   Copyright © 2025 NatML Inc. All Rights Reserved.
 #
 
-__version__ = "0.0.44"
+__version__ = "0.0.46"

{fxn-0.0.44.dist-info → fxn-0.0.46.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fxn
-Version: 0.0.44
+Version: 0.0.46
 Summary: Run prediction functions locally in Python. Register at https://fxn.ai.
 Author-email: "NatML Inc." <hi@fxn.ai>
 License:                                  Apache License
@@ -224,7 +224,7 @@ Requires-Dist: rich
 Requires-Dist: typer
 Dynamic: license-file
 
-# Function for Python and CLI
+# Function for Python
 
 ![function logo](https://raw.githubusercontent.com/fxnai/.github/main/logo_wide.png)
 

{fxn-0.0.44.dist-info → fxn-0.0.46.dist-info}/RECORD

@@ -1,12 +1,13 @@
-fxn/__init__.py,sha256=eOYYoHwwQWzYVnyBO1VtcWR0JnUm1GPl4kr8IzhnCqg,257
+fxn/__init__.py,sha256=gnJK7iOmMVWFhluW9bOvTNxJbpT-GwzDJTMmjA_XxOE,284
 fxn/client.py,sha256=Deje8eiS1VOHX85tQnV34viv2CPVx2ljwHSbyVB5Z1o,3790
-fxn/compile.py,sha256=XO_0a0hEfM3SI03cb8EFs2xL6E6XpmrVtRPo2icR6J0,3529
+fxn/compile.py,sha256=A9dxw6yv1eCd-zEYnqiyjDUZou8TkbEIA_yB9Tn4pXo,3894
 fxn/function.py,sha256=XeEuALkbVhkvwEBUfP0A2fu3tdimwHemoR17oomhzc8,1407
 fxn/logging.py,sha256=MsTSf0GZxrHNDwVAXDOh8_zRUg9hkeZ8DfhFUJs7D8A,7250
 fxn/sandbox.py,sha256=w2dnHMBaKOERxFMpeAP11X6_SPqcvnpd6SmX6b_FOYQ,7000
-fxn/version.py,sha256=zQOEiQse1Ff3n-mSuBrT9-JLRGel6n8RluZbXIshvHI,95
-fxn/beta/__init__.py,sha256=gKoDhuXtXCjdhUYUqmF0gDPMhJfg3UwFgbvMtRB5ipo,111
+fxn/version.py,sha256=NugzjvuR0aE7hGoUmoQvcI8t1IrmT-Xm9J9SaWp3wVk,95
+fxn/beta/__init__.py,sha256=aQAV-apg11Z7Pn86eIegJ2id7wkRUaYeEaeZthaCmYk,252
 fxn/beta/client.py,sha256=0lfwQPcB9ToIJC7AcCXO6DlJKkmId8EChhd9bk29GGE,2611
+fxn/beta/metadata.py,sha256=7mnbIVoGQm6_5Qy-gSV6xpGuSP6LcnFjKbmSBNze34w,3067
 fxn/beta/prediction.py,sha256=9DTBahNF6m0TicLab2o9e8IKpiSV6K7cUSTYaFju0ZU,356
 fxn/beta/remote.py,sha256=HC8OIslZYyxw3XafVCCrP_wrPa00y5uekkKd_tkzyV0,7551
 fxn/c/__init__.py,sha256=NMIduqO_MYtI9jVCu6ZxvbBtYQXoQyNEWblNy3m2UPY,313
@@ -17,12 +18,13 @@ fxn/c/prediction.py,sha256=-d-5yreFAaRS-nDHzhfabRNtgYcmJGiY_N2dt09gk84,2689
 fxn/c/predictor.py,sha256=48poLj1AthzCgU9n6Wv9gL8o4gFucIlOnBO2wdor6r0,1925
 fxn/c/stream.py,sha256=Y1Xv1Bt3_qlnWg9rCn7NWESpouF1eKMzDiQjhZWbXTg,1105
 fxn/c/value.py,sha256=h5n91nm8C3YvEEFORfJBUdncZ29DFIdUKGWQ_KpLsWc,7420
-fxn/cli/__init__.py,sha256=OcdxY751a5avAWNYUpBG92kjqpKmYXwhZxgB1mGwUpA,1396
+fxn/cli/__init__.py,sha256=vLCNLiXneZzMCFViDOngg3kQZ1rZwnZXzUSEOB38Il0,1542
 fxn/cli/auth.py,sha256=6iGbNbjxfCr8OZT3_neLThXdWeKRBZATwru8vU0XmRw,1688
-fxn/cli/compile.py,sha256=y5SOGSr5_B_WY-TYbg3Q9kCCaYGlbyQcDOYSPeg2lDc,5490
+fxn/cli/compile.py,sha256=dd3IV1bhBCbMEo0Py6KGxn3vfv_TSDCLL2f-4qLzfiw,6037
 fxn/cli/misc.py,sha256=LcJbCj_GAgtGraTRva2zHHOPpNwI6SOFntRksxwlqvM,843
 fxn/cli/predictions.py,sha256=ma7wbsKD5CFCRTU_TtJ8N0nN1fgFX2BZPGG8qm8HlNI,3182
 fxn/cli/predictors.py,sha256=bVQAuBue_Jxb79X85RTCzOerWRRT2Ny1oF5DNYAsx4M,1545
+fxn/cli/sources.py,sha256=HQ_PBLXY2CZ5tGuuqQeJQTpM9S9rKtBzyNVTK-ywG84,1781
 fxn/lib/__init__.py,sha256=-w1ikmmki5NMpzJjERW-O4SwOfBNkimej_0jL8ujYRk,71
 fxn/lib/linux/arm64/libFunction.so,sha256=NU9PEuQNObqtWPr5vXrWeQuYhzBfmX_Z4guaregFjrI,207632
 fxn/lib/linux/x86_64/libFunction.so,sha256=qZNlczayaaHIP_tJ9eeZ1TVpV1Os-ztvSWOoBuY9yWE,236272
@@ -39,9 +41,9 @@ fxn/types/dtype.py,sha256=71Tuu4IydmELcBcSBbmWswhCE-7WqBSQ4VkETsFRzjA,617
 fxn/types/prediction.py,sha256=BdLTxnKiSFbz5warX8g_Z4DedNxXK3gaNjSKR2FP8tA,2051
 fxn/types/predictor.py,sha256=KRGZEuDt7WPMCyRcZvQq4y2FMocfVrLEUNJCJgfDY9Y,4000
 fxn/types/user.py,sha256=Z44TwEocyxSrfKyzcNfmAXUrpX_Ry8fJ7MffSxRn4oU,1071
-fxn-0.0.44.dist-info/licenses/LICENSE,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
-fxn-0.0.44.dist-info/METADATA,sha256=5o1xzi17jmhMTf14XKQHixi_msQz57j7oTx3DtjCQOg,16144
-fxn-0.0.44.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-fxn-0.0.44.dist-info/entry_points.txt,sha256=O_AwD5dYaeB-YT1F9hPAPuDYCkw_W0tdNGYbc5RVR2k,45
-fxn-0.0.44.dist-info/top_level.txt,sha256=1ULIEGrnMlhId8nYAkjmRn9g3KEFuHKboq193SEKQkA,4
-fxn-0.0.44.dist-info/RECORD,,
+fxn-0.0.46.dist-info/licenses/LICENSE,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
+fxn-0.0.46.dist-info/METADATA,sha256=l-W_xp1vn_B4ORukQfRqqe_a2G1mN37IORvIfR-TjG8,16136
+fxn-0.0.46.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+fxn-0.0.46.dist-info/entry_points.txt,sha256=O_AwD5dYaeB-YT1F9hPAPuDYCkw_W0tdNGYbc5RVR2k,45
+fxn-0.0.46.dist-info/top_level.txt,sha256=1ULIEGrnMlhId8nYAkjmRn9g3KEFuHKboq193SEKQkA,4
+fxn-0.0.46.dist-info/RECORD,,