Skip to content

Commit 94a2546

Browse files
YifanYuan3facebook-github-bot
authored andcommitted
update readme
Summary: as titled Differential Revision: D82283600
1 parent d3b99d9 commit 94a2546

1 file changed

Lines changed: 11 additions & 8 deletions

File tree

packages/fbgemm/README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
1-
# FBGEMM Embedding Benchmark
1+
# FBGEMM Benchmarks
2+
23
`fbgemm_embedding` is a benchmark that simulates embedding table lookups representative of Model A and Model B workloads.
34
The benchmark closely mimics the hotspot functions in table-based embedding (TBE) inference operations, which are commonly used in recommendation systems and deep learning models.
45

6+
`fbgemm_cpu_fp16` is a microbenchmark that evaluates the FP16-based matrix multiplication performance, which are common in Meta's recommendation and ranking related workloads.
7+
8+
`fbgemm_cpu_spmdm8` is a C++ based micro-benchmark with some simple parameters and it benchmarks the TBE kernel. It's used for quick prototyping and performance validation.
9+
510
## Installation
6-
To install the FBGEMM embedding benchmark, execute one of the following command:
11+
To install the FBGEMM benchmarks, execute one of the following command:
712
```bash
813
./benchpress -b ai install fbgemm_embedding_a_single
914
./benchpress -b ai install fbgemm_embedding_a_spec
@@ -14,7 +19,7 @@ To install the FBGEMM embedding benchmark, execute one of the following command:
1419
./benchpress -b ai install fbgemm_cpu_spmdm8
1520
```
1621

17-
## Run FBGEMM Embedding Benchmark
22+
## Run FBGEMM Benchmarks
1823
### Job - `fbgemm_embedding_a_single`
1924
`fbgemm_embedding_a_single` simulates the Model A workload using a single representative embedding table.
2025
This benchmark is designed to evaluate performance with a simplified embedding configuration.
@@ -29,14 +34,12 @@ This benchmark is designed to evaluate performance with a simplified embedding c
2934
`fbgemm_embedding_b_spec_int8` simulates the Model B workload using a representative set of embedding tables with int8 quantized precision.
3035

3136
### Job - `fbgemm_cpu_fp16`
32-
`fbgemm_cpu_a` executes the FP16Benchmark from FBGEMM-CPU.
37+
`fbgemm_cpu_a` executes the `FP16Benchmark` from FBGEMM.
3338

3439
### Job - `fbgemm_embedding_cpu_b`
35-
`fbgemm_cpu_b` executes the EmbeddingSpMDM8BitBenchmark from FBGEMM-CPU.
36-
This is a C++ based micro-benchmark which stresses the TBE kernel.
37-
This benchmark is used for quick prototyping and performance validation.
40+
`fbgemm_cpu_b` executes the `EmbeddingSpMDM8BitBenchmark` from FBGEMM.
3841

39-
To run the FBGEMM embedding benchmarks, please use the following commands:
42+
To run the FBGEMM benchmarks, please use the following commands:
4043
```bash
4144
./benchpress -b ai run fbgemm_embedding_a_single
4245
./benchpress -b ai run fbgemm_embedding_a_spec

0 commit comments

Comments
 (0)