SDK Setup¶

This document provides a comprehensive guide to setting up the SDK for your development environment. Follow the steps below to ensure a smooth installation and configuration process.

Prerequisites¶

Before you begin, ensure that you have the following prerequisites installed on your system:

Python 3.10 or higher
pip (Python package installer)
A running instance of FeatureByte (cloud or on-premise)

Step 1: Create the Access token¶

To interact with the FeatureByte API, you need to create an access token. Follow these steps:

Create Access Token

Choose the lifetime of the token and click on "Create Access Token". A lifetime of 0 means the token will never expire.

Create Access Token

Step 2: Install the SDK¶

Install the SDK using pip. You can install it directly from PyPI:

pip install featurebyte

Install SDK

Step 3: Configure the SDK¶

A configuration file is created at ~/.featurebyte/config.yaml. You can edit this file to set your access token and other configurations.

Alternatively, you can set the access token programmatically in your code:

import featurebyte as fb

# Please refer to the image below for the parameters
fb.register_profile("<profile_name>", "<api_endpoint>", "<access_token>")
fb.use_profile("<profile_name>")

Configure SDK