Add behavioral cloning step to LLVM inliner model training demo

Author: beamandala

docs/llvm/README.md

@@ -0,0 +1,53 @@
+# LLVM MLGO Inliner Demo
+
+## 1. Build the Docker Image
+
+From the repository root, build the development environment container:
+
+```bash
+docker build -t ml-compiler-opt-llvm docs/llvm/
+```
+
+## 2. Run the Container
+
+Run the container with volume mounts to persist corpus data, training logs, and checkpoints locally. This enables running TensorBoard on the host to monitor training.
+
+```bash
+sudo docker run -it \
+  -v "$(pwd):/work/ml-compiler-opt" \
+  -v "$(pwd)/local_logs:/work/corpus/" \
+  ml-compiler-opt-llvm /bin/bash
+```
+
+## 3. Run the Training Pipeline
+
+Inside the container, execute the entire end-to-end pipeline:
+
+```bash
+./docs/llvm/run_everything.sh
+```
+
+---
+
+## 4. Monitor Training Progress
+
+To monitor the training progress using TensorBoard, run the following command on your **host machine** pointing to the mounted logs directory:
+
+```bash
+tensorboard --logdir local_logs
+```
+
+---
+
+## 5. Evaluate the Model
+
+Evaluate the size savings of your trained ML model against the baseline heuristic:
+
+```bash
+./docs/llvm/evaluate_model.sh
+```
+
+To see available options (e.g., count, shuffling, specific models):
+```bash
+./docs/llvm/evaluate_model.sh --help
+```

docs/llvm/run_everything.sh

@@ -27,4 +27,5 @@ fi
 "${SCRIPT_DIR}/extract_corpus.sh"
 "${SCRIPT_DIR}/generate_default_trace.sh"
 "${SCRIPT_DIR}/generate_vocab.sh"
+"${SCRIPT_DIR}/train_bc.sh"
 "${SCRIPT_DIR}/train_with_es.sh"

docs/llvm/train_bc.sh

@@ -0,0 +1,24 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+#!/bin/bash
+
+cd /work/ml-compiler-opt
+
+TF_CPP_MIN_LOG_LEVEL=3 GINPATH=/work/ml-compiler-opt PYTHONPATH=/work/ml-compiler-opt:$PYTHONPATH \
+  python /work/ml-compiler-opt/compiler_opt/rl/train_bc.py \
+  --root_dir /work/corpus/bc_model \
+  --gin_files /work/ml-compiler-opt/compiler_opt/rl/inlining/gin_configs/behavioral_cloning_nn_agent.gin \
+  --gin_bindings inlining.config.get_observation_processing_layer_creator.quantile_file_dir="'/work/corpus/vocab'" \
+  --data_path /work/corpus/default_trace

docs/llvm/train_with_es.sh

@@ -22,4 +22,5 @@ TF_CPP_MIN_LOG_LEVEL=3 PYTHONPATH=/work/ml-compiler-opt:$PYTHONPATH \
   --gin_bindings clang_path="'/work/llvm-train/bin/clang'" \
   --gin_bindings llvm_size_path="'/work/llvm-train/bin/llvm-size'" \
   --gin_bindings inlining.config.get_observation_processing_layer_creator.quantile_file_dir="'/work/corpus/vocab'" \
+  --gin_bindings pretrained_policy_path="'/work/corpus/bc_model/saved_policy'" \
   --output_path /work/corpus/trained_model_es