Skip to content

Commit

Permalink
Partially fix locust_benchmark/README.md
Browse files Browse the repository at this point in the history
TODO: lines 21 and 28
  • Loading branch information
aversey committed Oct 25, 2024
1 parent d668020 commit 0d8ab38
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions locust_benchmark/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Online Feature Store Benchmark Suite
## Hopsworks Benchmark Suite

This directory provides the tools to quickly bootstrap the process of benchmarking the Hopsworks Online Feature Store.
This directory provides the tools to quickly bootstrap the process of benchmarking Hopsworks.

The benchmark suite is built around [locust](https://locust.io/) which allows you to quickly start so-called user classes to perform requests against a system.

Expand All @@ -17,12 +17,12 @@ This section illustrates how to quickly run locust in a single process, see the
#### Prerequisites

1. Hopsworks cluster
1. You can follow the documentation on how to setup a cluster on [managed.hopsworks.ai](https://docs.hopsworks.ai/3.1/setup_installation/aws/cluster_creation/)
1. You can follow the documentation on how to set up a cluster on [managed.hopsworks.ai](https://docs.hopsworks.ai/4.0/setup_installation/aws/getting_started/)
2. Ideally you create an extra node in the same VPC as the Hopsworks cluster, which you can use to run the benchmark suite from. The easiest way to do this is by using a dedicated [API node](https://docs.hopsworks.ai/3.1/setup_installation/common/rondb/#api-nodes).
3. Once the cluster is created you need the following information:
- Hopsworks domain name: **[UUID].cloud.hopsworks.ai** which you can find in the *Details* tab of your managed.hopsworks.ai control plane
- Hopsworks domain name: **\[UUID\].cloud.hopsworks.ai** which you can find in the *Details* tab of your managed.hopsworks.ai control plane
- A project and its name on the hopsworks cluster. For that log into your cluster and create a project.
- An API key for authentication. Head to your project and [create an API key for your account](https://docs.hopsworks.ai/3.1/user_guides/projects/api_key/create_api_key/).
- An API key for authentication. Head to your project and [create an API key for your account](https://docs.hopsworks.ai/4.0/user_guides/projects/api_key/create_api_key/).
2. Python environment
In order to run the benchmark suite, you need a Python environment.
For that we will SSH into the created API node. Make sure that [SSH is enabled](https://docs.hopsworks.ai/3.1/setup_installation/common/services/) on your cluster.
Expand All @@ -45,12 +45,12 @@ This section illustrates how to quickly run locust in a single process, see the
conda activate locust-benchmark
```

Clone the feature-store-api repository to retrieve the benchmark suite and install the requirements.
Clone the [hopsworks-api](https://github.com/logicalclocks/hopsworks-api/) repository to retrieve the benchmark suite and install the requirements.
Make sure to checkout the release branch matching the Hopsworks version of your cluster.

```bash
git clone https://github.com/logicalclocks/feature-store-api.git
cd feature-store-api
git clone https://github.com/logicalclocks/hopsworks-api.git
cd hopsworks-api
git checkout master
cd locust_benchmark
pip install -r requirements.txt
Expand Down

0 comments on commit 0d8ab38

Please sign in to comment.