# workload-services-framework

**Repository Path**: mirrors_intel/workload-services-framework

## Basic Information

- **Project Name**: workload-services-framework
- **Description**: Workload Services Framework (WSF) is a benchmarking framework on Intel(R) Xeon(R) Platforms
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-08-27
- **Last Updated**: 2026-05-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

>
> **Note: The Workload Services Framework is a benchmarking framework and is not intended to be used for the deployment of workloads in production environments. It is recommended that users consider any adjustments which may be necessary for the deployment of these workloads in a production environment including those necessary for implementing software best practices for workload scalability and security.**
>

### Introduction

This is the **Workload Services Framework** repository. The repository contains a set of workloads optimized for Intel(R) Xeon(R) platforms. See the list of supported workloads under the [workload](workload) directory.  

### Prerequisite

- Sync your system date/time. This is required by any credential authorization.  
- If you are behind a corporate firewall, please setup `http_proxy`, `https_proxy` and `no_proxy` in `/etc/environment`, and source the settings into the current shell environment.  
- Run the [`setup-dev.sh`](doc/user-guide/preparing-infrastructure/setup-wsf.md#setup-devsh) script to setup the development host for workload development and evaluation. See [Cloud and On-Premises Setup](doc/user-guide/preparing-infrastructure/setup-wsf.md) for additional SUT setup. SUT stands for System Under Test, or workload test machines.   
  
### Evaluate Workload

Evaluate any workload as follows:  

```
mkdir build 
cd build
cmake ..                               # .. is required here
cd workload/OpenSSL-RSAMB              # Go to any workload folder
./ctest.sh -N                          # List all test cases
./ctest.sh -R test_openssl_rsamb_sw_rsa -V  # Evaluate a specific test case
./list-kpi.sh logs*                    # Show KPIs
```

---

The WSF supports multiple validation backends. By default, the [terraform](doc/user-guide/preparing-infrastructure/setup-terraform.md) backend covers on-premises or Cloud testing. You can also use the [`docker`](doc/user-guide/preparing-infrastructure/setup-docker.md) backend, or the [`Kubernetes`](doc/user-guide/preparing-infrastructure/setup-kubernetes.md) backend for evaluating any workload locally.   

---

### Build Workload

```
mkdir -p build
cd build
cmake -DREGISTRY= -DBENCHMARK=ResNet-50 ..
cd workload/ResNet-50
make
./ctest.sh -N
```

> TIP: You can specify `BENCHMARK` to limit the repository scope to the specified workload. The build and test operations on all other workloads are disabled. See [Build Options](doc/user-guide/executing-workload/cmake.md) for details.  

```
cd build
cmake -DBENCHMARK=ResNet-50
make
./ctest.sh -N
```

### See Also

- [Build Options](doc/user-guide/executing-workload/cmake.md)   
- [Test Options](doc/user-guide/executing-workload/ctest.md)   
- [Setup Terraform](doc/user-guide/preparing-infrastructure/setup-terraform.md)