Python Environments (Local, AWS SageMaker, Google Colab or Kubeflow)#

This guide explains step by step how to connect to Hopsworks from any Python environment such as your local environment, AWS SageMaker, Google Colab or Kubeflow.

Install Python Library#

To be able to interact with Hopsworks from a Python environment you need to install the Hopsworks Python library. The library is available on PyPi and can be installed using pip:

pip install hopsworks[python]~=[HOPSWORKS_VERSION]

Matching Hopsworks version

We recommend that the major and minor version of the Python library match the major and minor version of the Hopsworks deployment.

Generate an API key#

For instructions on how to generate an API key follow this user guide. For the Python client to work correctly make sure you add the following scopes to your API key:

1. featurestore
2. project
3. job
4. kafka

Connect to the Feature Store#

You are now ready to connect to Hopsworks from your Python environment:

import hopsworks 
project = hopsworks.login(
    host='my_instance',                 # DNS of your Hopsworks instance
    port=443,                           # Port to reach your Hopsworks instance, defaults to 443
    project='my_project',               # Name of your Hopsworks project
    api_key_value='apikey',             # The API key to authenticate with Hopsworks
    engine='python',                    # Use the Python engine
)
fs = project.get_feature_store()        # Get the project's default feature store

Next Steps#

For more information on how to use the Hopsworks API check out the other guides or the API Reference.