@@ -15,11 +15,13 @@ Currently the following heuristics feature such integration:
1515
1616This document is an outline of the tooling and APIs facilitating MLGO.
1717
18- Note that tools for orchestrating ML training are not part of LLVM, as they are
19- dependency-heavy - both on the ML infrastructure choice, as well as choices of
20- distributed computing. For the training scenario, LLVM only contains facilities
21- enabling it, such as corpus extraction, training data extraction, and evaluation
22- of models during training.
18+ .. note ::
19+
20+ The tools for orchestrating ML training are not part of LLVM, as they are
21+ dependency-heavy - both on the ML infrastructure choice, as well as choices of
22+ distributed computing. For the training scenario, LLVM only contains facilities
23+ enabling it, such as corpus extraction, training data extraction, and evaluation
24+ of models during training.
2325
2426
2527.. contents ::
@@ -329,8 +331,10 @@ We currently feature 4 implementations:
329331 the neural network, together with its weights (essentially, loops performing
330332 matrix multiplications)
331333
332- NOTE: we are actively working on replacing this with an EmitC implementation
333- requiring no out of tree build-time dependencies.
334+ .. note ::
335+
336+ we are actively working on replacing this with an EmitC implementation
337+ requiring no out of tree build-time dependencies.
334338
335339- ``InteractiveModelRunner ``. This is intended for training scenarios where the
336340 training algorithm drives compilation. This model runner has no special
@@ -526,9 +530,11 @@ implementation details.
526530Building with ML support
527531========================
528532
529- **NOTE ** For up to date information on custom builds, see the ``ml-* ``
530- `build bots <http://lab.llvm.org >`_. They are set up using
531- `like this <https://github.com/google/ml-compiler-opt/blob/main/buildbot/buildbot_init.sh >`_.
533+ .. note ::
534+
535+ For up to date information on custom builds, see the ``ml-* ``
536+ `build bots <http://lab.llvm.org >`_. They are set up using
537+ `like this <https://github.com/google/ml-compiler-opt/blob/main/buildbot/buildbot_init.sh >`_.
532538
533539Embed pre-trained models (aka "release" mode)
534540---------------------------------------------
@@ -562,9 +568,11 @@ You can also specify a URL for the path, and it is also possible to pre-compile
562568the header and object and then just point to the precompiled artifacts. See for
563569example ``LLVM_OVERRIDE_MODEL_HEADER_INLINERSIZEMODEL ``.
564570
565- **Note ** that we are transitioning away from the AOT compiler shipping with the
566- tensorflow package, and to a EmitC, in-tree solution, so these details will
567- change soon.
571+ .. note ::
572+
573+ We are transitioning away from the AOT compiler shipping with the
574+ tensorflow package, and to a EmitC, in-tree solution, so these details will
575+ change soon.
568576
569577Using TFLite (aka "development" mode)
570578-------------------------------------
0 commit comments