Skip to content

Update ReadMe File #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Dec 5, 2024
Merged

Update ReadMe File #91

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
da3248d
Update README.md
sreenivasulureddysura Dec 5, 2024
84ca5d8
Merge pull request #1 from sreenivasulureddysura/Updated-Readme-file
sreenivasulureddysura Dec 5, 2024
450f3e5
Merge branch 'intel:main' into main
sreenivasulureddysura Dec 5, 2024
dbb6f8a
Create mdbook.yml
sreenivasulureddysura Dec 5, 2024
9c05952
Merge pull request #2 from sreenivasulureddysura/documentation
sreenivasulureddysura Dec 5, 2024
1f31160
Delete .github/workflows/mdbook.yml
sreenivasulureddysura Dec 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@

### 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.
Welcome to the **Workload Services Framework** repository. The repository contains a set of workloads optimized for Intel(R) Xeon(R) platforms. You can find the list of supported workloads in the [workload](workload) directory.

### Prerequisite

- Sync your system date/time. This is required by any credential authorization.
Before you begin, ensure the following:

- Sync your system date and time. This is required for 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.
- 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. Refer to [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

Expand All @@ -34,6 +36,9 @@ The WSF supports multiple validation backends. By default, the [terraform](doc/u

### Build Workload

To build a workload, use the following commands:


```
mkdir -p build
cd build
Expand All @@ -45,14 +50,16 @@ make

> 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.

Alternatively, you can use:

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

### See Also
### Additional Resources

- [Build Options](doc/user-guide/executing-workload/cmake.md)
- [Test Options](doc/user-guide/executing-workload/ctest.md)
Expand Down