[llvm-branch-commits] [llvm] [NFC][IR2Vec] Add usage documentation for obtaining embeddings (PR #155516)

[via llvm-branch-commits]

llvmbot wrote:


<!--LLVM PR SUMMARY COMMENT-->

@llvm/pr-subscribers-mlgo

Author: S. VenkataKeerthy (svkeerthy)

<details>
<summary>Changes</summary>



---
Full diff: https://github.com/llvm/llvm-project/pull/155516.diff


1 Files Affected:

- (modified) llvm/include/llvm/Analysis/IR2Vec.h (+6) 


``````````diff
diff --git a/llvm/include/llvm/Analysis/IR2Vec.h b/llvm/include/llvm/Analysis/IR2Vec.h
index 26a3d303e7ab0..9a427e559d943 100644
--- a/llvm/include/llvm/Analysis/IR2Vec.h
+++ b/llvm/include/llvm/Analysis/IR2Vec.h
@@ -24,6 +24,12 @@
 ///   Code Optimization (TACO), 2020. https://doi.org/10.1145/3418463.
 ///   https://arxiv.org/abs/1909.06228
 ///
+/// To obtain embeddings:
+/// First run the IR2Vec vocabulary analysis pass to populate the vocabulary.
+/// Then, use the Embedder interface to generate embeddings for the desired IR
+/// entities. See the documentation for more details -
+/// https://llvm.org/docs/MLGO.html#ir2vec-embeddings
+///
 //===----------------------------------------------------------------------===//
 
 #ifndef LLVM_ANALYSIS_IR2VEC_H

``````````

</details>


https://github.com/llvm/llvm-project/pull/155516