Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions docs/source/contributing/benchmarking_api_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ This tutorial will guide you through using the TorchAO benchmarking framework. T
3. [Add an HF model to benchmarking recipes](#add-an-hf-model-to-benchmarking-recipes)
4. [Add an API to micro-benchmarking CI dashboard](#add-an-api-to-benchmarking-ci-dashboard)

(add-an-api-to-benchmarking-recipes)=
## Add an API to Benchmarking Recipes

The framework currently supports quantization and sparsity recipes, which can be run using the quantize_() or sparsity_() functions:
Expand All @@ -33,6 +34,7 @@ Now we can use this recipe throughout the benchmarking framework.

**Note:** If the `AOBaseConfig` uses input parameters, like bit-width, group-size etc, you can pass them appended to the string config in input. For example, for `Float8DynamicActivationFloat8WeightConfig` we can pass granularity as `float8dq-tensor` or `float8dq-row`.

(add-a-model-to-benchmarking-recipes)=
## Add a Model to Benchmarking Recipes

To add a new model architecture to the benchmarking system, you need to modify `torchao/testing/model_architectures.py`.
Expand Down Expand Up @@ -91,9 +93,11 @@ When adding new models:

- **Quantization Compatibility**: Design your model to work with TorchAO quantization methods

(add-an-hf-model-to-benchmarking-recipes)=
## Add an HF model to benchmarking recipes
(Coming soon!!!)

(add-an-api-to-benchmarking-ci-dashboard)=
## Add an API to Benchmarking CI Dashboard

To integrate your API with the CI [dashboard](https://hud.pytorch.org/benchmark/llms?repoName=pytorch%2Fao&benchmarkName=micro-benchmark+api):
Expand Down
2 changes: 2 additions & 0 deletions docs/source/performant_kernels.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

Performant Kernels
==================

Expand Down