Skip to main content

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

Project description

Function for Python and CLI

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.44.tar.gz (820.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.44-py3-none-any.whl (828.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for fxn-0.0.44.tar.gz
Algorithm Hash digest
SHA256 25dc58728cc8f514de85ca1b3e8cd91c160a9fed52e8f2a9dd30d07622351067
MD5 0aaebe9fccca4f20cf201c5545afb176
BLAKE2b-256 628a671a74f8171f7fb6a3bc78f41b27b8ac246fbb0743399a581f7bbc051f18

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for fxn-0.0.44-py3-none-any.whl
Algorithm Hash digest
SHA256 3671200e620dff26b9077006cf3ce7f4a0d56db8aa76e112726b49dc4f30da79
MD5 5f9544cef863e173e0bf99d5de68a150
BLAKE2b-256 d359e4ab58b928e1b4d87e4cd0245a495fc7cbc903c685a534d4b14f511a7faf

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