Skip to main content

Run prediction functions locally in Python. Register at https://fxn.ai.

Project description

Function for Python

function logo

Dynamic JSON Badge

Run prediction functions (a.k.a "predictors") locally in your Python apps, with full GPU acceleration and zero dependencies.

[!TIP] Join our 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:

# Install Function
$ pip install --upgrade fxn

[!NOTE] Function requires Python 3.10+

Retrieving your Access Key

Head over to fxn.ai to create an account by logging in. Once you do, generate an access key:

generate access key

Making a Prediction

First, create a Function client, specifying your access key:

from fxn import Function

# Create the Function client
fxn = Function(access_key="<Function access key>")

Then make a prediction:

# Create a prediction
prediction = fxn.predictions.create(
    tag="@fxn/greeting",
    inputs={ "name": "Peter" }
)
# Print the returned greeting
print(prediction.results[0])

Using the Function CLI

Open up a terminal and login to the Function CLI:

# Login to Function
$ fxn auth login <ACCESS KEY>

Then make a prediction:

# Make a prediction using the Function CLI
$ fxn predict @fxn/greeting --name Peter

Useful Links

Function is a product of NatML Inc.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fxn-0.0.51.tar.gz (825.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fxn-0.0.51-py3-none-any.whl (834.3 kB view details)

Uploaded Python 3

File details

Details for the file fxn-0.0.51.tar.gz.

File metadata

  • Download URL: fxn-0.0.51.tar.gz
  • Upload date:
  • Size: 825.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for fxn-0.0.51.tar.gz
Algorithm Hash digest
SHA256 9ac569c0ae304cdf33563e8f5ed04b79e7cd7ef2dc12f295a2defb4eb80282df
MD5 5818ac25a3f672c760e74819620bb018
BLAKE2b-256 7eec3588680f52479fa3a079c0bfb19cb142fdc40408518982492fa0fe5d032d

See more details on using hashes here.

File details

Details for the file fxn-0.0.51-py3-none-any.whl.

File metadata

  • Download URL: fxn-0.0.51-py3-none-any.whl
  • Upload date:
  • Size: 834.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for fxn-0.0.51-py3-none-any.whl
Algorithm Hash digest
SHA256 217cad4aec92880afb3dbb4f3887f59e3cf44e6902a794ce243ebc4efd53f259
MD5 70aa9b6905b68917c7349728a4fe003d
BLAKE2b-256 55c34de8a31aa73b81cdd2b9f52a99c74ab1b1f09ce7f540235b21e206969809

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page