performance/docs

.NET Performance Repository Documentation Readme

The documentation in this repo is organized into the following sections:

Getting Started

• Prerequisites - Information on what you need to get started.
• Perf report walkthrough - This document describes Performance Report Advanced Features.
• Crank to Helix workflow - Information on how to schedule performance tests to be run on Helix machines using Crank (instead of running locally).
• Profiling workflow dotnet runtime - This doc explains how to profile local dotnet/runtime builds and it's targetted at dotnet/runtime repository contributors.
• Pipeline templates - Information on azure yml pipelines.

Running Benchmarks

• BenchmarkDotNet - Information of how to run benchmarks using BenchmarkDotNet tool and interpret results.
• Benchmarking workflow - Information about the (micro)benchmarks for the dotnet/runtime in this repository.
• Microbenchmarks Guide for information on running our microbenchmarks.
• Micro Benchmarks of .NET Runtime(s) - Information on benchmarks of .NET Runtime(s).
• Microbenchmarks design guidelines - Detailed guidelines on how to design and write microbenchmarks.
• benchmarks_local.py script guide - Description of a script for testing the performance of the different dotnet/runtime build types locally.
• ResultsComparer tool - Information on tool which allows for easy comparison of provided benchmark results.
• Serializers Benchmarks - Information on benchmarks of the most popular serializers.
• bepuphysics2 Benchmarks - Information on benchmarks of bepuphysics2 library.
• Microsoft.ML Benchmarks datasets - Information on datasets used for benchmarking of the Microsoft.ML library.
• Benchmarks run in PowerShell - Information on performance tests for different pieces of the library run using PowerShell.

GC Benchmarks

• ASP.NET Benchmarks errors - Information on main types of errors while running ASP.NET Benchmarks using crank.
• Testing GC.Infrastructure - Information on testing GC.Infrastructure.
• GC.Analysis.API - Information on conducting GC, CPU and Threading analysis using .NET Interactive notebooks.
• GC.Infrastructure Notebooks - Information on notebooks that either provide examples or functionality for specialized analysis
• Benchmark Analysis - Information on a notebook which contains code for producing charts (and soon, tables) for GC benchmarks. It can currently process data from the ASP.NET benchmarks obtained using crank as well as ETL data.

Running Scenarios

• Scenarios workflow - An introduction of how to run scenario tests.
• Basic scenarios - Specific instruction of how to run various basic scenarios.
• Blazor scenarios - Specific instruction of how to run New Blazorwasm Template Size On Disk scenarios.
• Cross-gen scenarios - Specific instruction of how to run crossgen scenarios.
• SDK scenarios - Specific instruction of how to run SDK Build Throughput Scenario scenarios.