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.49.tar.gz (825.8 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.49-py3-none-any.whl (834.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fxn-0.0.49.tar.gz
  • Upload date:
  • Size: 825.8 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.49.tar.gz
Algorithm Hash digest
SHA256 72a24895f5eaa313b1e424e3605054983ba429711a78b016c9e6352e95be3e62
MD5 f67b21a3dc5a9c7c1d9b2faeb8aeae85
BLAKE2b-256 a6025cf520ae00e0a689a0df08ac0a3c784a64c41a7d42f91a1e24cdf11b1173

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fxn-0.0.49-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.49-py3-none-any.whl
Algorithm Hash digest
SHA256 883a7263d06288deb17f4c901231af99b16d49281d06338514848d40e7a032b2
MD5 e60f6ff92f9171770b35ec10f6f10f1e
BLAKE2b-256 2186a0b7368bf5dbe50ecc30e199cf6af787027c36bbf9a4261264c7492ae1ba

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