| description |
|---|
Documentation on how to install the Hopsworks and HSFS Python libraries, including the specific requirements for Mac OSX and Windows. |
The Hopsworks client library is required to connect to the Hopsworks Feature Store and MLOps services from your local machine or any other Python environment such as Google Colab or AWS Sagemaker. Execute the following command to install the full Hopsworks client library in your Python environment:
!!! note "Virtual environment" It is recommended to use a virtual python environment instead of the system environment used by your operating system, in order to avoid any side effects regarding interfering dependencies.
pip install hopsworksSupported versions of Python: 3.8, 3.9, 3.10, 3.11, 3.12 (PyPI ↗)
!!! attention "OSX Installation"
Hopsworks latest version should work on OSX systems without any additional requirements. However if installing an older version of the Hopsworks SDK you might need to install librdkafka manually. Checkout the documentation for the specific version you are installing.
!!! attention "Windows/Conda Installation"
On Windows systems you might need to install twofish manually before installing hopsworks, if you don't have the Microsoft Visual C++ Build Tools installed. In that case, it is recommended to use a conda environment and run the following commands:
```bash
conda install twofish
pip install hopsworks
```
To only install the Hopsworks Feature Store client library, execute the following command:
pip install hsfs[python]
# or if using zsh
pip install 'hsfs[python]'Supported versions of Python: 3.8, 3.9, 3.10, 3.11, 3.12 (PyPI ↗)
!!! attention "OSX Installation"
Hopsworks latest version should work on OSX systems without any additional requirements. However if installing an older version of the Hopsworks SDK you might need to install librdkafka manually. Checkout the documentation for the specific version you are installing.
!!! attention "Windows/Conda Installation"
On Windows systems you might need to install twofish manually before installing hsfs, if you don't have the Microsoft Visual C++ Build Tools installed. In that case, it is recommended to use a conda environment and run the following commands:
```bash
conda install twofish
pip install hsfs[python]
```
If you are using a local python environment and want to connect to the Hopsworks Feature Store, you can follow the Python Guide section to create an API Key and to get started.
The Hopsworks Feature Store client libraries can also be installed in external environments, such as Databricks, AWS Sagemaker, or Azure Machine Learning. For more information, see Client Integrations.