Skip to content

Commit 8e895b5

Browse files
[MLGO][Docs] Add initial skeleton of MLGO docs
This adds an initial skeleton of the MLGO docs. This is intended to be fleshed out over the next couple days as we work on filling out the relevant sections on the tooling/features that are available in upstream LLVM. Reviewers: efriedma-quic, mtrofin Reviewed By: mtrofin Pull Request: #139177
1 parent 035dcf6 commit 8e895b5

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

llvm/docs/MLGO.rst

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
====
2+
MLGO
3+
====
4+
5+
Introduction
6+
============
7+
8+
MLGO is a framework for integrating ML techniques systematically in LLVM. It is
9+
designed primarily to replace heuristics within LLVM with machine learned
10+
models. Currently there is upstream infrastructure for the following
11+
heuristics:
12+
13+
* Inlining for size
14+
* Register allocation (LLVM greedy eviction heuristic) for performance
15+
16+
This document is an outline of the tooling that composes MLGO.
17+
18+
Corpus Tooling
19+
==============
20+
21+
..
22+
TODO(boomanaiden154): Write this section.
23+
24+
Model Runner Interfaces
25+
=======================
26+
27+
..
28+
TODO(mtrofin): Write this section.

llvm/docs/Reference.rst

+1
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ LLVM and API reference documentation.
4141
PDB/index
4242
PointerAuth
4343
ScudoHardenedAllocator
44+
MLGO
4445
MemoryModelRelaxationAnnotations
4546
MemTagSanitizer
4647
Security

0 commit comments

Comments
 (0)