Skip to content

Installation

Select the installation mode that best suits your needs

Usage Scenario Installation Mode
Run FeatureByte tutorials Tutorials
Scalable production High Availability

Installation modes

Local Service Installation Get started quickly with the FeatureByte SDK tutorials.

Installation Steps

Requirements

Software

  • Python 3.10 or higher

Step 1: Obtain an API Token

  1. Visit the FeatureByte Hosted Tutorials page
  2. Follow the instructions to sign up for an API token.

This token will grant you access to the hosted tutorials server running on a Snowflake data warehouse, where the tutorial data is already populated.

Step 2: Set up a virtual environment.

Using a virtual environment helps avoid potential conflicts with other packages. Here's how you can set one up:

# Create a new virtual environment
python -m venv featurebyte-env

# Activate the virtual environment
## On Windows, run:
featurebyte-env\Scripts\activate.bat
## On Unix or MacOS, run:
source featurebyte-env/bin/activate
Further reading: venv documentation.

# Create a new virtual environment
conda create --name featurebyte-env python=3.10 -y
# Activate the virtual environment
conda activate featurebyte-env
Further reading: conda documentation.

Step 3: Download the tutorial notebooks.

Download the end-to-end notebooks archive to a location on your computer.

Step 4: Load the tutorials in your preferred notebook environment.

Install your preferred notebook environment, like JupyterLab and start with the 00_Setup_Environment.ipynb notebook.

(featurebyte-env) ~/featurebyte_tutorials> pip install jupyterlab
(featurebyte-env) ~/featurebyte_tutorials> jupyter-lab 00_Setup_Environment.ipynb
(featurebyte-env) ~/featurebyte_tutorials> conda install -c conda-forge jupyterlab
(featurebyte-env) ~/featurebyte_tutorials> jupyter-lab 00_Setup_Environment.ipynb

Step 5: Run 00_Setup_Environment.ipynb

  1. Replace <api_token> with the API token you received after registering

    setup

  2. Run the notebook.

You are now all set to immerse yourself in the tutorials and the end-to-end workflow!

High Availability Production Ready FeatureByte service must be customized to fit the needs of your organization. Please contact us at FeatureByte for more information.

Kubernetes Host Requirements

3 Nodes of the following configuration:

Hardware

  • x86_64 architecutre with 8 cpu cores
  • 32GB of RAM

Network Attached Storage (NAS)

  • 200GB of storage space

Networking

  • Egress access to ChatGPT
  • Access to Blob Storage e.g. AWS S3, Azure Blob Storage, Google Cloud Storage