Skip to content

[MLGO][Docs] Add initial skeleton of MLGO docs #139177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
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
28 changes: 28 additions & 0 deletions llvm/docs/MLGO.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
====
MLGO
====

Introduction
============

MLGO is a framework for integrating ML techniques systematically in LLVM. It is
designed primarily to replace heuristics within LLVM with machine learned
models. Currently there is upstream infrastructure for the following
heuristics:

* Inlining for size
* Register allocation (LLVM greedy eviction heuristic) for performance

This document is an outline of the tooling that composes MLGO.

Corpus Tooling
==============

..
TODO(boomanaiden154): Write this section.

Model Runner Interfaces
=======================

..
TODO(mtrofin): Write this section.
1 change: 1 addition & 0 deletions llvm/docs/Reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ LLVM and API reference documentation.
PDB/index
PointerAuth
ScudoHardenedAllocator
MLGO
MemoryModelRelaxationAnnotations
MemTagSanitizer
Security
Expand Down
Loading