SDK Installation for Hosted Tutorials

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:

virtualenvconda

# 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 credit default 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.

virtualenvconda

(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

   

2. Run the notebook.

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