diff options
| author | Mingming Liu <mingmingl@google.com> | 2025-09-10 15:25:31 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-09-10 15:25:31 -0700 |
| commit | 1417dafa1db9cb1b2b09438aa9f53ea5ab6e36e2 (patch) | |
| tree | 57f4b1f313c8cf74eed8819870f39c36ea263c68 /llvm/docs/CommandGuide/llvm-ir2vec.rst | |
| parent | 898b813bc8a6d0276bf0f4769f5f2f64b34e632d (diff) | |
| parent | b8cefcb601ddaa18482555c4ff363c01a270c2fe (diff) | |
Merge branch 'main' into users/mingmingl-llvm/samplefdo-profile-formatusers/mingmingl-llvm/samplefdo-profile-format
Diffstat (limited to 'llvm/docs/CommandGuide/llvm-ir2vec.rst')
| -rw-r--r-- | llvm/docs/CommandGuide/llvm-ir2vec.rst | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/llvm/docs/CommandGuide/llvm-ir2vec.rst b/llvm/docs/CommandGuide/llvm-ir2vec.rst index 0c9fb6e94b6f..fc590a618031 100644 --- a/llvm/docs/CommandGuide/llvm-ir2vec.rst +++ b/llvm/docs/CommandGuide/llvm-ir2vec.rst @@ -13,7 +13,9 @@ DESCRIPTION :program:`llvm-ir2vec` is a standalone command-line tool for IR2Vec. It generates IR2Vec embeddings for LLVM IR and supports triplet generation -for vocabulary training. The tool provides three main subcommands: +for vocabulary training. + +The tool provides three main subcommands: 1. **triplets**: Generates numeric triplets in train2id format for vocabulary training from LLVM IR. @@ -93,7 +95,7 @@ Example Usage: .. code-block:: bash - llvm-ir2vec embeddings --ir2vec-vocab-path=vocab.json --level=func input.bc -o embeddings.txt + llvm-ir2vec embeddings --ir2vec-vocab-path=vocab.json --ir2vec-kind=symbolic --level=func input.bc -o embeddings.txt OPTIONS ------- @@ -129,6 +131,16 @@ Subcommand-specific options: Process only the specified function instead of all functions in the module. +.. option:: --ir2vec-kind=<kind> + + Specify the kind of IR2Vec embeddings to generate. Valid values are: + + * ``symbolic`` - Generate symbolic embeddings (default) + * ``flow-aware`` - Generate flow-aware embeddings + + Flow-aware embeddings consider control flow relationships between instructions, + while symbolic embeddings focus on the symbolic representation of instructions. + .. option:: --ir2vec-vocab-path=<path> Specify the path to the vocabulary file (required for embedding generation). |