https://github.com/fxnai/fxnjs

Run Python functions in the browser and Node.js. https://fxn.ai/explore
https://github.com/fxnai/fxnjs

Last synced: about 2 months ago
JSON representation

Run Python functions in the browser and Node.js. https://fxn.ai/explore

• Host: GitHub
• URL: https://github.com/fxnai/fxnjs
• Owner: fxnai
• License: apache-2.0
• Created: 2023-05-15T15:10:59.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-12T22:18:30.000Z (2 months ago)
• Last Synced: 2024-11-02T19:34:52.561Z (about 2 months ago)
• Language: TypeScript
• Homepage: https://docs.fxn.ai
• Size: 833 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: Changelog.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Function for JavaScript

![function logo](https://raw.githubusercontent.com/fxnai/.github/main/logo_wide.png)

[![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fdiscord.com%2Fapi%2Finvites%2Fy5vwgXkz2f%3Fwith_counts%3Dtrue&query=%24.approximate_member_count&logo=discord&logoColor=white&label=Function%20community)](https://discord.gg/fxn)

Run Python functions (a.k.a "predictors") locally in the browser and Node.js, with full GPU acceleration and zero dependencies.

> [!TIP]

> [Join our waitlist](https://fxn.ai/waitlist) to bring your custom Python functions and run them on-device across Android, iOS, macOS, Linux, web, and Windows.

> [!CAUTION]

> **Never embed access keys client-side (i.e. in the browser)**. Instead, create a proxy URL in your backend.

## Installing Function

Function is distributed on NPM. Open a terminal and run the following command:

```bash

$ npm install fxnjs

```

## Retrieving your Access Key

Head over to [fxn.ai](https://fxn.ai) to create an account by logging in. Once you do, generate an access key:

![generate access key](https://raw.githubusercontent.com/fxnai/.github/main/access_key.gif)

## Making a Prediction

First, create a Function client, specifying your access key:

```js

import { Function } from "fxnjs"

// Create a Function client

const fxn = new Function({ accessKey: "" });

```

Then make a prediction:

```js

// Make a prediction

const prediction = await fxn.predictions.create({

    tag: "@fxn/greeting",

    inputs: { name: "Rhea" }

});

// Log the result

console.log(prediction.results[0]);

```

___

## Useful Links

- [Discover predictors to use in your apps](https://fxn.ai/explore).

- [Join our Discord community](https://discord.gg/fxn).

- [Check out our docs](https://docs.fxn.ai).

- Learn more about us [on our blog](https://blog.fxn.ai).

- Reach out to us at [[email protected]](mailto:[email protected]).

Function is a product of [NatML Inc](https://github.com/natmlx).