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.53.tar.gz (826.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.53-py3-none-any.whl (836.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fxn-0.0.53.tar.gz
  • Upload date:
  • Size: 826.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.53.tar.gz
Algorithm Hash digest
SHA256 256d5bb6c917edc2976def5572644511f162bf51f11cd2b4edb7556dd31b9a11
MD5 c17f41a395575613f2098508517a026f
BLAKE2b-256 1b8da753ed753f4ede948c288d045ae99b11a1c93b1ddea089cc351e53483185

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fxn-0.0.53-py3-none-any.whl
  • Upload date:
  • Size: 836.4 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.53-py3-none-any.whl
Algorithm Hash digest
SHA256 0882bf07a43cf418359c6acba503136476cd9da190697ffee61f4967671f7053
MD5 4012e0f09c2e1c6bcb636377d754753b
BLAKE2b-256 fb290277d394c31de9800d16174d2cfa5a68d171de9fd37e5eea436484b066d9

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