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.45.tar.gz (821.4 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.45-py3-none-any.whl (830.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fxn-0.0.45.tar.gz
  • Upload date:
  • Size: 821.4 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.45.tar.gz
Algorithm Hash digest
SHA256 f5e9c28560a4ab9cbd79ef10d1cf2224b56082c36fa274fe520a4d1e1216427a
MD5 9f334af95ca33f6dd01275149b5dc136
BLAKE2b-256 a650c697d6b977d42cddf631343ab3fd29efa164fe53cd4383b21c9f3ad6acb6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fxn-0.0.45-py3-none-any.whl
  • Upload date:
  • Size: 830.0 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.45-py3-none-any.whl
Algorithm Hash digest
SHA256 1f7d919a24780a20e74040dafafcbd599be0fe52818bd804d8b36702336d7ba8
MD5 42a326c31f11d2a8e0b8902e1c71ca4c
BLAKE2b-256 d5e871a80e4b0c5ae22e0e8c03cb0b01652b135217f19fc91453980e1378f00d

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