[NFC][IR2Vec] Add usage documentation for obtaining embeddings #155516
+356
−308
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Aug 26, 2025
|
@llvm/pr-subscribers-llvm-analysis Author: S. VenkataKeerthy (svkeerthy) ChangesFull diff: https://github.com/llvm/llvm-project/pull/155516.diff 1 Files Affected:
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
|
|
@llvm/pr-subscribers-mlgo Author: S. VenkataKeerthy (svkeerthy) ChangesFull diff: https://github.com/llvm/llvm-project/pull/155516.diff 1 Files Affected:
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
|
mtrofin
reviewed
Aug 27, 2025
mtrofin
approved these changes
Aug 27, 2025
4734c24 to
987d846
Compare
267e2da to
7037453
Compare
987d846 to
0d75afa
Compare
7037453 to
9b851b9
Compare
0d75afa to
9a18f1c
Compare
9b851b9 to
fe1463e
Compare
9a18f1c to
7ddfeaa
Compare
fe1463e to
d70182f
Compare
c809d9d to
18675c6
Compare
d70182f to
01b9019
Compare
boomanaiden154
approved these changes
Aug 28, 2025
01b9019 to
2fd070b
Compare
18675c6 to
374bfa9
Compare
374bfa9 to
97560b9
Compare
2dd49e7 to
a73389b
Compare
97560b9 to
a20fb0e
Compare
a73389b to
3c6e312
Compare
a20fb0e to
b21b641
Compare
e727d58 to
cb881b6
Compare
Base automatically changed from
users/svkeerthy/08-25-canonicalized_type
to
main
August 29, 2025 21:56
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.