Skip to content

Commit 460fb57

Browse files
committed
Fix for review
1 parent 69ebacf commit 460fb57

File tree

5 files changed

+22
-34
lines changed

5 files changed

+22
-34
lines changed

docs/user_guides/client_installation/index.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,20 @@ description: Documentation on how to install the Hopsworks Python and Java libra
55

66
## Hopsworks Python library
77

8-
The Hopsworks Python 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 Hopsworks client library in your Python environment:
8+
The Hopsworks Python client library is required to connect to Hopsworks from your local machine or any other Python environment such as Google Colab or AWS Sagemaker. Execute the following command to install the Hopsworks client library in your Python environment:
99

1010
!!! note "Virtual environment"
1111
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.
1212

13+
!!! attention "Windows/Conda Installation"
14+
15+
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:
16+
17+
```bash
18+
conda install twofish
19+
pip install hopsworks[python]
20+
```
21+
1322
```bash
1423
pip install hopsworks[python]
1524
```

docs/user_guides/integrations/databricks/api_key.md

-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ For instructions on how to generate an API key follow this [user guide](../../pr
2424
port=443, # Port to reach your Hopsworks instance, defaults to 443
2525
project='my_project', # Name of your Hopsworks Feature Store project
2626
api_key_value='apikey', # The API key to authenticate with Hopsworks
27-
hostname_verification=True # Disable for self-signed certificates
2827
)
2928
fs = project.get_feature_store() # Get the project's default feature store
3029
```

docs/user_guides/integrations/databricks/configuration.md

+10-30
Original file line numberDiff line numberDiff line change
@@ -90,36 +90,16 @@ When a cluster is configured for a specific project user, all the operations wit
9090
At the end of the configuration, Hopsworks will start the cluster.
9191
Once the cluster is running users can establish a connection to the Hopsworks Feature Store from Databricks:
9292

93-
!!! note "API key on Azure"
94-
Please note, for Azure it is necessary to store the Hopsworks API key locally on the cluster as a file. As we currently do not support storing the API key on an Azure Secret Management Service as we do for AWS. Consult the [API key guide for Azure](api_key.md#azure), for more information.
95-
96-
=== "AWS"
97-
98-
```python
99-
import hopsworks
100-
project = hopsworks.connection(
101-
'my_instance', # DNS of your Feature Store instance
102-
443, # Port to reach your Hopsworks instance, defaults to 443
103-
'my_project', # Name of your Hopsworks Feature Store project
104-
api_key_value='apikey', # The API key to authenticate with Hopsworks
105-
hostname_verification=True # Disable for self-signed certificates
106-
)
107-
fs = project.get_feature_store() # Get the project's default feature store
108-
```
109-
110-
=== "Azure"
111-
112-
```python
113-
import hopsworks
114-
project = hopsworks.connection(
115-
'my_instance', # DNS of your Feature Store instance
116-
443, # Port to reach your Hopsworks instance, defaults to 443
117-
'my_project', # Name of your Hopsworks Feature Store project
118-
api_key_value='apikey', # The API key to authenticate with Hopsworks
119-
hostname_verification=True # Disable for self-signed certificates
120-
)
121-
fs = project.get_feature_store() # Get the project's default feature store
122-
```
93+
```python
94+
import hopsworks
95+
project = hopsworks.login(
96+
host='my_instance', # DNS of your Hopsworks instance
97+
port=443, # Port to reach your Hopsworks instance, defaults to 443
98+
project='my_project', # Name of your Hopsworks project
99+
api_key_value='apikey', # The API key to authenticate with Hopsworks
100+
)
101+
fs = project.get_feature_store() # Get the project's default feature store
102+
```
123103

124104
## Next Steps
125105

docs/user_guides/integrations/mlstudio_designer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Azure Machine Learning Designer Integration
22

3-
Connecting to the Hopsworks from the Azure Machine Learning Designer requires setting up a Hopsworks API key for the Designer and installing the **Hopsworks** Python library on the Designer. This guide explains step by step how to connect to the Feature Store from Azure Machine Learning Designer.
3+
Connecting to Hopsworks from the Azure Machine Learning Designer requires setting up a Hopsworks API key for the Designer and installing the **Hopsworks** Python library on the Designer. This guide explains step by step how to connect to the Feature Store from Azure Machine Learning Designer.
44

55
!!! info "Network Connectivity"
66

docs/user_guides/integrations/mlstudio_notebooks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Connecting to the Hopsworks from Azure Machine Learning Notebooks requires setti
66

77
To be able to connect to the Feature Store, please ensure that the Network Security Group of your Hopsworks instance on Azure is configured to allow incoming traffic from your compute target on ports 443, 9083 and 9085 (443,9083,9085). See [Network security groups](https://docs.microsoft.com/en-us/azure/virtual-network/network-security-groups-overview) for more information. If your compute target is not in the same VNet as your Hopsworks instance and the Hopsworks instance is not accessible from the internet then you will need to configure [Virtual Network Peering](https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-manage-peering).
88

9-
## Install Python Library
9+
## Install Hopsworks Python Library
1010

1111
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](https://pypi.org/project/hopsworks/) and can be installed using `pip`:
1212

0 commit comments

Comments
 (0)