Skip to content

Commit

Permalink
doc: abolish content
Browse files Browse the repository at this point in the history
  • Loading branch information
Yakkhini committed Dec 9, 2024
1 parent 6416789 commit 7760ef8
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# OpenPerf Project

OpenPerf is an open source benchmark aims to test the performance of the microarchitechture in processor core, developed and be mantained by [One Student One Chip Project](https://ysyx.org).
OpenPerf is an open source benchmark for evaluating test the performance of the microarchitecture in processor core, developed and be maintained by [One Student One Chip Project](https://ysyx.org).

# How to use

This project is planning to integrate with [YSYX's workbench](https://github.com/OSCPU/ysyx-workbench) and [NJU ProjectN](https://github.com/NJU-ProjectN).
This project plans to integrate with [YSYX's workbench](https://github.com/OSCPU/ysyx-workbench) and [NJU ProjectN](https://github.com/NJU-ProjectN).

To use openperf in baseline practice, clone it into your project's [AbstractMachine Kernels](https://github.com/NJU-ProjectN/am-kernels).

Expand All @@ -15,7 +15,7 @@ cd openperf
make ARCH= ... # NOTICE: `...` is not a part of the make command and you need to write it by yourself.
```

The make recipe just like other benchmark programs in `am-kernel` that you can decide the Architectures and the test scale.
The make recipe, like other benchmark programs in `am-kernel`, allows you to choose the architectures and the test scale.

## Benchmark Programs

Expand Down Expand Up @@ -51,19 +51,20 @@ The make recipe just like other benchmark programs in `am-kernel` that you can d
* Stream Memory Access: STREAM
* Irregular Memory Access: mcf
* Float Memory: GEMM
* Footprint: Gsim and essent which verilate various RISC-V processor cores like riscv-mini, Nutshell, Rocket Core, BOOM and XiangShan
* Footprint: Gsim and essent which simulate various RISC-V processor cores such as riscv-mini, Nutshell, Rocket Core, BOOM and XiangShan
* Branch Prediction: TCC
* Floating-point Arithmetic: Linpack, Whetstone
* Utils: soft-fp(cyl), abstract-machine, openlibm

## Ranking (Coming Soon)

One Student One Chip Project is planning to build a rank for students! You can run OpenPerf with your NEMU or NPC to figure out the performance, and compare to others.
The One Student One Chip Project is planning to build a ranking system for students! You can run OpenPerf with your NEMU or NPC to find out your performance and compare with others.

## Contribute Guide

### Roadmap

- [x] Transplant benchmark programs
- [ ] Test the sensitivity of different programs
- [ ] Early Access
- [ ] Test the sensitivity of various programs
- [ ] Collect performance data from various open source processor cores
- [ ] Get early access

0 comments on commit 7760ef8

Please sign in to comment.