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.43.tar.gz (819.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.43-py3-none-any.whl (827.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fxn-0.0.43.tar.gz
  • Upload date:
  • Size: 819.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.43.tar.gz
Algorithm Hash digest
SHA256 5baedaf6c235d674b7c3c36d64e274fa0f408a36e1af08ef3f24e046f90ffa8e
MD5 87a21e49426c3b8a67f03b491c9c5b65
BLAKE2b-256 3cd570c99b9a032d249cf1b9964d6959fb156142cf56357495f09bd87683e399

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fxn-0.0.43-py3-none-any.whl
  • Upload date:
  • Size: 827.1 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.43-py3-none-any.whl
Algorithm Hash digest
SHA256 08fc4a493695be84140804d6ca196a1a13aac40f284926d80d730dfdf86b63e3
MD5 501469d091a2108a0f48af478a7e7cd9
BLAKE2b-256 c97ca88212b636181d7c36f088ea81d5411d8623b255cb8fb2322aa02a8c2805

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