Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #89

Closed
wants to merge 1 commit into from
Closed

Update README.md #89

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,17 +202,17 @@ for (auto val : pgmVec)
```

## Using Python package (IR2Vec-Wheels)
- Initialization:
- ```initObj = ir2vec.initEmbedding("/path/to/file.ll", "fa", "p")```
- Input:
- .ll/.bc file for which embeddings are needed
- `fa` -> Flow-Aware Encoddings; `sym` -> Symbolic Encodings
- `p` -> program level; `f` -> function level
- Output:
- A dictionary containing:
- `Instruction_Dict`: Key: Instruction[String]; Value : Embedding Vector
- `Function_Dict`: Key: Function name[String]; Value : Embedding Vector
- `Program_List`: Program/Module Name[String]; Embedding Vector
- `Message`: [String] Appropriate debug message.
- `Status`: [Bool] True if everything went fine else False
- Use the following functions:
- `Program Vector`: ```progVector1 = ir2vec.getProgramVector(initObj)``` or ```progVector2 = initObj.getProgramVector()```
- `Function Vector`: ```functionVectorMap1 = ir2vec.getFunctionVectors(initObj)``` or ```functionVectorMap2 = initObj.getFunctionVectors()```
- `Instruction Vectors`: ```instructionVectorsList1 = ir2vec.getInstructionVectors(initObj)``` or ```instructionVectorsList2 = initObj.getInstructionVectors()```
- The following code snippet contains an example to demonstrate the usage of the package.

```python
Expand Down
Loading