[NFC][MLGO] Convert notes to proper RST note directives in MLGO.rst (#146450)

This commit is contained in:
S. VenkataKeerthy
2025-06-30 18:25:12 -07:00
committed by GitHub
parent 9438048816
commit a2dc64cd03

View File

@@ -15,7 +15,9 @@ Currently the following heuristics feature such integration:
This document is an outline of the tooling and APIs facilitating MLGO.
Note that tools for orchestrating ML training are not part of LLVM, as they are
.. note::
The tools for orchestrating ML training are not part of LLVM, as they are
dependency-heavy - both on the ML infrastructure choice, as well as choices of
distributed computing. For the training scenario, LLVM only contains facilities
enabling it, such as corpus extraction, training data extraction, and evaluation
@@ -329,7 +331,9 @@ We currently feature 4 implementations:
the neural network, together with its weights (essentially, loops performing
matrix multiplications)
NOTE: we are actively working on replacing this with an EmitC implementation
.. note::
we are actively working on replacing this with an EmitC implementation
requiring no out of tree build-time dependencies.
- ``InteractiveModelRunner``. This is intended for training scenarios where the
@@ -526,7 +530,9 @@ implementation details.
Building with ML support
========================
**NOTE** For up to date information on custom builds, see the ``ml-*``
.. note::
For up to date information on custom builds, see the ``ml-*``
`build bots <http://lab.llvm.org>`_. They are set up using
`like this <https://github.com/google/ml-compiler-opt/blob/main/buildbot/buildbot_init.sh>`_.
@@ -562,7 +568,9 @@ You can also specify a URL for the path, and it is also possible to pre-compile
the header and object and then just point to the precompiled artifacts. See for
example ``LLVM_OVERRIDE_MODEL_HEADER_INLINERSIZEMODEL``.
**Note** that we are transitioning away from the AOT compiler shipping with the
.. note::
We are transitioning away from the AOT compiler shipping with the
tensorflow package, and to a EmitC, in-tree solution, so these details will
change soon.